Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Detector

This class represents a detector.
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/detector.hh"


public function member index:

Detector(); Default Constructor.
Detector(const Detector& detector);
Detector(const std::string& name, REAL_8 longitude, REAL_8 latitude, REAL_4 elevation, REAL_4 armXazimuth, REAL_4 armYazimuth, REAL_4 armXaltitude, REAL_4 armYaltitude, REAL_4 armXmidpoint, REAL_4 armYmidpoint, INT_4S localTime, INT_4U dataQuality, const std::string& qaBitList); Constructor.
virtual ~Detector();
StatData* findStatData(INT_4U time); Find StatData corresponding to a particular time.
const StatData* findStatData(INT_4U time) const; Find StatData corresponding to a particular time.
inline REAL_4 getArmXAltitude() const; Gets the altitude angle of the X arm.
inline REAL_4 getArmXAzimuth() const; Gets the orientation of the X arm.
inline REAL_4 getArmXMidpoint() const; Gets the midpoint of the X cavity.
inline REAL_4 getArmYAltitude() const; Gets the altitude angle of the Y arm.
inline REAL_4 getArmYAzimuth() const; Gets the orientation of the Y arm.
inline REAL_4 getArmYMidpoint() const; Gets the midpoint of the Y cavity.
virtual INT_2U getClassId() const;
inline INT_4U getDataQuality() const; Gets data quality word.
inline REAL_4 getElevation() const; Gets the vertex elevation in meters.
inline REAL_8 getLatitude() const; Gets the instrument's latitude.
inline INT_4S getLocalTime() const; Gets local time offset.
inline REAL_8 getLongitude() const; Gets the instrument's longitude.
const std::string& getName() const;
inline const std::string& getQaBitList() const; Gets the data quality word bit definition list.
static SH getSH(); Constructs the Structure Header for this class.
static SH getSH3(); Constructs frame data format version 3 Structure Header for this class.
static SH getSH4(); Constructs frame data format version 4 Structure Header for this class.
inline bool operator !=(const Detector& detector) const; Not-equal comparison.
const Detector& operator +=(const Detector& detector); += Operator.
const Detector& operator =(const Detector& detector); Assignment Operator.
bool operator ==(const Detector& detector) const; Equal comparison.
inline MoreContainer& refMore(); Gets the container for user-defined data.
inline const MoreContainer& refMore() const; Gets the container for user-defined data.
inline MoreTableContainer& refMoreTable(); Gets the container for user-defined table data.
inline const MoreTableContainer& refMoreTable() const; Gets the container for user-defined table data.
inline StatDataContainer& refStatData(); Gets the container for StatData.
inline const StatDataContainer& refStatData() const; Gets the container for StatData.
 

private function member index:

static Detector* read(FrameReaderBase& in); Reads an Detector object from an FrameReaderBase object.
static Detector* read3(FrameReaderBase& in); Version 3 frame input method.
static Detector* read4(FrameReaderBase& in); Version 4 frame input method.
virtual void write(Output& out) const; Writes an Detector object to an Output object.
 

Description:

It is modeled after the FrDetector structure in the Frame Specification, LIGO-T970130-B-E.


Function Member Descriptions:


FrameCPP::Version_3_4_5::Detector::Detector - Default Constructor.


Detector();
This creates an Detector object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Detector::Detector


Detector(const Detector& detector);
Copy Constructor. This performs a deep copy of the object.

Parameters:
ParameterDescription
const Detector& detectorDetector to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Detector::Detector - Constructor.


Detector(const std::string& name, REAL_8 longitude, REAL_8 latitude, REAL_4 elevation, REAL_4 armXazimuth, REAL_4 armYazimuth, REAL_4 armXaltitude, REAL_4 armYaltitude, REAL_4 armXmidpoint, REAL_4 armYmidpoint, INT_4S localTime, INT_4U dataQuality, const std::string& qaBitList);
This creates a Detector object with the specified attributes.

Parameters:
ParameterDescription
const std::string& nameInstrument name
REAL_8 longitudeInstrument Longitude
REAL_8 latitudeInstrument Latitude
REAL_4 elevationVertex elevation
REAL_4 armXazimuthOrientation of X arm, degrees CCW from East.
REAL_4 armYazimuthOrientation of Y arm, degrees CCW from East.
REAL_4 armXaltitudeOrientation of X arm, degrees above horizon.
REAL_4 armYaltutudeOrientation of Y arm, degrees above horizon.
REAL_4 armXmidpointMidpoint of X cavity.
REAL_4 armYmidpointMidpoint of Y cavity.
INT_4S localTimeLocal seasonal time minus UTC (seconds)
INT_4U dataQualityData quality word.
std::string& qaBitListData quality bit definition list.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Detector::~Detector


virtual ~Detector();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Detector::findStatData - Find StatData corresponding to a particular time.


StatData* findStatData(INT_4U time);

Parameters:
ParameterDescription
INT_4U timeTime for which to look.

Return value:
StatData*- Found data.

Exceptions:
ExceptionDescription
not_found_errorData not found.



FrameCPP::Version_3_4_5::Detector::findStatData - Find StatData corresponding to a particular time.


const StatData* findStatData(INT_4U time) const;

Parameters:
ParameterDescription
INT_4U timeTime for which to look.

Return value:
const StatData*- Found data.

Exceptions:
ExceptionDescription
not_found_errorData not found.



FrameCPP::Version_3_4_5::Detector::getArmXAltitude - Gets the altitude angle of the X arm.


inline REAL_4 getArmXAltitude() const;
This is in degrees above horizon.

Return value:
REAL_4- Arm X altitude angle.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getArmXAzimuth - Gets the orientation of the X arm.


inline REAL_4 getArmXAzimuth() const;
This is in degrees CCW from east.

Return value:
REAL_4- Arm X orientation.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getArmXMidpoint - Gets the midpoint of the X cavity.


inline REAL_4 getArmXMidpoint() const;
Distance between the detector vertex and the middle of the X cavity with respect to the detector vertex (meters) (should be zero fo bars).

Return value:
REAL_4- distance in meters.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getArmYAltitude - Gets the altitude angle of the Y arm.


inline REAL_4 getArmYAltitude() const;
This is in degrees above horizon.

Return value:
REAL_4- Arm Y altitude angle.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getArmYAzimuth - Gets the orientation of the Y arm.


inline REAL_4 getArmYAzimuth() const;
This is in degrees CCW from east.

Return value:
REAL_4- Arm Y orientation.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getArmYMidpoint - Gets the midpoint of the Y cavity.


inline REAL_4 getArmYMidpoint() const;
Distance between the detector vertex and the middle of the Y cavity with respect to the detector vertex (meters) (should be zero fo bars).

Return value:
REAL_4- distance in meters.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Detector::getDataQuality - Gets data quality word.


inline INT_4U getDataQuality() const;
A logical 32-bit word to denote top level quality of data.

Return value:
INT_4U- data quality word.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getElevation - Gets the vertex elevation in meters.


inline REAL_4 getElevation() const;
This is relative to the WGS84 ellipsoid.

Return value:
REAL_4- Elevation.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getLatitude - Gets the instrument's latitude.


inline REAL_8 getLatitude() const;

Return value:
REAL_8- Detector vertex latitude.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getLocalTime - Gets local time offset.


inline INT_4S getLocalTime() const;
Returns a difference between local seazonal time and UTC.

Return value:
INT_4S- local time (seconds)

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getLongitude - Gets the instrument's longitude.


inline REAL_8 getLongitude() const;

Return value:
REAL_8- Detector vertex longitude.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::Detector::getQaBitList - Gets the data quality word bit definition list.


inline const std::string& getQaBitList() const;

Return value:
const std::string&- bit description.


FrameCPP::Version_3_4_5::Detector::getSH - Constructs the Structure Header for this class.


static SH getSH();

Return value:
SH- Detector structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Detector::getSH3 - Constructs frame data format version 3 Structure Header for this class.


static SH getSH3();

Return value:
SH- Structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Detector::getSH4 - Constructs frame data format version 4 Structure Header for this class.


static SH getSH4();

Return value:
SH- Structure header.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Detector::operator != - Not-equal comparison.


inline bool operator !=(const Detector& detector) const;

Parameters:
ParameterDescription
const Detector& detectorThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Detector::operator += - += Operator.


const Detector& operator +=(const Detector& detector);

Parameters:
ParameterDescription
const Detector& detectorDetector to be assigned.

Return value:
const Detector&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Detector::operator = - Assignment Operator.


const Detector& operator =(const Detector& detector);

Parameters:
ParameterDescription
const Detector& detectorDetector to be assigned.

Return value:
const Detector&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Detector::operator == - Equal comparison.


bool operator ==(const Detector& detector) const;
Determines whether two Detector objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const Detector& detectorThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Detector::read - Reads an Detector object from an FrameReaderBase object.


static Detector* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
FrameReaderBase& inInput data stream object.

Return value:
Detector*- Newly allocated.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure.



FrameCPP::Version_3_4_5::Detector::read3 - Version 3 frame input method.


static Detector* read3(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure.



FrameCPP::Version_3_4_5::Detector::read4 - Version 4 frame input method.


static Detector* read4(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure.



FrameCPP::Version_3_4_5::Detector::refMore - Gets the container for user-defined data.


inline MoreContainer& refMore();

Return value:
MoreContainer&- User data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::refMore - Gets the container for user-defined data.


inline const MoreContainer& refMore() const;

Return value:
const MoreContainer&- User data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::refMoreTable - Gets the container for user-defined table data.


inline MoreTableContainer& refMoreTable();

Return value:
MoreTableContainer&- Table data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::refMoreTable - Gets the container for user-defined table data.


inline const MoreTableContainer& refMoreTable() const;

Return value:
const MoreTableContainer&- Table data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::refStatData - Gets the container for StatData.


inline StatDataContainer& refStatData();

Return value:
StatDataContainer&- Static data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::refStatData - Gets the container for StatData.


inline const StatDataContainer& refStatData() const;

Return value:
const StatDataContainer&- Static data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Detector::write - Writes an Detector object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Detector::mArmXAltitude - Pitch angle of X arm.

REAL_4 mArmXAltitude;

FrameCPP::Version_3_4_5::Detector::mArmXAzimuth - Orientation of X arm, degrees CCW from East.

REAL_4 mArmXAzimuth;

FrameCPP::Version_3_4_5::Detector::mArmXMidpoint - Midpoint of X cavity

REAL_4 mArmXMidpoint;

FrameCPP::Version_3_4_5::Detector::mArmYAltitude - Pitch angle of Y arm.

REAL_4 mArmYAltitude;

FrameCPP::Version_3_4_5::Detector::mArmYAzimuth - Orientation of Y arm, degrees CCW from East.

REAL_4 mArmYAzimuth;

FrameCPP::Version_3_4_5::Detector::mArmYMidpoint - Midpoint of Y cavity

REAL_4 mArmYMidpoint;

FrameCPP::Version_3_4_5::Detector::mDataQuality - Top level quality of data

INT_4U mDataQuality;

FrameCPP::Version_3_4_5::Detector::mElevation - Vertex elevation.

REAL_4 mElevation;

FrameCPP::Version_3_4_5::Detector::mLatitude - Instrument Latitude

REAL_8 mLatitude;

FrameCPP::Version_3_4_5::Detector::mLocalTime - Local timezone offset from UTC (local seazonal time minus UTC), seconds

INT_4S mLocalTime;

FrameCPP::Version_3_4_5::Detector::mLongitude - Instrument Longitude

REAL_8 mLongitude;

FrameCPP::Version_3_4_5::Detector::mMore - User data.

MoreContainer mMore;

FrameCPP::Version_3_4_5::Detector::mMoreTable - User table data.

MoreTableContainer mMoreTable;

FrameCPP::Version_3_4_5::Detector::mName - Instrument name.

std::string mName;

FrameCPP::Version_3_4_5::Detector::mQaBitList - Data quality bit definitions

std::string mQaBitList;

FrameCPP::Version_3_4_5::Detector::mStatData - Static data.

StatDataContainer mStatData;