JDETECTOR::JDetectorVersion Struct Reference

Detector version. More...

#include <JDetectorVersion.hh>

Inheritance diagram for JDETECTOR::JDetectorVersion:

Public Types
enum	JVersion_t {   V1 = 1 , V2 = 2 , V3 = 3 , V4 = 4 ,   V5 = 5 }
	Enumeration of version types. More...

Public Member Functions
	JDetectorVersion ()
	Default constructor.
	JDetectorVersion (const JVersion &version)
	Constructor.
bool	hasVersion () const
	Check validity of version.
const std::string &	getVersion () const
	Get version.
void	setVersion (const std::string &version)
	Set version.
bool	less (const JVersion &version) const
	Less-than method.

Protected Attributes
std::string	version

Friends
std::istream &	operator>> (std::istream &in, JDetectorVersion &version)
	Read version from input.
std::ostream &	operator<< (std::ostream &out, const JDetectorVersion &version)
	Write version to output.
JReader &	operator>> (JReader &in, JDetectorVersion &version)
	Read version from input.
JWriter &	operator<< (JWriter &out, const JDetectorVersion &version)
	Write version to output.

Detailed Description

Detector version.

Definition at line 41 of file JDetectorVersion.hh.

Member Enumeration Documentation

JVersion_t

enum JDETECTOR::JDetectorVersion::JVersion_t

Enumeration of version types.

Note that additional version types should be included in JGetDetectorVersion::JGetDetectorVersion.

Enumerator
V1	First version.
V2	Version with UTC time and UTM position data.
V3	Version with PMT status field and comments.
V4	Version with quaternion and time offset per module.
V5	Version with module status field.

Definition at line 48 of file JDetectorVersion.hh.

                    {
      V1 = 1,        //!< First version
      V2 = 2,        //!< Version with UTC time and UTM position data
      V3 = 3,        //!< Version with PMT status field and comments
      V4 = 4,        //!< Version with quaternion and time offset per module
      V5 = 5         //!< Version with module status field
    };

Constructor & Destructor Documentation

JDetectorVersion() [1/2]

JDETECTOR::JDetectorVersion::JDetectorVersion ( )

inline

Default constructor.

Definition at line 60 of file JDetectorVersion.hh.

                       :
      JVersion()
    {}

JDetectorVersion() [2/2]

JDETECTOR::JDetectorVersion::JDetectorVersion ( const JVersion & version )

inline

Constructor.

Parameters

version

version

Definition at line 70 of file JDetectorVersion.hh.

                                              :
      JVersion(version)
    {}

Member Function Documentation

hasVersion()

bool JDETECTOR::JDetectorVersion::hasVersion ( ) const

inline

Check validity of version.

Returns

true if valid; else false

Definition at line 80 of file JDetectorVersion.hh.

    {
      return (!this->version.empty() && (this->version[0] == 'v' ||  this->version[0] == 'V'));
    }

getVersion()

const std::string & JDETECTOR::JVersion::getVersion ( ) const

inlineinherited

Get version.

Returns

version

Definition at line 50 of file JDetector/JVersion.hh.

    { 
      return this->version;
    }

setVersion()

void JDETECTOR::JVersion::setVersion ( const std::string & version )

inlineinherited

Set version.

Parameters

version

version

Definition at line 61 of file JDetector/JVersion.hh.

    { 
      this->version = version;
    }

less()

bool JDETECTOR::JVersion::less ( const JVersion & version ) const

inlineinherited

Less-than method.

Parameters

version

version

Returns

true if this version less than given version; else false

Definition at line 73 of file JDetector/JVersion.hh.

    {
      return this->getVersion() < version.getVersion();
    }

Friends And Related Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JDetectorVersion & version )

friend

Read version from input.

Parameters

in	input stream
version	version

Returns

input stream

Definition at line 93 of file JDetectorVersion.hh.

    {
      return in >> version.version;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JDetectorVersion & version )

friend

Write version to output.

Parameters

out	output stream
version	version

Returns

output stream

Definition at line 106 of file JDetectorVersion.hh.

    {
      return out << version.version;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JDetectorVersion & version )

friend

Read version from input.

Parameters

in	reader
version	version

Returns

reader

Definition at line 119 of file JDetectorVersion.hh.

    {
      return in >> version.version;
    }

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JDetectorVersion & version )

friend

Write version to output.

Parameters

out	writer
version	version

Returns

writer

Definition at line 132 of file JDetectorVersion.hh.

    {
      return out << version.version;
    }

Member Data Documentation

version

std::string JDETECTOR::JVersion::version

protectedinherited

Definition at line 79 of file JDetector/JVersion.hh.

---

The documentation for this struct was generated from the following file:

• JDetectorVersion.hh