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::FrTrigData Class Reference

#include <FrTrigData.hh>

Inheritance diagram for FrameCPP::Version_3::FrTrigData:
FrameCPP::Common::FrameSpec::Object FrameCPP::Version_3::FrTrigDataStorage FrameCPP::Version_3::FrTrigDataRefsT< Vect > FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

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
Common::SearchContainer
< FrVect,&FrVect::GetName
data_type
 
typedef data_type::iterator iterator
 
typedef data_type::const_iterator const_iterator
 

Public Member Functions

 FrTrigData ()
 
 FrTrigData (const FrTrigData &eventData)
 
 FrTrigData (const std::string &Name, const std::string &Comment, const std::string &Inputs, const GPSTime &GTime, const INT_4U Bvalue, const REAL_4 Rvalue, const REAL_4 prob, const std::string &statistics)
 
const std::string & GetNameSlow () const
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrTrigDataCreate (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...
 
FrTrigDataMerge (const FrTrigData &RHS)
 
bool operator== (const FrTrigData &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...
 
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...
 
const std::string & GetName () const
 
const std::string & GetComment () const
 
const std::string & GetInputs () const
 
const GPSTimeGetGTime () const
 
INT_4U GetBvalue () const
 
REAL_4 GetRvalue () const
 
REAL_4 GetProbability () const
 
const std::string & GetStatistics () const
 
const data_typeRefData () const
 
data_typeRefData ()
 

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_2U MAX_REF = 1
 

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 Vect >
typedef data_type::const_iterator FrameCPP::Version_3::FrTrigDataRefsT< Vect >::const_iterator
inherited
template<typename Vect >
typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_3::FrTrigDataRefsT< Vect >::data_type
inherited
template<typename Vect >
typedef data_type::iterator FrameCPP::Version_3::FrTrigDataRefsT< Vect >::iterator
inherited
typedef LDASTools::AL::SharedPtr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

Constructor & Destructor Documentation

FrameCPP::Version_3::FrTrigData::FrTrigData ( )
FrameCPP::Version_3::FrTrigData::FrTrigData ( const FrTrigData eventData)
FrameCPP::Version_3::FrTrigData::FrTrigData ( const std::string &  Name,
const std::string &  Comment,
const std::string &  Inputs,
const GPSTime GTime,
const INT_4U  Bvalue,
const REAL_4  Rvalue,
const REAL_4  prob,
const std::string &  statistics 
)

Member Function Documentation

FrameCPP::cmn_streamsize_type FrameCPP::Version_3::FrTrigData::Bytes ( const Common::StreamBase Stream) const
inlinevirtual

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.

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited
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.

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

constructor - virtual

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

FrTrigData::demote_ret_type FrameCPP::Version_3::FrTrigData::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.
INT_4U FrameCPP::Version_3::FrTrigDataStorage::GetBvalue ( ) const
inlineinherited
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::FrTrigDataStorage::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.

const GPSTime& FrameCPP::Version_3::FrTrigDataStorage::GetGTime ( ) const
inlineinherited
const std::string& FrameCPP::Version_3::FrTrigDataStorage::GetInputs ( ) const
inlineinherited
const std::string& FrameCPP::Version_3::FrTrigDataStorage::GetName ( ) const
inlineinherited
const std::string & FrameCPP::Version_3::FrTrigData::GetNameSlow ( ) const
REAL_4 FrameCPP::Version_3::FrTrigDataStorage::GetProbability ( ) const
inlineinherited
REAL_4 FrameCPP::Version_3::FrTrigDataStorage::GetRvalue ( ) const
inlineinherited
const std::string& FrameCPP::Version_3::FrTrigDataStorage::GetStatistics ( ) const
inlineinherited
FrTrigData & FrameCPP::Version_3::FrTrigData::Merge ( const FrTrigData RHS)
const char * FrameCPP::Version_3::FrTrigData::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::FrTrigData::operator== ( const FrTrigData RHS) const
inline

comparison operator

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

comparison operator

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

FrTrigData::promote_ret_type FrameCPP::Version_3::FrTrigData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic
FrTrigData::promote_ret_type FrameCPP::Version_3::FrTrigData::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 Vect >
const data_type& FrameCPP::Version_3::FrTrigDataRefsT< Vect >::RefData ( ) const
inlineinherited
template<typename Vect >
data_type& FrameCPP::Version_3::FrTrigDataRefsT< Vect >::RefData ( )
inlineinherited
const Description * FrameCPP::Version_3::FrTrigData::StructDescription ( )
static
const char * FrameCPP::Version_3::FrTrigData::StructName ( )
inlinestatic
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
void FrameCPP::Version_3::FrTrigData::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

data_type FrameCPP::Version_3::FrTrigDataStorage::m_data
protectedinherited
template<typename Vect >
ref_type FrameCPP::Version_3::FrTrigDataRefsT< Vect >::m_refs
protectedinherited
template<typename Vect >
const INT_2U FrameCPP::Version_3::FrTrigDataRefsT< Vect >::MAX_REF = 1
staticinherited

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