ldas-tools-framecpp 2.8.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
FrameCPP::Version_3::FrSE Class Reference

#include <FrSE.hh>

Inheritance diagram for FrameCPP::Version_3::FrSE:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_3::FrSE:
Collaboration graph
[legend]

Classes

struct  image_t
 

Public Types

typedef FrameSpec::version_type frame_spec_version_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 boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_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_arg_type
 
typedef object_type demote_ret_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_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 

Public Member Functions

 FrSE ()
 Default constructor. More...
 
 FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor. More...
 
INT_8U Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes needed to write this object. More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
std::string GetClass () const
 Return class of object. More...
 
std::string GetComment () const
 Return comment of object. More...
 
std::string GetName () const
 Return name of object. More...
 
virtual FrSECreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream. More...
 
virtual FrSEClone () const
 Create a new instance of the object based on an instance. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
bool operator== (const FrSE &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrSE ()
 Default constructor. More...
 
 FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor. More...
 
INT_8U Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes needed to write this object. More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
std::string GetClass () const
 Return class of object. More...
 
std::string GetComment () const
 Return comment of object. More...
 
std::string GetName () const
 Return name of object. More...
 
virtual FrSECreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream. More...
 
virtual FrSEClone () const
 Create a new instance of the object based on an instance. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
bool operator== (const FrSE &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrSE ()
 Default constructor. More...
 
 FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor. More...
 
INT_8U Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes needed to write this object. More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
std::string GetClass () const
 Return class of object. More...
 
std::string GetComment () const
 Return comment of object. More...
 
std::string GetName () const
 Return name of object. More...
 
virtual FrSECreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream. More...
 
virtual FrSEClone () const
 Create a new instance of the object based on an instance. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
bool operator== (const FrSE &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () 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...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. 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...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 

Static Public Member Functions

static const char * StructName ()
 
static const char * StructName ()
 
static const char * StructName ()
 
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 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 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...
 

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 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 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...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Private Member Functions

 FrSE (istream_type &Stream)
 
 FrSE (istream_type &Stream)
 
 FrSE (istream_type &Stream)
 

Private Attributes

struct FrameCPP::Version_3::FrSE::image_t m_data
 
const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Static Private Attributes

static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FR_SE
 

Member Typedef Documentation

◆ demote_arg_type [1/3]

◆ demote_arg_type [2/3]

◆ demote_arg_type [3/3]

◆ demote_ret_type [1/3]

◆ demote_ret_type [2/3]

◆ demote_ret_type [3/3]

◆ frame_spec_version_type [1/3]

◆ frame_spec_version_type [2/3]

◆ frame_spec_version_type [3/3]

◆ object_type [1/3]

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

◆ object_type [2/3]

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

◆ object_type [3/3]

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

◆ promote_arg_type [1/3]

◆ promote_arg_type [2/3]

◆ promote_arg_type [3/3]

◆ promote_ret_type [1/3]

◆ promote_ret_type [2/3]

◆ promote_ret_type [3/3]

◆ unique_object_type [1/3]

◆ unique_object_type [2/3]

◆ unique_object_type [3/3]

Constructor & Destructor Documentation

◆ FrSE() [1/9]

FrameCPP::Version_3::FrSE::FrSE ( )

Default constructor.

◆ FrSE() [2/9]

FrameCPP::Version_3::FrSE::FrSE ( const std::string &  Name,
const std::string &  ClassId,
const std::string &  Comment = "" 
)

constructor

◆ ~FrSE() [1/3]

FrameCPP::Version_3::FrSE::~FrSE ( )
virtual

Desctructor.

◆ FrSE() [3/9]

FrameCPP::Version_3::FrSE::FrSE ( istream_type Stream)
private

◆ FrSE() [4/9]

FrameCPP::Version_3::FrSE::FrSE ( )

Default constructor.

◆ FrSE() [5/9]

FrameCPP::Version_3::FrSE::FrSE ( const std::string &  Name,
const std::string &  ClassId,
const std::string &  Comment = "" 
)

constructor

◆ ~FrSE() [2/3]

virtual FrameCPP::Version_3::FrSE::~FrSE ( )
virtual

Desctructor.

◆ FrSE() [6/9]

FrameCPP::Version_3::FrSE::FrSE ( istream_type Stream)
private

◆ FrSE() [7/9]

FrameCPP::Version_3::FrSE::FrSE ( )

Default constructor.

◆ FrSE() [8/9]

FrameCPP::Version_3::FrSE::FrSE ( const std::string &  Name,
const std::string &  ClassId,
const std::string &  Comment = "" 
)

constructor

◆ ~FrSE() [3/3]

virtual FrameCPP::Version_3::FrSE::~FrSE ( )
virtual

Desctructor.

◆ FrSE() [9/9]

FrameCPP::Version_3::FrSE::FrSE ( istream_type Stream)
private

Member Function Documentation

◆ Bytes() [1/3]

INT_8U FrameCPP::Version_3::FrSE::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes needed to write this object.

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

◆ Bytes() [2/3]

INT_8U FrameCPP::Version_3::FrSE::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes needed to write this object.

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

◆ Bytes() [3/3]

INT_8U FrameCPP::Version_3::FrSE::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes needed to write this object.

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

◆ Clone() [1/3]

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

Create a new instance of the object based on an instance.

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

◆ Clone() [2/3]

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

Create a new instance of the object based on an instance.

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

◆ Clone() [3/3]

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

Create a new instance of the object based on an instance.

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

◆ Create() [1/5]

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

constructor - virtual

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

◆ Create() [2/5]

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

Create a new instance of the object based on the input stream.

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

◆ Create() [3/5]

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

Create a new instance of the object based on the input stream.

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

◆ Create() [4/5]

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

Create a new instance of the object based on the input stream.

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

◆ Create() [5/5]

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

◆ demote() [1/3]

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

Down grade an object.

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

◆ demote() [2/3]

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

Down grade an object.

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

◆ demote() [3/3]

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

Down grade an object.

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

◆ DemoteObject() [1/3]

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

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.

◆ DemoteObject() [3/3]

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

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

Retrieve the class identifier.

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

◆ GetClass() [1/3]

std::string FrameCPP::Version_3::FrSE::GetClass ( ) const
inline

Return class of object.

◆ getClass() [2/3]

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

Retrieve the class identifier.

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

◆ GetClass() [2/3]

std::string FrameCPP::Version_3::FrSE::GetClass ( ) const

Return class of object.

◆ getClass() [3/3]

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

Retrieve the class identifier.

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

◆ GetClass() [3/3]

std::string FrameCPP::Version_3::FrSE::GetClass ( ) const

Return class of object.

◆ GetComment() [1/3]

std::string FrameCPP::Version_3::FrSE::GetComment ( ) const
inline

Return comment of object.

◆ GetComment() [2/3]

std::string FrameCPP::Version_3::FrSE::GetComment ( ) const

Return comment of object.

◆ GetComment() [3/3]

std::string FrameCPP::Version_3::FrSE::GetComment ( ) const

Return comment of object.

◆ GetDescription() [1/3]

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

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.

◆ GetDescription() [3/3]

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.

◆ GetName() [1/3]

std::string FrameCPP::Version_3::FrSE::GetName ( ) const

Return name of object.

◆ GetName() [2/3]

std::string FrameCPP::Version_3::FrSE::GetName ( ) const

Return name of object.

◆ GetName() [3/3]

std::string FrameCPP::Version_3::FrSE::GetName ( ) const

Return name of object.

◆ ObjectStructName() [1/3]

const char * FrameCPP::Version_3::FrSE::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/3]

virtual const char * FrameCPP::Version_3::FrSE::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() [3/3]

virtual const char * FrameCPP::Version_3::FrSE::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/6]

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

comparison operator

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

◆ operator==() [2/6]

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

comparison operator

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

◆ operator==() [3/6]

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

comparison operator

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

◆ operator==() [4/6]

bool FrameCPP::Version_3::FrSE::operator== ( const FrSE RHS) const

comparison operator

◆ operator==() [5/6]

bool FrameCPP::Version_3::FrSE::operator== ( const FrSE RHS) const

comparison operator

◆ operator==() [6/6]

bool FrameCPP::Version_3::FrSE::operator== ( const FrSE RHS) const

comparison operator

◆ promote() [1/3]

FrSE::promote_ret_type FrameCPP::Version_3::FrSE::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/3]

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

Upgrade an object.

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

◆ promote() [3/3]

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

Upgrade an object.

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

◆ PromoteObject() [1/7]

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

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

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

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

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

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

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

◆ StructName() [1/3]

const char * FrameCPP::Version_3::FrSE::StructName ( )
inlinestatic

◆ StructName() [2/3]

static const char * FrameCPP::Version_3::FrSE::StructName ( )
static

◆ StructName() [3/3]

static const char * FrameCPP::Version_3::FrSE::StructName ( )
static

◆ VerifyObject() [1/3]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, and FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/3]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, and FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [3/3]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, and FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >.

◆ Write() [1/3]

void FrameCPP::Version_3::FrSE::Write ( ostream_type Stream) const
virtual

Write the structure to the stream.

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

◆ Write() [2/3]

virtual void FrameCPP::Version_3::FrSE::Write ( ostream_type Stream) const
virtual

Write the structure to the stream.

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

◆ Write() [3/3]

virtual void FrameCPP::Version_3::FrSE::Write ( ostream_type Stream) const
virtual

Write the structure to the stream.

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

◆ WriteNext() [1/3]

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

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

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 FrameCPP::Version_3::FrSE::image_t FrameCPP::Version_3::FrSE::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.

◆ s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_3::FrSE::s_object_id = Common::FrameSpec::Info::FSI_FR_SE
staticprivate

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