ldas-tools-framecpp
2.6.4
|
Detector data. More...
#include <FrDetector.hh>
Public Member Functions | |
FrDetector () | |
Default constructor. More... | |
FrDetector (const std::string &Name, const char *Prefix, const longitude_type Longitude, const latitude_type Latitude, const elevation_type Elevation, const armXazimuth_type ArmXazimuth, const armYazimuth_type ArmYazimuth, const armXaltitude_type ArmXaltitude, const armYaltitude_type ArmYaltitude, const armXmidpoint_type ArmXmidpoint, const armYmidpoint_type ArmYmidpoint, const localTime_type LocalTime) | |
Constructor. More... | |
FrDetector (const FrDetector &detector) | |
Copy constructor. More... | |
FrDetector (Previous::FrDetector &Source, istream_type *Stream) | |
Promotion Constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const std::string & | GetName () const |
Retrieve the name of the instrument. More... | |
const CHAR * | GetPrefix () const |
Retrieve the prefix of the instrument. More... | |
longitude_type | GetLongitude () const |
Retrieve the longitude of the detector vertex. More... | |
latitude_type | GetLatitude () const |
Retrieve the latitude of the detector vertex. More... | |
elevation_type | GetElevation () const |
Retrieve the vertex elevation of the detector. More... | |
armXazimuth_type | GetArmXazimuth () const |
Retrieve the orientation of X arm of the detector. More... | |
armYazimuth_type | GetArmYazimuth () const |
Retrieve the orientation of Y arm of the detector. More... | |
armXaltitude_type | GetArmXaltitude () const |
Retrieve the altitude angle of X arm of the detector. More... | |
armYaltitude_type | GetArmYaltitude () const |
Retrieve the altitude angle of Y arm of the detector. More... | |
armXmidpoint_type | GetArmXmidpoint () const |
Retrieve the midpoint of the X arm of the detector. More... | |
armYmidpoint_type | GetArmYmidpoint () const |
Retrieve the midpoint of the Y arm of the detector. More... | |
localTime_type | GetLocalTime () const |
Retrieve the local seasonal time. More... | |
const aux_type & | RefAux () const |
Identifier for vector for user-provided information. More... | |
aux_type & | RefAux () |
Identifier for vector for user-provided information. More... | |
const table_type & | RefTable () const |
Identifier for user-provided information in table format. More... | |
table_type & | RefTable () |
Identifier for user-provided information in table format. More... | |
FrDetector & | Merge (const FrDetector &RHS) |
Merge with another FrDetector. More... | |
bool | operator== (const FrDetector &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
template<typename PreviousType , typename CurrentType > | |
FrameSpec::ObjectInterface::promote_ret_type | PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. More... | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
Static Public Attributes | |
static const FrameSpec::Info::frame_object_types | STRUCT_ID |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrDetector * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
Detector data.
typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrDetector::aux_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrDetector::table_type |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_8::FrDetector::FrDetector | ( | ) |
Default constructor.
FrameCPP::Version_8::FrDetector::FrDetector | ( | const std::string & | Name, |
const char * | Prefix, | ||
const longitude_type | Longitude, | ||
const latitude_type | Latitude, | ||
const elevation_type | Elevation, | ||
const armXazimuth_type | ArmXazimuth, | ||
const armYazimuth_type | ArmYazimuth, | ||
const armXaltitude_type | ArmXaltitude, | ||
const armYaltitude_type | ArmYaltitude, | ||
const armXmidpoint_type | ArmXmidpoint, | ||
const armYmidpoint_type | ArmYmidpoint, | ||
const localTime_type | LocalTime | ||
) |
Constructor.
[in] | Name | Instrument name |
[in] | Prefix | Channel prefix for this detector |
[in] | Longitude | Detector vertex longitude |
[in] | Latitude | Detector vertex latitutde. |
[in] | Elevation | Vertex elevation. |
[in] | ArmXazimuth | Orientation of X arm. |
[in] | ArmYazimuth | Orientation of Y arm. |
[in] | ArmXaltitude | Altidue angle of X arm. |
[in] | ArmYaltitude | Altidue angle of Y arm. |
[in] | ArmXmidpoint | Distance between the detector vertex and the middle of the X cavity. |
[in] | ArmYmidpoint | Distance between the detector vertex and the middle of the Y cavity. |
[in] | LocalTime | Local seasonal time. |
FrameCPP::Version_8::FrDetector::FrDetector | ( | const FrDetector & | detector | ) |
Copy constructor.
[in] | detector | The source instance to copy |
FrameCPP::Version_8::FrDetector::FrDetector | ( | Previous::FrDetector & | Source, |
istream_type * | Stream | ||
) |
Promotion Constructor.
[in] | Source | An FrDetector structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrDetector structure was read. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHeader.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
|
staticinherited |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inline |
Retrieve the altitude angle of X arm of the detector.
|
inline |
Retrieve the orientation of X arm of the detector.
|
inline |
Retrieve the midpoint of the X arm of the detector.
|
inline |
Retrieve the altitude angle of Y arm of the detector.
|
inline |
Retrieve the orientation of Y arm of the detector.
|
inline |
Retrieve the midpoint of the Y arm of the detector.
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
Retrieve the vertex elevation of the detector.
|
inline |
Retrieve the latitude of the detector vertex.
|
inline |
Retrieve the local seasonal time.
|
inline |
Retrieve the longitude of the detector vertex.
const std::string & FrameCPP::Version_8::FrDetector::GetName | ( | ) | const |
Retrieve the name of the instrument.
|
inline |
Retrieve the prefix of the instrument.
FrDetector & FrameCPP::Version_8::FrDetector::Merge | ( | const FrDetector & | RHS | ) |
Merge with another FrDetector.
[in] | RHS | The source of the information to append to this FrDetector structure. |
|
virtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
equality operator
[in] | RHS | The FrDetector object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.
|
protectedvirtual |
Virtual constructor.
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.
|
inlinestatic |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
inherited |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.
|
inline |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector for user-provided information.
|
inline |
Identifier for user-provided information in table format.
|
inline |
Identifier for user-provided information in table format.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
inlineinherited |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
staticinherited |