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

#include <FrStatData.hh>

Inheritance diagram for FrameCPP::Version_3::FrStatData:
FrameCPP::Common::FrStatData FrameCPP::Version_3::FrStatDataStorage FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect > FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef FrStatDataStorage nps_type
 
typedef FrStatDataRefs ps_type
 
typedef Query::fr_detector_type fr_detector_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef
LDASTools::AL::SharedPtr
< Object
object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef INT_4U timeStart_type
 
typedef INT_4U timeEnd_type
 
typedef INT_4U version_type
 
typedef
LDASTools::AL::SharedPtr
< TDetector > 
detector_type
 
typedef
LDASTools::AL::SharedConstPtr
< TDetector > 
const_detector_type
 
typedef
Common::SearchContainer< TVect,&TVect::GetName > 
data_type
 
typedef data_type::iterator iterator
 
typedef data_type::const_iterator const_iterator
 

Public Member Functions

 FrStatData ()
 
 FrStatData (const FrStatData &statData)
 
 FrStatData (const std::string &name, const std::string &comment, INT_4U timeStart, INT_4U timeEnd, INT_4U version)
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrStatDataClone () const
 constructor - virtual copy constructor More...
 
virtual FrStatDataCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual fr_detector_type GetDetector () const
 
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...
 
FrStatDataMerge (const FrStatData &RHS)
 
bool operator== (const FrStatData &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...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual 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...
 
const std::string & GetName () const
 
const std::string & GetComment () const
 
timeStart_type GetTimeStart () const
 
timeEnd_type GetTimeEnd () const
 
version_type GetVersion () const
 
bool operator== (const FrStatDataStorage &RHS) const
 
detector_type GetDetector ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
detector_typeAddressOfDetector () const
 
void SetDetector (detector_type Detector)
 
bool operator== (const FrStatDataRefsT &RHS) const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
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 Public Attributes

static const INT_4U ALL_VERSIONS = 0xFFFFFFFF
 
static const INT_4U LATEST_VERSION = 0xFFFFFFFE
 
static const
FrameSpec::Info::frame_object_types 
STRUCT_ID = FrameSpec::Info::FSI_FR_STAT_DATA
 
static const INT_2U MAX_REF = 2
 

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 Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

data_type m_data
 
ref_type m_refs
 

Member Typedef Documentation

template<typename TDetector , typename TVect >
typedef LDASTools::AL::SharedConstPtr< TDetector > FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::const_detector_type
inherited
template<typename TDetector , typename TVect >
typedef data_type::const_iterator FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::const_iterator
inherited
template<typename TDetector , typename TVect >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::data_type
inherited
template<typename TDetector , typename TVect >
typedef LDASTools::AL::SharedPtr< TDetector > FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::detector_type
inherited
typedef Query::fr_detector_type FrameCPP::Common::FrStatData::fr_detector_type
inherited
template<typename TDetector , typename TVect >
typedef data_type::iterator FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::iterator
inherited
typedef LDASTools::AL::SharedPtr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

Constructor & Destructor Documentation

FrameCPP::Version_3::FrStatData::FrStatData ( )
FrameCPP::Version_3::FrStatData::FrStatData ( const FrStatData statData)
FrameCPP::Version_3::FrStatData::FrStatData ( const std::string &  name,
const std::string &  comment,
INT_4U  timeStart,
INT_4U  timeEnd,
INT_4U  version 
)

Member Function Documentation

template<typename TDetector , typename TVect >
detector_type* FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::AddressOfDetector ( ) const
inlineinherited
FrameCPP::cmn_streamsize_type FrameCPP::Version_3::FrStatData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

FrStatData * FrameCPP::Version_3::FrStatData::Clone ( ) const
virtual

constructor - virtual copy constructor

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

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

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

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

constructor - virtual

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

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

Down grade an object.

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

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

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

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

Retrieve the class identifier.

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

const std::string & FrameCPP::Version_3::FrStatDataStorage::GetComment ( ) const
inlineinherited
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.

template<typename TDetector , typename TVect >
detector_type FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::GetDetector ( )
inlineinherited
virtual fr_detector_type FrameCPP::Version_3::FrStatData::GetDetector ( ) const
inlinevirtual
const std::string & FrameCPP::Version_3::FrStatDataStorage::GetName ( ) const
inlineinherited
FrStatDataStorage::timeEnd_type FrameCPP::Version_3::FrStatDataStorage::GetTimeEnd ( ) const
inlineinherited
FrStatDataStorage::timeStart_type FrameCPP::Version_3::FrStatDataStorage::GetTimeStart ( ) const
inlineinherited
FrStatDataStorage::version_type FrameCPP::Version_3::FrStatDataStorage::GetVersion ( ) const
inlineinherited
FrStatData & FrameCPP::Version_3::FrStatData::Merge ( const FrStatData RHS)
const char * FrameCPP::Version_3::FrStatData::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.

bool FrameCPP::Version_3::FrStatDataStorage::operator== ( const FrStatDataStorage RHS) const
inlineinherited
template<typename TDetector , typename TVect >
bool FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::operator== ( const FrStatDataRefsT< TDetector, TVect > &  RHS) const
inlineinherited
bool FrameCPP::Version_3::FrStatData::operator== ( const FrStatData RHS) const
inline

comparison operator

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

comparison operator

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

FrStatData::promote_ret_type FrameCPP::Version_3::FrStatData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic
FrStatData::promote_ret_type FrameCPP::Version_3::FrStatData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

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

Upgrade an object.

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

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited
template<typename TDetector , typename TVect >
const data_type& FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::RefData ( ) const
inlineinherited
template<typename TDetector , typename TVect >
data_type& FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::RefData ( )
inlineinherited
template<typename TDetector , typename TVect >
void FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::SetDetector ( detector_type  Detector)
inlineinherited
const Description * FrameCPP::Version_3::FrStatData::StructDescription ( )
static
const char * FrameCPP::Version_3::FrStatData::StructName ( )
inlinestatic
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
void FrameCPP::Version_3::FrStatData::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.

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

const INT_4U FrameCPP::Version_3::FrStatData::ALL_VERSIONS = 0xFFFFFFFF
static
const INT_4U FrameCPP::Version_3::FrStatData::LATEST_VERSION = 0xFFFFFFFE
static
data_type FrameCPP::Version_3::FrStatDataStorage::m_data
protectedinherited
template<typename TDetector , typename TVect >
ref_type FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::m_refs
protectedinherited
template<typename TDetector , typename TVect >
const INT_2U FrameCPP::Version_3::FrStatDataRefsT< TDetector, TVect >::MAX_REF = 2
staticinherited
const FrameSpec::Info::frame_object_types FrameCPP::Common::FrStatData::STRUCT_ID = FrameSpec::Info::FSI_FR_STAT_DATA
staticinherited

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