ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_6::FrEndOfFrame Class Reference

#include <FrEndOfFrame.hh>

Inheritance diagram for FrameCPP::Version_6::FrEndOfFrame:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_6::FrEndOfFrame:
Collaboration graph
[legend]

Classes

struct  data_type
 

Public Types

typedef INT_4S run_type
 
typedef INT_4U frame_type
 
typedef INT_4U chkType_type
 
typedef INT_4U chkSum_type
 
typedef INT_4S run_type
 
typedef INT_4U frame_type
 
typedef INT_4U chkType_type
 
typedef INT_4U chkSum_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 

Public Member Functions

 FrEndOfFrame ()
 
 FrEndOfFrame (INT_4S Run, INT_4U Frame)
 
virtual ~FrEndOfFrame ()
 
INT_8U Bytes () const
 
INT_4S GetRun () const
 
INT_4U GetFrame () const
 
INT_4U GetChkType () const
 
INT_4U GetChkSum () const
 
virtual cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual FrEndOfFrameCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
bool operator== (const FrEndOfFrame &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrEndOfFrame ()
 
 FrEndOfFrame (INT_4S Run, INT_4U Frame)
 
virtual ~FrEndOfFrame ()
 
INT_8U Bytes () const
 
INT_4S GetRun () const
 
INT_4U GetFrame () const
 
INT_4U GetChkType () const
 
INT_4U GetChkSum () const
 
virtual cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual FrEndOfFrameCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
bool operator== (const FrEndOfFrame &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
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.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 

Static Public Member Functions

static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
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.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
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.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
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.
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Private Member Functions

 FrEndOfFrame (istream_type &Stream)
 
 FrEndOfFrame (istream_type &Stream)
 

Private Attributes

struct data_type m_data
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 

Member Typedef Documentation

◆ chkSum_type [1/2]

◆ chkSum_type [2/2]

◆ chkType_type [1/2]

◆ chkType_type [2/2]

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ frame_type [1/2]

◆ frame_type [2/2]

◆ object_type [1/2]

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

◆ object_type [2/2]

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

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ run_type [1/2]

◆ run_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Constructor & Destructor Documentation

◆ FrEndOfFrame() [1/6]

FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame ( )

◆ FrEndOfFrame() [2/6]

FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame ( INT_4S  Run,
INT_4U  Frame 
)

◆ ~FrEndOfFrame() [1/2]

FrameCPP::Version_6::FrEndOfFrame::~FrEndOfFrame ( )
virtual

◆ FrEndOfFrame() [3/6]

FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame ( istream_type Stream)
private

◆ FrEndOfFrame() [4/6]

FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame ( )

◆ FrEndOfFrame() [5/6]

FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame ( INT_4S  Run,
INT_4U  Frame 
)

◆ ~FrEndOfFrame() [2/2]

virtual FrameCPP::Version_6::FrEndOfFrame::~FrEndOfFrame ( )
virtual

◆ FrEndOfFrame() [6/6]

FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame ( istream_type Stream)
private

Member Function Documentation

◆ Bytes() [1/4]

INT_8U FrameCPP::Version_6::FrEndOfFrame::Bytes ( ) const

◆ Bytes() [2/4]

INT_8U FrameCPP::Version_6::FrEndOfFrame::Bytes ( ) const

◆ Bytes() [3/4]

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::FrEndOfFrame::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.

◆ Bytes() [4/4]

virtual cmn_streamsize_type FrameCPP::Version_6::FrEndOfFrame::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.

◆ Clone() [1/2]

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

◆ Clone() [2/2]

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

◆ Create() [1/4]

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

◆ Create() [2/4]

FrEndOfFrame * FrameCPP::Version_6::FrEndOfFrame::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [3/4]

virtual FrEndOfFrame * FrameCPP::Version_6::FrEndOfFrame::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

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

◆ demote() [1/2]

FrEndOfFrame::demote_ret_type FrameCPP::Version_6::FrEndOfFrame::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

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

Down grade an object.

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

◆ DemoteObject() [1/2]

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

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

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

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetChkSum() [1/2]

INT_4U FrameCPP::Version_6::FrEndOfFrame::GetChkSum ( ) const
inline

◆ GetChkSum() [2/2]

INT_4U FrameCPP::Version_6::FrEndOfFrame::GetChkSum ( ) const

◆ GetChkType() [1/2]

INT_4U FrameCPP::Version_6::FrEndOfFrame::GetChkType ( ) const
inline

◆ GetChkType() [2/2]

INT_4U FrameCPP::Version_6::FrEndOfFrame::GetChkType ( ) const

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetDescription() [1/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [2/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetFrame() [1/2]

INT_4U FrameCPP::Version_6::FrEndOfFrame::GetFrame ( ) const
inline

◆ GetFrame() [2/2]

INT_4U FrameCPP::Version_6::FrEndOfFrame::GetFrame ( ) const

◆ GetRun() [1/2]

INT_4S FrameCPP::Version_6::FrEndOfFrame::GetRun ( ) const
inline

◆ GetRun() [2/2]

INT_4S FrameCPP::Version_6::FrEndOfFrame::GetRun ( ) const

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_6::FrEndOfFrame::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_6::FrEndOfFrame::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/4]

bool FrameCPP::Version_6::FrEndOfFrame::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [2/4]

virtual bool FrameCPP::Version_6::FrEndOfFrame::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [3/4]

bool FrameCPP::Version_6::FrEndOfFrame::operator== ( const FrEndOfFrame RHS) const

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_6::FrEndOfFrame::operator== ( const FrEndOfFrame RHS) const

comparison operator

◆ promote() [1/2]

FrEndOfFrame::promote_ret_type FrameCPP::Version_6::FrEndOfFrame::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_6::FrEndOfFrame::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ PromoteObject() [1/5]

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

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/5]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/5]

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

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/5]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/5]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_6::FrEndOfFrame::StructDescription ( )
static

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_6::FrEndOfFrame::StructDescription ( )
static

◆ StructName() [1/2]

const char * FrameCPP::Version_6::FrEndOfFrame::StructName ( )
inlinestatic

◆ StructName() [2/2]

static const char * FrameCPP::Version_6::FrEndOfFrame::StructName ( )
static

◆ VerifyObject() [1/2]

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

◆ VerifyObject() [2/2]

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

◆ Write() [1/2]

void FrameCPP::Version_6::FrEndOfFrame::Write ( ostream_type Stream) const
virtual

Write object to the stream.

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

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

◆ Write() [2/2]

virtual void FrameCPP::Version_6::FrEndOfFrame::Write ( ostream_type Stream) const
virtual

Write object to the stream.

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

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

◆ WriteNext() [1/2]

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

Write a next pointer to the parent to the stream.

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

◆ WriteNext() [2/2]

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

◆ m_class

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

Storage for the class identifier.

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

◆ m_data

struct data_type FrameCPP::Version_6::FrEndOfFrame::m_data
private

◆ m_desc

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

Description for parent class.

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


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