ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
FrameCPP::Version_8::FrDetector Class Reference

Detector data. More...

#include <FrDetector.hh>

Inheritance diagram for FrameCPP::Version_8::FrDetector:
FrameCPP::Version_8::ObjectWithChecksum< Common::FrDetector > FrameCPP::Common::TOCInfo FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type > FrameCPP::Common::FrDetector FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef
Common::SearchContainer
< FrVect,&FrVect::GetName
aux_type
 
typedef aux_type::iterator aux_iterator
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef
Common::SearchContainer
< FrTable,&FrTable::GetNameSlow
table_type
 
typedef table_type::iterator table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
typedef FR_DETECTOR_LONGITUDE_TYPE longitude_type
 
typedef FR_DETECTOR_LATITUDE_TYPE latitude_type
 
typedef FR_DETECTOR_ELEVATION_TYPE elevation_type
 
typedef
FR_DETECTOR_ARM_X_AZIMUTH_TYPE 
armXazimuth_type
 
typedef
FR_DETECTOR_ARM_Y_AZIMUTH_TYPE 
armYazimuth_type
 
typedef
FR_DETECTOR_ARM_X_ALTITUDE_TYPE 
armXaltitude_type
 
typedef
FR_DETECTOR_ARM_Y_ALTITUDE_TYPE 
armYaltitude_type
 
typedef
FR_DETECTOR_ARM_X_MIDPOINT_TYPE 
armXmidpoint_type
 
typedef
FR_DETECTOR_ARM_Y_MIDPOINT_TYPE 
armYmidpoint_type
 
typedef FR_DETECTOR_LOCAL_TIME_TYPE localTime_type
 
typedef ObjectWithChecksum
< Common::FrDetector,
checksum_type
self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
enum  {
  DT_CHAR_PTR, DT_STRING_2, DT_INT_2S, DT_INT_2U,
  DT_INT_4S, DT_INT_4U, DT_INT_8S, DT_INT_8U,
  DT_REAL_4, DT_REAL_8
}
 
enum  {
  IC_EOQ, IC_AMPLITUDE, IC_CHANNEL_ID, IC_DATA_QUALITY,
  IC_DATA_VALID, IC_DETECTOR, IC_DETECTOR_PREFIX, IC_DT,
  IC_END, IC_FRAME, IC_GROUP_ID, IC_GTIME_N,
  IC_GTIME_S, IC_ID, IC_LOCAL_TIME, IC_NAME,
  IC_RUN, IC_START, IC_ULEAP_S, IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 

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_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const table_typeRefTable () const
 Identifier for user-provided information in table format. More...
 
table_typeRefTable ()
 Identifier for user-provided information in table format. More...
 
FrDetectorMerge (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_typeCreate (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_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectClone () 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::DescriptionStructDescription ()
 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 = FrameSpec::Info::FSI_FR_DETECTOR
 

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 FrDetectorpCreate (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...
 

Detailed Description

Detector data.

Member Typedef Documentation

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

Member Enumeration Documentation

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 
anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

Constructor & Destructor Documentation

FrameCPP::Version_8::FrDetector::FrDetector ( )

Default constructor.

Returns
A new instance of an FrDetector object
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.

Parameters
[in]NameInstrument name
[in]PrefixChannel prefix for this detector
[in]LongitudeDetector vertex longitude
[in]LatitudeDetector vertex latitutde.
[in]ElevationVertex elevation.
[in]ArmXazimuthOrientation of X arm.
[in]ArmYazimuthOrientation of Y arm.
[in]ArmXaltitudeAltidue angle of X arm.
[in]ArmYaltitudeAltidue angle of Y arm.
[in]ArmXmidpointDistance between the detector vertex and the middle of the X cavity.
[in]ArmYmidpointDistance between the detector vertex and the middle of the Y cavity.
[in]LocalTimeLocal seasonal time.
Returns
A new instance of an FrDetector object
FrameCPP::Version_8::FrDetector::FrDetector ( const FrDetector detector)

Copy constructor.

Parameters
[in]detectorThe source instance to copy
Returns
A new instance of an FrDetector object
FrameCPP::Version_8::FrDetector::FrDetector ( Previous::FrDetector &  Source,
istream_type Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrDetector structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrDetector structure was read.
Returns
A new instance of an FrDetector object

Member Function Documentation

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector , checksum_type >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector , checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector , checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited
template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited
FrDetector::demote_ret_type FrameCPP::Version_8::FrDetector::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.
FrDetector::armXaltitude_type FrameCPP::Version_8::FrDetector::GetArmXaltitude ( ) const
inline

Retrieve the altitude angle of X arm of the detector.

Returns
The altitude angle of the X arm of the detector.
FrDetector::armXazimuth_type FrameCPP::Version_8::FrDetector::GetArmXazimuth ( ) const
inline

Retrieve the orientation of X arm of the detector.

Returns
The orientation of the X arm of the detector.
FrDetector::armXmidpoint_type FrameCPP::Version_8::FrDetector::GetArmXmidpoint ( ) const
inline

Retrieve the midpoint of the X arm of the detector.

Returns
The midpoint of the X arm of the detector.
FrDetector::armYaltitude_type FrameCPP::Version_8::FrDetector::GetArmYaltitude ( ) const
inline

Retrieve the altitude angle of Y arm of the detector.

Returns
The altitude angle of the Y arm of the detector.
FrDetector::armYazimuth_type FrameCPP::Version_8::FrDetector::GetArmYazimuth ( ) const
inline

Retrieve the orientation of Y arm of the detector.

Returns
The orientation of the Y arm of the detector.
FrDetector::armYmidpoint_type FrameCPP::Version_8::FrDetector::GetArmYmidpoint ( ) const
inline

Retrieve the midpoint of the Y arm of the detector.

Returns
The midpoint of the Y arm of the detector.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrDetector::elevation_type FrameCPP::Version_8::FrDetector::GetElevation ( ) const
inline

Retrieve the vertex elevation of the detector.

Returns
The vertex elevation of the detector.
FrDetector::latitude_type FrameCPP::Version_8::FrDetector::GetLatitude ( ) const
inline

Retrieve the latitude of the detector vertex.

Returns
The latitude of the detector vertex.
FrDetector::localTime_type FrameCPP::Version_8::FrDetector::GetLocalTime ( ) const
inline

Retrieve the local seasonal time.

Returns
The local seasonal time.
FrDetector::longitude_type FrameCPP::Version_8::FrDetector::GetLongitude ( ) const
inline

Retrieve the longitude of the detector vertex.

Returns
The longitude of the detector vertex.
const std::string & FrameCPP::Version_8::FrDetector::GetName ( ) const

Retrieve the name of the instrument.

Returns
The name of the instrument.
const CHAR * FrameCPP::Version_8::FrDetector::GetPrefix ( ) const
inline

Retrieve the prefix of the instrument.

Returns
The prefix for the instrument.
FrDetector & FrameCPP::Version_8::FrDetector::Merge ( const FrDetector RHS)

Merge with another FrDetector.

Parameters
[in]RHSThe source of the information to append to this FrDetector structure.
Returns
A reference to this object
const char * FrameCPP::Version_8::FrDetector::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

bool FrameCPP::Version_8::FrDetector::operator== ( const FrDetector RHS) const
inline

equality operator

Parameters
[in]RHSThe FrDetector object to be compared.
Returns
The value true is returned if the object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrDetector::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrDetector::pBytes ( const Common::StreamBase Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.

FrDetector * FrameCPP::Version_8::FrDetector::pCreate ( istream_type Stream) const
protectedvirtual
FrDetector::promote_ret_type FrameCPP::Version_8::FrDetector::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj
FrDetector::promote_ret_type FrameCPP::Version_8::FrDetector::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.
template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited
void FrameCPP::Version_8::FrDetector::pWrite ( ostream_type Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >.

const FrDetector::aux_type & FrameCPP::Version_8::FrDetector::RefAux ( ) const
inline

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.
FrDetector::aux_type & FrameCPP::Version_8::FrDetector::RefAux ( )
inline

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.
const FrDetector::table_type & FrameCPP::Version_8::FrDetector::RefTable ( ) const
inline

Identifier for user-provided information in table format.

Returns
A constant reference to the user-provided table information.
FrDetector::table_type & FrameCPP::Version_8::FrDetector::RefTable ( )
inline

Identifier for user-provided information in table format.

Returns
A reference to the user-provided table information.
const Description * FrameCPP::Version_8::FrDetector::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.
const char * FrameCPP::Version_8::FrDetector::StructName ( )
inlinestatic

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.
void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
void FrameCPP::Version_8::FrDetector::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector , checksum_type >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

const FrameSpec::Info::frame_object_types FrameCPP::Common::FrDetector::STRUCT_ID = FrameSpec::Info::FSI_FR_DETECTOR
staticinherited

The documentation for this class was generated from the following files: