Class Index | Cross Index | Namespace Index |
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. |
This creates an Detector object with the following properties:
- name = "none"
- location is 0 degrees longitude, 0 degrees latitude
- elevation = 0 meters
- armXazimuth = 0
- armYazimuth = 90.
Exceptions:
Exception | Description |
None. |
Copy Constructor. This performs a deep copy of the object.
Parameters:
Parameter | Description |
const Detector& detector | Detector to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This creates a Detector object with the specified attributes.
Parameters:
Parameter | Description |
const std::string& name | Instrument name |
REAL_8 longitude | Instrument Longitude |
REAL_8 latitude | Instrument Latitude |
REAL_4 elevation | Vertex elevation |
REAL_4 armXazimuth | Orientation of X arm, degrees CCW from East. |
REAL_4 armYazimuth | Orientation of Y arm, degrees CCW from East. |
REAL_4 armXaltitude | Orientation of X arm, degrees above horizon. |
REAL_4 armYaltutude | Orientation of Y arm, degrees above horizon. |
REAL_4 armXmidpoint | Midpoint of X cavity. |
REAL_4 armYmidpoint | Midpoint of Y cavity. |
INT_4S localTime | Local seasonal time minus UTC (seconds) |
INT_4U dataQuality | Data quality word. |
std::string& qaBitList | Data quality bit definition list. |
Exceptions:
Exception | Description |
None. |
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
INT_4U time | Time for which to look. |
Return value:
StatData*- Found data.
Exceptions:
Exception | Description |
not_found_error | Data not found. |
Parameters:
Parameter | Description |
INT_4U time | Time for which to look. |
Return value:
const StatData*- Found data.
Exceptions:
Exception | Description |
not_found_error | Data not found. |
This is in degrees above horizon.
Return value:
REAL_4- Arm X altitude angle.
Exceptions:
Exception | Description |
None. | |
None. |
This is in degrees CCW from east.
Return value:
REAL_4- Arm X orientation.
Exceptions:
Exception | Description |
None. | |
None. |
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:
Exception | Description |
None. | |
None. |
This is in degrees above horizon.
Return value:
REAL_4- Arm Y altitude angle.
Exceptions:
Exception | Description |
None. | |
None. |
This is in degrees CCW from east.
Return value:
REAL_4- Arm Y orientation.
Exceptions:
Exception | Description |
None. | |
None. |
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:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
A logical 32-bit word to denote top level quality of data.
Return value:
INT_4U- data quality word.
Exceptions:
Exception | Description |
None. | |
None. |
This is relative to the WGS84 ellipsoid.
Return value:
REAL_4- Elevation.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
REAL_8- Detector vertex latitude.
Exceptions:
Exception | Description |
None. | |
None. |
Returns a difference between local seazonal time and UTC.
Return value:
INT_4S- local time (seconds)
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
REAL_8- Detector vertex longitude.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const std::string&- bit description.
Return value:
SH- Detector structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
SH- Structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
SH- Structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const Detector& detector | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Detector& detector | Detector to be assigned. |
Return value:
const Detector&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const Detector& detector | Detector to be assigned. |
Return value:
const Detector&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two Detector objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const Detector& detector | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
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:
Parameter | Description |
FrameReaderBase& in | Input data stream object. |
Return value:
Detector*- Newly allocated.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure. |
Return value:
MoreContainer&- User data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const MoreContainer&- User data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
MoreTableContainer&- Table data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const MoreTableContainer&- Table data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
StatDataContainer&- Static data.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
const StatDataContainer&- Static data.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
Output& out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |