FrameCPP::Version_8::FrDetector Class Reference

Detector data. More...

#include <FrDetector.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.

Public Member Functions
	FrDetector ()
	Default constructor. More...
	FrDetector (const std::string &Name, const char *Prefix, const longitude_type Longitude, const latitude_type Latitude, const elevation_type Elevation, const armXazimuth_type ArmXazimuth, const armYazimuth_type ArmYazimuth, const armXaltitude_type ArmXaltitude, const armYaltitude_type ArmYaltitude, const armXmidpoint_type ArmXmidpoint, const armYmidpoint_type ArmYmidpoint, const localTime_type LocalTime)
	Constructor. More...
	FrDetector (const FrDetector &detector)
	Copy constructor. More...
	FrDetector (Previous::FrDetector &Source, istream_type *Stream)
	Promotion Constructor. More...
virtual const char *	ObjectStructName () const
	The name structure name of this object. More...
const std::string &	GetName () const
	Retrieve the name of the instrument. More...
const CHAR *	GetPrefix () const
	Retrieve the prefix of the instrument. More...
longitude_type	GetLongitude () const
	Retrieve the longitude of the detector vertex. More...
latitude_type	GetLatitude () const
	Retrieve the latitude of the detector vertex. More...
elevation_type	GetElevation () const
	Retrieve the vertex elevation of the detector. More...
armXazimuth_type	GetArmXazimuth () const
	Retrieve the orientation of X arm of the detector. More...
armYazimuth_type	GetArmYazimuth () const
	Retrieve the orientation of Y arm of the detector. More...
armXaltitude_type	GetArmXaltitude () const
	Retrieve the altitude angle of X arm of the detector. More...
armYaltitude_type	GetArmYaltitude () const
	Retrieve the altitude angle of Y arm of the detector. More...
armXmidpoint_type	GetArmXmidpoint () const
	Retrieve the midpoint of the X arm of the detector. More...
armYmidpoint_type	GetArmYmidpoint () const
	Retrieve the midpoint of the Y arm of the detector. More...
localTime_type	GetLocalTime () const
	Retrieve the local seasonal time. More...
const aux_type &	RefAux () const
	Identifier for vector for user-provided information. More...
aux_type &	RefAux ()
	Identifier for vector for user-provided information. More...
const table_type &	RefTable () const
	Identifier for user-provided information in table format. More...
table_type &	RefTable ()
	Identifier for user-provided information in table format. More...
FrDetector &	Merge (const FrDetector &RHS)
	Merge with another FrDetector. More...
bool	operator== (const FrDetector &RHS) const
	equality operator More...
virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type More...
	FrDetector ()
	Default constructor. More...
	FrDetector (const std::string &Name, const char *Prefix, const longitude_type Longitude, const latitude_type Latitude, const elevation_type Elevation, const armXazimuth_type ArmXazimuth, const armYazimuth_type ArmYazimuth, const armXaltitude_type ArmXaltitude, const armYaltitude_type ArmYaltitude, const armXmidpoint_type ArmXmidpoint, const armYmidpoint_type ArmYmidpoint, const localTime_type LocalTime)
	Constructor. More...
	FrDetector (const FrDetector &detector)
	Copy constructor. More...
	FrDetector (Previous::FrDetector &Source, istream_type *Stream)
	Promotion Constructor. More...
virtual const char *	ObjectStructName () const
	The name structure name of this object. More...
const std::string &	GetName () const
	Retrieve the name of the instrument. More...
const CHAR *	GetPrefix () const
	Retrieve the prefix of the instrument. More...
longitude_type	GetLongitude () const
	Retrieve the longitude of the detector vertex. More...
latitude_type	GetLatitude () const
	Retrieve the latitude of the detector vertex. More...
elevation_type	GetElevation () const
	Retrieve the vertex elevation of the detector. More...
armXazimuth_type	GetArmXazimuth () const
	Retrieve the orientation of X arm of the detector. More...
armYazimuth_type	GetArmYazimuth () const
	Retrieve the orientation of Y arm of the detector. More...
armXaltitude_type	GetArmXaltitude () const
	Retrieve the altitude angle of X arm of the detector. More...
armYaltitude_type	GetArmYaltitude () const
	Retrieve the altitude angle of Y arm of the detector. More...
armXmidpoint_type	GetArmXmidpoint () const
	Retrieve the midpoint of the X arm of the detector. More...
armYmidpoint_type	GetArmYmidpoint () const
	Retrieve the midpoint of the Y arm of the detector. More...
localTime_type	GetLocalTime () const
	Retrieve the local seasonal time. More...
const aux_type &	RefAux () const
	Identifier for vector for user-provided information. More...
aux_type &	RefAux ()
	Identifier for vector for user-provided information. More...
const table_type &	RefTable () const
	Identifier for user-provided information in table format. More...
table_type &	RefTable ()
	Identifier for user-provided information in table format. More...
FrDetector &	Merge (const FrDetector &RHS)
	Merge with another FrDetector. More...
bool	operator== (const FrDetector &RHS) const
	equality operator More...
virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type More...
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object. More...
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object. More...
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor. More...
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor. More...
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

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

Protected Member Functions
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Demotes object to previous version of the frame spec. More...
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
	Promotes object to another version of the frame spec. More...
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...
virtual FrDetector *	pCreate (istream_type &Stream) const
	Virtual constructor.
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 demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Demotes object to previous version of the frame spec. More...
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
	Promotes object to another version of the frame spec. More...
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...
virtual FrDetector *	pCreate (istream_type &Stream) const
	Virtual constructor.
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 void	pWrite (ostream_type &Stream) const=0
	Write the structure to the stream. More...

Detailed Description

Detector data.

Constructor & Destructor Documentation

FrDetector() [1/8]

FrameCPP::Version_8::FrDetector::FrDetector

(

)

Default constructor.

Returns

A new instance of an FrDetector object

FrDetector() [2/8]

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

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

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

FrameCPP::Version_8::FrDetector::FrDetector

(

)

Default constructor.

Returns

A new instance of an FrDetector object

FrDetector() [6/8]

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() [7/8]

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() [8/8]

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

Member Function Documentation

Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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

Create() [1/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [2/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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.

demote() [1/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.

demote() [2/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.

GetArmXaltitude() [1/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.

GetArmXaltitude() [2/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.

GetArmXazimuth() [1/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.

GetArmXazimuth() [2/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.

GetArmXmidpoint() [1/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.

GetArmXmidpoint() [2/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.

GetArmYaltitude() [1/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.

GetArmYaltitude() [2/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.

GetArmYazimuth() [1/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.

GetArmYazimuth() [2/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.

GetArmYmidpoint() [1/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.

GetArmYmidpoint() [2/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.

GetElevation() [1/2]

elevation_type FrameCPP::Version_8::FrDetector::GetElevation

(

)

const

Retrieve the vertex elevation of the detector.

Returns

The vertex elevation of the detector.

GetElevation() [2/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.

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]

localTime_type FrameCPP::Version_8::FrDetector::GetLocalTime

(

)

const

Retrieve the local seasonal time.

Returns

The local seasonal time.

GetLocalTime() [2/2]

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

inline

Retrieve the local seasonal time.

Returns

The local seasonal time.

GetLongitude() [1/2]

longitude_type FrameCPP::Version_8::FrDetector::GetLongitude

(

)

const

Retrieve the longitude of the detector vertex.

Returns

The longitude of the detector vertex.

GetLongitude() [2/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.

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

Retrieve the prefix of the instrument.

Returns

The prefix for the instrument.

GetPrefix() [2/2]

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

inline

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]

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.

ObjectStructName() [2/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.

operator==() [1/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==() [2/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.

operator==() [3/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==() [4/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.

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, checksum_type >.

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, checksum_type >.

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]

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.

promote() [2/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.

pWrite() [1/3]

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.

pWrite() [2/3]

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.

pWrite() [3/3]

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

protectedpure virtualinherited

Write the structure to the stream.

Parameters

[in]

Stream

The output stream where the object is to be written.

Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.

RefAux() [1/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() [2/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.

RefAux() [3/4]

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

(

)

Identifier for vector for user-provided information.

Returns

A reference to the user-provided information.

RefAux() [4/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.

RefTable() [1/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() [2/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.

RefTable() [3/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() [4/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.

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]

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.

StructName() [2/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.

vTOCQuery() [1/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.

vTOCQuery() [2/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.

---

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