ldas-tools-framecpp  2.7.0
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
FrameCPP::Version_7::FrameH Class Reference

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_7::FrameH:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_7::FrameH:
Collaboration graph
[legend]

Public Types

typedef Common::FrameH::assign_stream_type assign_stream_type
 
typedef Common::FrameH::assign_stream_type assign_stream_type
 
enum  copy_type {
  DETECT_SIM = 0x0001, DETECT_PROC = 0x0002, HISTORY = 0x0004, RAW_DATA = 0x0008,
  AUX_DATA = 0x0010, AUX_TABLE = 0x0020, TYPE = 0x0040, USER = 0x0080,
  DETECT_SIM = 0x0001, DETECT_PROC = 0x0002, HISTORY = 0x0004, RAW_DATA = 0x0008,
  AUX_DATA = 0x0010, AUX_TABLE = 0x0020, TYPE = 0x0040, USER = 0x0080
}
 
enum  copy_type {
  DETECT_SIM = 0x0001, DETECT_PROC = 0x0002, HISTORY = 0x0004, RAW_DATA = 0x0008,
  AUX_DATA = 0x0010, AUX_TABLE = 0x0020, TYPE = 0x0040, USER = 0x0080,
  DETECT_SIM = 0x0001, DETECT_PROC = 0x0002, HISTORY = 0x0004, RAW_DATA = 0x0008,
  AUX_DATA = 0x0010, AUX_TABLE = 0x0020, TYPE = 0x0040, USER = 0x0080
}
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Object > object_type
 
typedef boost::shared_ptr< Object > object_type
 
typedef std::unique_ptr< Object > unique_object_type
 
typedef std::unique_ptr< Object > unique_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

 FrameH ()
 Default constructor. More...
 
 FrameH (const FrameH &frame)
 
 FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0)
 
 FrameH (const FrameHNPS &Source)
 
 FrameH (const Previous::FrameH &Source, istream_type *Stream)
 
 ~FrameH ()
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrameH * Clone () const
 Virtual constructor. More...
 
virtual FrameH * Create (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 the structure to the stream. More...
 
bool operator== (const FrameH &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrameH ()
 Default constructor. More...
 
 FrameH (const FrameH &frame)
 
 FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0)
 
 FrameH (const FrameHNPS &Source)
 
 FrameH (const Previous::FrameH &Source, istream_type *Stream)
 
 ~FrameH ()
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrameH * Clone () const
 Virtual constructor. More...
 
virtual FrameH * Create (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 the structure to the stream. More...
 
bool operator== (const FrameH &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...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual Object * Create () const
 constructor - virtual More...
 
virtual Object * Create (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)
 

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::Description * StructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::Description * StructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
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 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 Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FRAME_H
 

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid. More...
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds. More...
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame. More...
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid. More...
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds. More...
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame. More...
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Private Member Functions

 FrameH (istream_type &Stream)
 
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...
 
 FrameH (istream_type &Stream)
 
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...
 

Member Typedef Documentation

◆ assign_stream_type [1/2]

typedef Common::FrameH::assign_stream_type FrameCPP::Version_7::FrameH::assign_stream_type

◆ assign_stream_type [2/2]

typedef Common::FrameH::assign_stream_type FrameCPP::Version_7::FrameH::assign_stream_type

◆ demote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type
inherited

◆ demote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type
inherited

◆ demote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type
inherited

◆ demote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type
inherited

◆ frame_spec_version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type
inherited

◆ frame_spec_version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type
inherited

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

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type
inherited

◆ promote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type
inherited

◆ promote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type
inherited

◆ promote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type
inherited

◆ unique_object_type [1/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type
inherited

◆ unique_object_type [2/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type
inherited

Member Enumeration Documentation

◆ copy_type [1/2]

enum FrameCPP::Common::FrameH::copy_type
inherited
Enumerator
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

◆ copy_type [2/2]

enum FrameCPP::Common::FrameH::copy_type
inherited
Enumerator
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

Constructor & Destructor Documentation

◆ FrameH() [1/12]

FrameH::FrameH ( )

Default constructor.

◆ FrameH() [2/12]

FrameH::FrameH ( const FrameH &  frame)

◆ FrameH() [3/12]

FrameH::FrameH ( const std::string &  name,
INT_4S  run,
INT_4U  frame,
const GPSTime &  time,
INT_2U  uLeapS,
const REAL_8  dt,
INT_4U  dqual = 0 
)

◆ FrameH() [4/12]

FrameH::FrameH ( const FrameHNPS &  Source)

◆ FrameH() [5/12]

FrameH::FrameH ( const Previous::FrameH &  Source,
istream_type *  Stream 
)
inline

◆ ~FrameH() [1/2]

FrameH::~FrameH ( )
virtual

Reimplemented from FrameCPP::Common::FrameH.

◆ FrameH() [6/12]

FrameH::FrameH ( istream_type &  Stream)
private

◆ FrameH() [7/12]

FrameCPP::Version_7::FrameH::FrameH ( )

Default constructor.

◆ FrameH() [8/12]

FrameCPP::Version_7::FrameH::FrameH ( const FrameH &  frame)

◆ FrameH() [9/12]

FrameCPP::Version_7::FrameH::FrameH ( const std::string &  name,
INT_4S  run,
INT_4U  frame,
const GPSTime &  time,
INT_2U  uLeapS,
const REAL_8  dt,
INT_4U  dqual = 0 
)

◆ FrameH() [10/12]

FrameCPP::Version_7::FrameH::FrameH ( const FrameHNPS &  Source)

◆ FrameH() [11/12]

FrameCPP::Version_7::FrameH::FrameH ( const Previous::FrameH &  Source,
istream_type *  Stream 
)

◆ ~FrameH() [2/2]

FrameCPP::Version_7::FrameH::~FrameH ( )
virtual

Reimplemented from FrameCPP::Common::FrameH.

◆ FrameH() [12/12]

FrameCPP::Version_7::FrameH::FrameH ( istream_type &  Stream)
private

Member Function Documentation

◆ assign() [1/2]

void FrameH::assign ( assign_stream_type &  Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

Implements FrameCPP::Common::FrameH.

◆ assign() [2/2]

virtual void FrameCPP::Version_7::FrameH::assign ( assign_stream_type &  Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

Implements FrameCPP::Common::FrameH.

◆ Bytes() [1/2]

cmn_streamsize_type FrameCPP::Version_7::FrameH::Bytes ( const Common::StreamBase &  Stream) const
virtual

Number of bytes needed to write this structure.

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

◆ Bytes() [2/2]

FrameCPP::cmn_streamsize_type FrameH::Bytes ( const Common::StreamBase &  Stream) const
virtual

Number of bytes needed to write this structure.

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

◆ Clone() [1/2]

FrameH * FrameH::Clone ( ) const
virtual

Virtual constructor.

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

◆ Clone() [2/2]

virtual FrameH* FrameCPP::Version_7::FrameH::Clone ( ) const
virtual

Virtual constructor.

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

◆ Create() [1/4]

virtual FrameH* FrameCPP::Version_7::FrameH::Create ( istream_type &  Stream) const
virtual

constructor - virtual

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

◆ Create() [2/4]

FrameH * FrameH::Create ( istream_type &  Stream) const
virtual

constructor - virtual

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

◆ Create() [3/4]

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

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, and FrameCPP::Version_4::FrTOC.

◆ Create() [4/4]

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

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ demote() [1/2]

FrameH::demote_ret_type FrameH::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
privatevirtual

Down grade an object.

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_7::FrameH::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
privatevirtual

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.

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

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]

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.

◆ normalizedDeltaT() [1/2]

delta_t_normalized_type FrameH::normalizedDeltaT ( ) const
inlineprotectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedDeltaT() [2/2]

virtual delta_t_normalized_type FrameCPP::Version_7::FrameH::normalizedDeltaT ( ) const
protectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [1/2]

start_time_normalized_type FrameH::normalizedStartTime ( ) const
inlineprotectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [2/2]

virtual start_time_normalized_type FrameCPP::Version_7::FrameH::normalizedStartTime ( ) const
protectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ ObjectStructName() [1/2]

virtual const char* FrameCPP::Version_7::FrameH::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]

const char * FrameH::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 FrameH::operator== ( const FrameH &  RHS) const
inline

comparison operator

◆ operator==() [2/4]

bool FrameCPP::Version_7::FrameH::operator== ( const FrameH &  RHS) const

comparison operator

◆ operator==() [3/4]

bool FrameH::operator== ( const Common::FrameSpec::Object &  Obj) const
virtual

comparison operator

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

◆ operator==() [4/4]

virtual bool FrameCPP::Version_7::FrameH::operator== ( const Common::FrameSpec::Object &  Obj) const
virtual

comparison operator

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

◆ Promote() [1/2]

FrameH::promote_ret_type FrameH::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
inlinestatic

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_7::FrameH::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

◆ promote() [1/2]

virtual promote_ret_type FrameCPP::Version_7::FrameH::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
privatevirtual

Upgrade an object.

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

◆ promote() [2/2]

FrameH::promote_ret_type FrameH::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
privatevirtual

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]

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]

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() [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

◆ readSubset() [1/2]

void FrameH::readSubset ( istream_type &  Stream,
INT_4U  ElementMask 
)
protectedvirtual

Implements FrameCPP::Common::FrameH.

◆ readSubset() [2/2]

virtual void FrameCPP::Version_7::FrameH::readSubset ( istream_type &  Stream,
INT_4U  ElementMask 
)
protectedvirtual

Implements FrameCPP::Common::FrameH.

◆ StructDescription() [1/2]

static const Common::Description* FrameCPP::Version_7::FrameH::StructDescription ( )
static

◆ StructDescription() [2/2]

const Description * FrameH::StructDescription ( )
static

◆ StructName() [1/2]

static const char* FrameCPP::Version_7::FrameH::StructName ( )
static

◆ StructName() [2/2]

const char * FrameH::StructName ( )
inlinestatic

◆ VerifyObject() [1/2]

void FrameH::VerifyObject ( Common::Verify &  Verifier,
Common::IFrameStream &  Stream 
) const
protectedvirtual

Verify the object as being valid.

Parameters
[in]VerifierThe instance of the Verify object where state information is stored.
[in]StreamThe input stream from which the object is being read.

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

◆ VerifyObject() [2/2]

virtual void FrameCPP::Version_7::FrameH::VerifyObject ( Common::Verify &  Verifier,
Common::IFrameStream &  Stream 
) const
protectedvirtual

Verify the object as being valid.

Parameters
[in]VerifierThe instance of the Verify object where state information is stored.
[in]StreamThe input stream from which the object is being read.

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

◆ Write() [1/2]

void FrameH::Write ( ostream_type &  Stream) const
virtual

Write the structure to the stream.

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

◆ Write() [2/2]

virtual void FrameCPP::Version_7::FrameH::Write ( ostream_type &  Stream) const
virtual

Write the structure to the stream.

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

◆ s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameH::s_object_id = Common::FrameSpec::Info::FSI_FRAME_H
staticinherited
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.14