ldas-tools-framecpp  2.7.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_3::FrDetector Class Reference

#include <FrDetector.hh>

Inheritance diagram for FrameCPP::Version_3::FrDetector:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_3::FrDetector:
Collaboration graph
[legend]

Classes

struct  fr_detector_data_type
 

Public Types

typedef Common::SearchContainer< FrVect, &FrVect::GetNamemore_type
 
typedef more_type::iterator aux_iterator
 
typedef more_type::const_iterator const_aux_iterator
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamemore_type
 
typedef more_type::iterator aux_iterator
 
typedef more_type::const_iterator const_aux_iterator
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_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
}
 
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
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrDetector ()
 Default constructor. More...
 
 FrDetector (const std::string &Name, const INT_2S LongitudeD, const INT_2S LongitudeM, const REAL_4 LongitudeS, const INT_2S LatitudeD, const INT_2S LatitudeM, const REAL_4 LatitudeS, const REAL_4 Elevation, const REAL_4 ArmXazimuth, const REAL_4 ArmYazimuth, const REAL_4 ArmLength)
 
 FrDetector (const FrDetector &detector)
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrDetectorCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
const std::string & GetName () const
 
INT_2S GetLongitudeD () const
 
INT_2S GetLongitudeM () const
 
REAL_4 GetLongitudeS () const
 
INT_2S GetLatitudeD () const
 
INT_2S GetLatitudeM () const
 
REAL_4 GetLatitudeS () const
 
REAL_4 GetElevation () const
 
REAL_4 GetArmXazimuth () const
 
REAL_4 GetArmYazimuth () const
 
REAL_4 GetArmLength () const
 
const more_typeRefMore () const
 
more_typeRefMore ()
 
FrDetectorMerge (const FrDetector &RHS)
 Merge with another FrDetector. More...
 
bool operator== (const FrDetector &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrDetector ()
 Default constructor. More...
 
 FrDetector (const std::string &Name, const INT_2S LongitudeD, const INT_2S LongitudeM, const REAL_4 LongitudeS, const INT_2S LatitudeD, const INT_2S LatitudeM, const REAL_4 LatitudeS, const REAL_4 Elevation, const REAL_4 ArmXazimuth, const REAL_4 ArmYazimuth, const REAL_4 ArmLength)
 
 FrDetector (const FrDetector &detector)
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrDetectorCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
const std::string & GetName () const
 
INT_2S GetLongitudeD () const
 
INT_2S GetLongitudeM () const
 
REAL_4 GetLongitudeS () const
 
INT_2S GetLatitudeD () const
 
INT_2S GetLatitudeM () const
 
REAL_4 GetLatitudeS () const
 
REAL_4 GetElevation () const
 
REAL_4 GetArmXazimuth () const
 
REAL_4 GetArmYazimuth () const
 
REAL_4 GetArmLength () const
 
const more_typeRefMore () const
 
more_typeRefMore ()
 
FrDetectorMerge (const FrDetector &RHS)
 Merge with another FrDetector. More...
 
bool operator== (const FrDetector &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () 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...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor 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...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. 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...
 
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)
 
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
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Private Member Functions

 FrDetector (istream_type &Stream)
 
 FrDetector (istream_type &Stream)
 

Private Attributes

fr_detector_data_type m_data
 
const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Member Typedef Documentation

◆ aux_iterator [1/2]

typedef more_type::iterator FrameCPP::Version_3::FrDetector::aux_iterator

◆ aux_iterator [2/2]

typedef more_type::iterator FrameCPP::Version_3::FrDetector::aux_iterator

◆ const_aux_iterator [1/2]

typedef more_type::const_iterator FrameCPP::Version_3::FrDetector::const_aux_iterator

◆ const_aux_iterator [2/2]

typedef more_type::const_iterator FrameCPP::Version_3::FrDetector::const_aux_iterator

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ more_type [1/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_3::FrDetector::more_type

◆ more_type [2/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_3::FrDetector::more_type

◆ object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ string_2_type [1/2]

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

◆ string_2_type [2/2]

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

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Member Enumeration Documentation

◆ anonymous enum

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

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 

◆ anonymous enum

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

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

◆ FrDetector() [1/8]

FrDetector::FrDetector ( )

Default constructor.

◆ FrDetector() [2/8]

FrDetector::FrDetector ( const std::string &  Name,
const INT_2S  LongitudeD,
const INT_2S  LongitudeM,
const REAL_4  LongitudeS,
const INT_2S  LatitudeD,
const INT_2S  LatitudeM,
const REAL_4  LatitudeS,
const REAL_4  Elevation,
const REAL_4  ArmXazimuth,
const REAL_4  ArmYazimuth,
const REAL_4  ArmLength 
)

◆ FrDetector() [3/8]

FrDetector::FrDetector ( const FrDetector detector)

◆ FrDetector() [4/8]

FrDetector::FrDetector ( istream_type Stream)
private

◆ FrDetector() [5/8]

FrameCPP::Version_3::FrDetector::FrDetector ( )

Default constructor.

◆ FrDetector() [6/8]

FrameCPP::Version_3::FrDetector::FrDetector ( const std::string &  Name,
const INT_2S  LongitudeD,
const INT_2S  LongitudeM,
const REAL_4  LongitudeS,
const INT_2S  LatitudeD,
const INT_2S  LatitudeM,
const REAL_4  LatitudeS,
const REAL_4  Elevation,
const REAL_4  ArmXazimuth,
const REAL_4  ArmYazimuth,
const REAL_4  ArmLength 
)

◆ FrDetector() [7/8]

FrameCPP::Version_3::FrDetector::FrDetector ( const FrDetector detector)

◆ FrDetector() [8/8]

FrameCPP::Version_3::FrDetector::FrDetector ( istream_type Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrDetector::Bytes ( const Common::StreamBase Stream) const
virtual

Number of bytes needed to write this structure.

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

◆ Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_3::FrDetector::Bytes ( const Common::StreamBase Stream) const
virtual

Number of bytes needed to write this structure.

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

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.

◆ Clone() [2/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.

◆ Create() [1/4]

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

◆ Create() [2/4]

FrDetector * FrDetector::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [3/4]

virtual FrDetector* FrameCPP::Version_3::FrDetector::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

◆ DataType() [1/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [2/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [3/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DataType() [4/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ demote() [1/2]

FrDetector::demote_ret_type FrDetector::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_3::FrDetector::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

◆ DemoteObject() [1/2]

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.

◆ DemoteObject() [2/2]

static 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.

◆ GetArmLength() [1/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetArmLength ( ) const
inline

◆ GetArmLength() [2/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetArmLength ( ) const

◆ GetArmXazimuth() [1/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetArmXazimuth ( ) const
inline

◆ GetArmXazimuth() [2/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetArmXazimuth ( ) const

◆ GetArmYazimuth() [1/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetArmYazimuth ( ) const
inline

◆ GetArmYazimuth() [2/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetArmYazimuth ( ) const

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

◆ GetDescription() [1/2]

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.

◆ GetDescription() [2/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetElevation() [1/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetElevation ( ) const
inline

◆ GetElevation() [2/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetElevation ( ) const

◆ GetLatitudeD() [1/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLatitudeD ( ) const
inline

◆ GetLatitudeD() [2/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLatitudeD ( ) const

◆ GetLatitudeM() [1/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLatitudeM ( ) const
inline

◆ GetLatitudeM() [2/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLatitudeM ( ) const

◆ GetLatitudeS() [1/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetLatitudeS ( ) const
inline

◆ GetLatitudeS() [2/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetLatitudeS ( ) const

◆ GetLongitudeD() [1/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLongitudeD ( ) const
inline

◆ GetLongitudeD() [2/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLongitudeD ( ) const

◆ GetLongitudeM() [1/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLongitudeM ( ) const
inline

◆ GetLongitudeM() [2/2]

INT_2S FrameCPP::Version_3::FrDetector::GetLongitudeM ( ) const

◆ GetLongitudeS() [1/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetLongitudeS ( ) const
inline

◆ GetLongitudeS() [2/2]

REAL_4 FrameCPP::Version_3::FrDetector::GetLongitudeS ( ) const

◆ GetName() [1/2]

const std::string & FrDetector::GetName ( ) const

◆ GetName() [2/2]

const std::string& FrameCPP::Version_3::FrDetector::GetName ( ) const

◆ Merge() [1/2]

FrDetector & FrDetector::Merge ( const FrDetector RHS)

Merge with another FrDetector.

Todo:
Need to implement Merge routine

◆ Merge() [2/2]

FrDetector& FrameCPP::Version_3::FrDetector::Merge ( const FrDetector RHS)

Merge with another FrDetector.

◆ ObjectStructName() [1/2]

const char * FrDetector::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

virtual const char* FrameCPP::Version_3::FrDetector::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/4]

bool FrDetector::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [2/4]

virtual bool FrameCPP::Version_3::FrDetector::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [3/4]

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

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_3::FrDetector::operator== ( const FrDetector RHS) const

comparison operator

◆ Promote() [1/2]

FrDetector::promote_ret_type FrameCPP::Version_3::FrDetector::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
inlinestatic

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_3::FrDetector::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
static

◆ promote() [1/2]

FrDetector::promote_ret_type FrDetector::promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_3::FrDetector::promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ PromoteObject() [1/5]

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.

◆ PromoteObject() [2/5]

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.

◆ PromoteObject() [3/5]

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.

◆ PromoteObject() [4/5]

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.

◆ PromoteObject() [5/5]

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

◆ RefMore() [1/4]

FrDetector::more_type & FrameCPP::Version_3::FrDetector::RefMore ( )
inline

◆ RefMore() [2/4]

more_type& FrameCPP::Version_3::FrDetector::RefMore ( )

◆ RefMore() [3/4]

const FrDetector::more_type & FrameCPP::Version_3::FrDetector::RefMore ( ) const
inline

◆ RefMore() [4/4]

const more_type& FrameCPP::Version_3::FrDetector::RefMore ( ) const

◆ StructDescription() [1/2]

const Description * FrDetector::StructDescription ( )
static

◆ StructDescription() [2/2]

static const Common::Description* FrameCPP::Version_3::FrDetector::StructDescription ( )
static

◆ StructName() [1/2]

const char * FrameCPP::Version_3::FrDetector::StructName ( )
inlinestatic

◆ StructName() [2/2]

static const char* FrameCPP::Version_3::FrDetector::StructName ( )
static

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inherited

◆ VerifyObject() [1/2]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ VerifyObject() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_3::FrDetector::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_3::FrDetector::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ Write() [1/2]

void FrDetector::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ Write() [2/2]

virtual void FrameCPP::Version_3::FrDetector::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ WriteNext() [1/2]

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.

◆ WriteNext() [2/2]

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

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

fr_detector_data_type FrameCPP::Version_3::FrDetector::m_data
private

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ STRUCT_ID

static const FrameSpec::Info::frame_object_types FrameCPP::Common::FrDetector::STRUCT_ID
staticinherited

The documentation for this class was generated from the following files:
FrameCPP::Common::FrameSpec::Info::FSI_FR_DETECTOR
@ FSI_FR_DETECTOR
Definition: FrameSpec.hh:590