FrameCPP::Version_8::FrDetector Class Reference

Detector data. More...

#include <FrDetector.hh>

Inheritance diagram for FrameCPP::Version_8::FrDetector:

Collaboration diagram for FrameCPP::Version_8::FrDetector:

Classes
struct	fr_detector_data_type

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 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< ObjectType, ChecksumType >	self_type
typedef ObjectWithChecksum< ObjectType, ChecksumType >	self_type
typedef IStream	istream_type
typedef IStream	istream_type
typedef OStream	ostream_type
typedef OStream	ostream_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.
	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.
	FrDetector (const FrDetector &detector)
	Copy constructor.
	FrDetector (Previous::FrDetector &Source, istream_type *Stream)
	Promotion Constructor.
virtual const char *	ObjectStructName () const
	The name structure name of this object.
const std::string &	GetName () const
	Retrieve the name of the instrument.
const CHAR *	GetPrefix () const
	Retrieve the prefix of the instrument.
longitude_type	GetLongitude () const
	Retrieve the longitude of the detector vertex.
latitude_type	GetLatitude () const
	Retrieve the latitude of the detector vertex.
elevation_type	GetElevation () const
	Retrieve the vertex elevation of the detector.
armXazimuth_type	GetArmXazimuth () const
	Retrieve the orientation of X arm of the detector.
armYazimuth_type	GetArmYazimuth () const
	Retrieve the orientation of Y arm of the detector.
armXaltitude_type	GetArmXaltitude () const
	Retrieve the altitude angle of X arm of the detector.
armYaltitude_type	GetArmYaltitude () const
	Retrieve the altitude angle of Y arm of the detector.
armXmidpoint_type	GetArmXmidpoint () const
	Retrieve the midpoint of the X arm of the detector.
armYmidpoint_type	GetArmYmidpoint () const
	Retrieve the midpoint of the Y arm of the detector.
localTime_type	GetLocalTime () const
	Retrieve the local seasonal time.
const aux_type &	RefAux () const
	Identifier for vector for user-provided information.
aux_type &	RefAux ()
	Identifier for vector for user-provided information.
const table_type &	RefTable () const
	Identifier for user-provided information in table format.
table_type &	RefTable ()
	Identifier for user-provided information in table format.
FrDetector &	Merge (const FrDetector &RHS)
	Merge with another FrDetector.
bool	operator== (const FrDetector &RHS) const
	equality operator
virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type
	FrDetector ()
	Default constructor.
	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.
	FrDetector (const FrDetector &detector)
	Copy constructor.
	FrDetector (Previous::FrDetector &Source, istream_type *Stream)
	Promotion Constructor.
virtual const char *	ObjectStructName () const
	The name structure name of this object.
const std::string &	GetName () const
	Retrieve the name of the instrument.
const CHAR *	GetPrefix () const
	Retrieve the prefix of the instrument.
longitude_type	GetLongitude () const
	Retrieve the longitude of the detector vertex.
latitude_type	GetLatitude () const
	Retrieve the latitude of the detector vertex.
elevation_type	GetElevation () const
	Retrieve the vertex elevation of the detector.
armXazimuth_type	GetArmXazimuth () const
	Retrieve the orientation of X arm of the detector.
armYazimuth_type	GetArmYazimuth () const
	Retrieve the orientation of Y arm of the detector.
armXaltitude_type	GetArmXaltitude () const
	Retrieve the altitude angle of X arm of the detector.
armYaltitude_type	GetArmYaltitude () const
	Retrieve the altitude angle of Y arm of the detector.
armXmidpoint_type	GetArmXmidpoint () const
	Retrieve the midpoint of the X arm of the detector.
armYmidpoint_type	GetArmYmidpoint () const
	Retrieve the midpoint of the Y arm of the detector.
localTime_type	GetLocalTime () const
	Retrieve the local seasonal time.
const aux_type &	RefAux () const
	Identifier for vector for user-provided information.
aux_type &	RefAux ()
	Identifier for vector for user-provided information.
const table_type &	RefTable () const
	Identifier for user-provided information in table format.
table_type &	RefTable ()
	Identifier for user-provided information in table format.
FrDetector &	Merge (const FrDetector &RHS)
	Merge with another FrDetector.
bool	operator== (const FrDetector &RHS) const
	equality operator
virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
void	TOCQuery (int InfoClass,...) const
void	TOCQuery (int InfoClass,...) const

Static Public Member Functions
static const char *	StructName ()
	The name structure name of this object.
static const Common::Description *	StructDescription ()
	The description of structure.
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
	Promote previous version of object to this version.
static const char *	StructName ()
	The name structure name of this object.
static const Common::Description *	StructDescription ()
	The description of structure.
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
	Promote previous version of object to this version.
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
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)

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.
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.
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.
virtual FrDetector *	pCreate (istream_type &Stream) const
	Virtual constructor.
virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream.
virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.
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.
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.
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.
virtual FrDetector *	pCreate (istream_type &Stream) const
	Virtual constructor.
virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream.
virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.

Private Types
typedef ObjectWithChecksum< Common::FrDetector >	object_type
typedef ObjectWithChecksum< Common::FrDetector >	object_type
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >	object_base_type
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >	object_base_type

Private Member Functions
	FrDetector (istream_type &Stream)
	FrDetector (istream_type &Stream)
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

Private Attributes
fr_detector_data_type	m_data
ChecksumType	m_chkSum
	Structure checksum.

Detailed Description

Detector data.

Member Typedef Documentation

armXaltitude_type [1/2]

typedef FR_DETECTOR_ARM_X_ALTITUDE_TYPE FrameCPP::Version_8::FrDetector::armXaltitude_type

armXaltitude_type [2/2]

typedef FR_DETECTOR_ARM_X_ALTITUDE_TYPE FrameCPP::Version_8::FrDetector::armXaltitude_type

armXazimuth_type [1/2]

typedef FR_DETECTOR_ARM_X_AZIMUTH_TYPE FrameCPP::Version_8::FrDetector::armXazimuth_type

armXazimuth_type [2/2]

typedef FR_DETECTOR_ARM_X_AZIMUTH_TYPE FrameCPP::Version_8::FrDetector::armXazimuth_type

armXmidpoint_type [1/2]

typedef FR_DETECTOR_ARM_X_MIDPOINT_TYPE FrameCPP::Version_8::FrDetector::armXmidpoint_type

armXmidpoint_type [2/2]

typedef FR_DETECTOR_ARM_X_MIDPOINT_TYPE FrameCPP::Version_8::FrDetector::armXmidpoint_type

armYaltitude_type [1/2]

typedef FR_DETECTOR_ARM_Y_ALTITUDE_TYPE FrameCPP::Version_8::FrDetector::armYaltitude_type

armYaltitude_type [2/2]

typedef FR_DETECTOR_ARM_Y_ALTITUDE_TYPE FrameCPP::Version_8::FrDetector::armYaltitude_type

armYazimuth_type [1/2]

typedef FR_DETECTOR_ARM_Y_AZIMUTH_TYPE FrameCPP::Version_8::FrDetector::armYazimuth_type

armYazimuth_type [2/2]

typedef FR_DETECTOR_ARM_Y_AZIMUTH_TYPE FrameCPP::Version_8::FrDetector::armYazimuth_type

armYmidpoint_type [1/2]

typedef FR_DETECTOR_ARM_Y_MIDPOINT_TYPE FrameCPP::Version_8::FrDetector::armYmidpoint_type

armYmidpoint_type [2/2]

typedef FR_DETECTOR_ARM_Y_MIDPOINT_TYPE FrameCPP::Version_8::FrDetector::armYmidpoint_type

aux_iterator [1/2]

typedef aux_type::iterator FrameCPP::Version_8::FrDetector::aux_iterator

aux_iterator [2/2]

typedef aux_type::iterator FrameCPP::Version_8::FrDetector::aux_iterator

aux_type [1/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrDetector::aux_type

aux_type [2/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrDetector::aux_type

const_aux_iterator [1/2]

typedef aux_type::const_iterator FrameCPP::Version_8::FrDetector::const_aux_iterator

const_aux_iterator [2/2]

typedef aux_type::const_iterator FrameCPP::Version_8::FrDetector::const_aux_iterator

const_table_iterator [1/2]

typedef table_type::const_iterator FrameCPP::Version_8::FrDetector::const_table_iterator

const_table_iterator [2/2]

typedef table_type::const_iterator FrameCPP::Version_8::FrDetector::const_table_iterator

elevation_type [1/2]

typedef FR_DETECTOR_ELEVATION_TYPE FrameCPP::Version_8::FrDetector::elevation_type

elevation_type [2/2]

typedef FR_DETECTOR_ELEVATION_TYPE FrameCPP::Version_8::FrDetector::elevation_type

istream_type [1/2]

template<typename ObjectType , typename ChecksumType >

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type

inherited

istream_type [2/2]

template<typename ObjectType , typename ChecksumType >

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type

inherited

latitude_type [1/2]

typedef FR_DETECTOR_LATITUDE_TYPE FrameCPP::Version_8::FrDetector::latitude_type

latitude_type [2/2]

typedef FR_DETECTOR_LATITUDE_TYPE FrameCPP::Version_8::FrDetector::latitude_type

localTime_type [1/2]

typedef FR_DETECTOR_LOCAL_TIME_TYPE FrameCPP::Version_8::FrDetector::localTime_type

localTime_type [2/2]

typedef FR_DETECTOR_LOCAL_TIME_TYPE FrameCPP::Version_8::FrDetector::localTime_type

longitude_type [1/2]

typedef FR_DETECTOR_LONGITUDE_TYPE FrameCPP::Version_8::FrDetector::longitude_type

longitude_type [2/2]

typedef FR_DETECTOR_LONGITUDE_TYPE FrameCPP::Version_8::FrDetector::longitude_type

object_base_type [1/2]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrDetector >::object_base_type

privateinherited

object_base_type [2/2]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrDetector , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrDetector >::object_base_type

privateinherited

object_type [1/2]

typedef ObjectWithChecksum< Common::FrDetector > FrameCPP::Version_8::FrDetector::object_type

private

object_type [2/2]

typedef ObjectWithChecksum< Common::FrDetector > FrameCPP::Version_8::FrDetector::object_type

private

ostream_type [1/2]

template<typename ObjectType , typename ChecksumType >

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type

inherited

ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type

inherited

self_type [1/2]

template<typename ObjectType , typename ChecksumType >

typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type

inherited

self_type [2/2]

template<typename ObjectType , typename ChecksumType >

typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type

inherited

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

table_iterator [1/2]

typedef table_type::iterator FrameCPP::Version_8::FrDetector::table_iterator

table_iterator [2/2]

typedef table_type::iterator FrameCPP::Version_8::FrDetector::table_iterator

table_type [1/2]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrDetector::table_type

table_type [2/2]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrDetector::table_type

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/10]

FrameCPP::Version_8::FrDetector::FrDetector

(

)

Default constructor.

Returns

A new instance of an FrDetector object

FrDetector() [2/10]

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

Returns

A new instance of an FrDetector object

FrDetector() [3/10]

FrameCPP::Version_8::FrDetector::FrDetector

(

const FrDetector &

detector

)

Copy constructor.

Parameters

[in]

detector

The source instance to copy

Returns

A new instance of an FrDetector object

FrDetector() [4/10]

FrameCPP::Version_8::FrDetector::FrDetector	(	Previous::FrDetector &	Source,
		istream_type *	Stream )

Promotion Constructor.

Parameters

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

Returns

A new instance of an FrDetector object

FrDetector() [5/10]

FrameCPP::Version_8::FrDetector::FrDetector ( istream_type & Stream )

private

FrDetector() [6/10]

FrameCPP::Version_8::FrDetector::FrDetector

(

)

Default constructor.

Returns

A new instance of an FrDetector object

FrDetector() [7/10]

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

Returns

A new instance of an FrDetector object

FrDetector() [8/10]

FrameCPP::Version_8::FrDetector::FrDetector

(

const FrDetector &

detector

)

Copy constructor.

Parameters

[in]

detector

The source instance to copy

Returns

A new instance of an FrDetector object

FrDetector() [9/10]

FrameCPP::Version_8::FrDetector::FrDetector	(	Previous::FrDetector &	Source,
		istream_type *	Stream )

Promotion Constructor.

Parameters

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

Returns

A new instance of an FrDetector object

FrDetector() [10/10]

FrameCPP::Version_8::FrDetector::FrDetector ( istream_type & Stream )

private

Member Function Documentation

Bytes() [1/2]

template<typename ObjectType , typename ChecksumType >

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in]

Stream

Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns

The number of bytes for this object

Bytes() [2/2]

template<typename ObjectType , typename ChecksumType >

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in]

Stream

Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns

The number of bytes for this object

CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

Create() [1/6]

template<typename ObjectType , typename ChecksumType >

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.

Create() [2/6]

template<typename ObjectType , typename ChecksumType >

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.

Create() [3/6]

template<typename ObjectType , typename ChecksumType >

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from where the object is being read.

Returns

Return pointer to the newly allocated resource.

Create() [4/6]

template<typename ObjectType , typename ChecksumType >

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from where the object is being read.

Returns

Return pointer to the newly allocated resource.

Create() [5/6]

template<typename ObjectType , typename ChecksumType >

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

Create() [6/6]

template<typename ObjectType , typename ChecksumType >

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

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

Returns

An object of the previous generation.

demote() [2/2]

virtual 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]	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.

Returns

An object of the previous generation.

GetArmXaltitude() [1/2]

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.

GetArmXaltitude() [2/2]

armXaltitude_type FrameCPP::Version_8::FrDetector::GetArmXaltitude

(

)

const

Retrieve the altitude angle of X arm of the detector.

Returns

The altitude angle of the X arm of the detector.

GetArmXazimuth() [1/2]

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.

GetArmXazimuth() [2/2]

armXazimuth_type FrameCPP::Version_8::FrDetector::GetArmXazimuth

(

)

const

Retrieve the orientation of X arm of the detector.

Returns

The orientation of the X arm of the detector.

GetArmXmidpoint() [1/2]

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.

GetArmXmidpoint() [2/2]

armXmidpoint_type FrameCPP::Version_8::FrDetector::GetArmXmidpoint

(

)

const

Retrieve the midpoint of the X arm of the detector.

Returns

The midpoint of the X arm of the detector.

GetArmYaltitude() [1/2]

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.

GetArmYaltitude() [2/2]

armYaltitude_type FrameCPP::Version_8::FrDetector::GetArmYaltitude

(

)

const

Retrieve the altitude angle of Y arm of the detector.

Returns

The altitude angle of the Y arm of the detector.

GetArmYazimuth() [1/2]

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.

GetArmYazimuth() [2/2]

armYazimuth_type FrameCPP::Version_8::FrDetector::GetArmYazimuth

(

)

const

Retrieve the orientation of Y arm of the detector.

Returns

The orientation of the Y arm of the detector.

GetArmYmidpoint() [1/2]

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.

GetArmYmidpoint() [2/2]

armYmidpoint_type FrameCPP::Version_8::FrDetector::GetArmYmidpoint

(

)

const

Retrieve the midpoint of the Y arm of the detector.

Returns

The midpoint of the Y arm of the detector.

GetElevation() [1/2]

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

inline

Retrieve the vertex elevation of the detector.

Returns

The vertex elevation of the detector.

GetElevation() [2/2]

elevation_type FrameCPP::Version_8::FrDetector::GetElevation

(

)

const

Retrieve the vertex elevation of the detector.

Returns

The vertex elevation of the detector.

GetLatitude() [1/2]

FrDetector::latitude_type FrameCPP::Version_8::FrDetector::GetLatitude ( ) const

inline

Retrieve the latitude of the detector vertex.

Returns

The latitude of the detector vertex.

GetLatitude() [2/2]

latitude_type FrameCPP::Version_8::FrDetector::GetLatitude

(

)

const

Retrieve the latitude of the detector vertex.

Returns

The latitude of the detector vertex.

GetLocalTime() [1/2]

FrDetector::localTime_type FrameCPP::Version_8::FrDetector::GetLocalTime ( ) const

inline

Retrieve the local seasonal time.

Returns

The local seasonal time.

GetLocalTime() [2/2]

localTime_type FrameCPP::Version_8::FrDetector::GetLocalTime

(

)

const

Retrieve the local seasonal time.

Returns

The local seasonal time.

GetLongitude() [1/2]

FrDetector::longitude_type FrameCPP::Version_8::FrDetector::GetLongitude ( ) const

inline

Retrieve the longitude of the detector vertex.

Returns

The longitude of the detector vertex.

GetLongitude() [2/2]

longitude_type FrameCPP::Version_8::FrDetector::GetLongitude

(

)

const

Retrieve the longitude of the detector vertex.

Returns

The longitude of the detector vertex.

GetName() [1/2]

const std::string & FrameCPP::Version_8::FrDetector::GetName

(

)

const

Retrieve the name of the instrument.

Returns

The name of the instrument.

GetName() [2/2]

const std::string & FrameCPP::Version_8::FrDetector::GetName

(

)

const

Retrieve the name of the instrument.

Returns

The name of the instrument.

GetPrefix() [1/2]

const CHAR * FrameCPP::Version_8::FrDetector::GetPrefix ( ) const

inline

Retrieve the prefix of the instrument.

Returns

The prefix for the instrument.

GetPrefix() [2/2]

const CHAR * FrameCPP::Version_8::FrDetector::GetPrefix

(

)

const

Retrieve the prefix of the instrument.

Returns

The prefix for the instrument.

Merge() [1/2]

FrDetector & FrameCPP::Version_8::FrDetector::Merge

(

const FrDetector &

RHS

)

Merge with another FrDetector.

Parameters

[in]

RHS

The source of the information to append to this FrDetector structure.

Returns

A reference to this object

Todo

Need to implement Merge routine

Merge() [2/2]

FrDetector & FrameCPP::Version_8::FrDetector::Merge

(

const FrDetector &

RHS

)

Merge with another FrDetector.

Parameters

[in]

RHS

The source of the information to append to this FrDetector structure.

Returns

A reference to this object

ObjectStructName() [1/2]

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.

ObjectStructName() [2/2]

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

operator==() [1/4]

bool FrameCPP::Version_8::FrDetector::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in]

RHS

The object to be compared.

Returns

The value true is returned if this object is equivelent to the RHS instance; false otherwise.

operator==() [2/4]

virtual bool FrameCPP::Version_8::FrDetector::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in]

RHS

The object to be compared.

Returns

The value true is returned if this object is equivelent to the RHS instance; false otherwise.

operator==() [3/4]

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

inline

equality operator

Parameters

[in]

RHS

The FrDetector object to be compared.

Returns

The value true is returned if the object is equivelent to the RHS instance; false otherwise.

operator==() [4/4]

bool FrameCPP::Version_8::FrDetector::operator==

(

const FrDetector &

RHS

)

const

equality operator

Parameters

[in]

RHS

The FrDetector object to be compared.

Returns

The value true is returned if the object is equivelent to the RHS instance; false otherwise.

pBytes() [1/2]

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]

Stream

The 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< ObjectType, ChecksumType >.

pBytes() [2/2]

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

protectedvirtual

Number of bytes needed to write this structure.

Parameters

[in]

Stream

The 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< ObjectType, ChecksumType >.

pCreate() [1/2]

FrDetector * FrameCPP::Version_8::FrDetector::pCreate ( istream_type & Stream ) const

protectedvirtual

Virtual constructor.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

pCreate() [2/2]

virtual FrDetector * FrameCPP::Version_8::FrDetector::pCreate ( istream_type & Stream ) const

protectedvirtual

Virtual constructor.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

Promote() [1/2]

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

Returns

A new instance of FrameH based on Obj

Promote() [2/2]

static promote_ret_type FrameCPP::Version_8::FrDetector::Promote ( INT_2U Source, promote_arg_type Obj, istream_type * Stream )

static

Promote previous version of object to this version.

Parameters

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

Returns

A new instance of FrameH based on Obj

promote() [1/2]

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

Returns

An object promoted to the next generation.

promote() [2/2]

virtual 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]	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.

Returns

An object promoted to the next generation.

pWrite() [1/2]

void FrameCPP::Version_8::FrDetector::pWrite ( ostream_type & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

[in]

Stream

The output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

pWrite() [2/2]

virtual void FrameCPP::Version_8::FrDetector::pWrite ( ostream_type & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

[in]

Stream

The output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

RefAux() [1/4]

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

inline

Identifier for vector for user-provided information.

Returns

A reference to the user-provided information.

RefAux() [2/4]

aux_type & FrameCPP::Version_8::FrDetector::RefAux

(

)

Identifier for vector for user-provided information.

Returns

A reference to the user-provided information.

RefAux() [3/4]

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.

RefAux() [4/4]

const aux_type & FrameCPP::Version_8::FrDetector::RefAux

(

)

const

Identifier for vector for user-provided information.

Returns

A constant reference to the user-provided information.

RefTable() [1/4]

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.

RefTable() [2/4]

table_type & FrameCPP::Version_8::FrDetector::RefTable

(

)

Identifier for user-provided information in table format.

Returns

A reference to the user-provided table information.

RefTable() [3/4]

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.

RefTable() [4/4]

const table_type & FrameCPP::Version_8::FrDetector::RefTable

(

)

const

Identifier for user-provided information in table format.

Returns

A constant reference to the user-provided table information.

StructDescription() [1/2]

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.

StructDescription() [2/2]

static const Common::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.

StructName() [1/2]

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.

StructName() [2/2]

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

static

The name structure name of this object.

Returns

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

TOCQuery() [1/2]

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

inlineinherited

TOCQuery() [2/2]

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

inherited

vTOCQuery() [1/2]

void FrameCPP::Version_8::FrDetector::vTOCQuery ( int InfoClass, va_list vl ) const

protectedvirtual

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

vTOCQuery() [2/2]

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

protectedvirtual

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

Write() [1/2]

template<typename ObjectType , typename ChecksumType >

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Write() [2/2]

template<typename ObjectType , typename ChecksumType >

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Member Data Documentation

m_chkSum

template<typename ObjectType , typename ChecksumType >

ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum

privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

m_data

fr_detector_data_type FrameCPP::Version_8::FrDetector::m_data

private

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrDetector.hh
• Version8/FrDetector.hh
• Version8/FrDetector.cc