ldas-tools-framecpp  2.9.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Common::FrameSpec::Object Class Referenceabstract

Base for all frame objects. More...

#include <FrameSpec.hh>

Inheritance diagram for FrameCPP::Common::FrameSpec::Object:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::FrameSpec::Object:
Collaboration graph
[legend]

Public Member Functions

 Object (class_type Class, const Description *Description)
 constructor More...
 
 Object (const Object &Source)
 copy constructor More...
 
virtual ~Object ()
 destructor
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Objectoperator= (const Object &Source)
 Assignement operator. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
 Object (class_type Class, const Description *Description)
 constructor More...
 
 Object (const Object &Source)
 copy constructor More...
 
virtual ~Object ()
 destructor
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Objectoperator= (const Object &Source)
 Assignement operator. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
 Object (class_type Class, const Description *Description)
 constructor More...
 
 Object (const Object &Source)
 copy constructor More...
 
virtual ~Object ()
 destructor
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Objectoperator= (const Object &Source)
 Assignement operator. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual const char * ObjectStructName () const =0
 Retrieve the class name of the object. More...
 
virtual const char * ObjectStructName () const =0
 Retrieve the class name of the object. More...
 
virtual const char * ObjectStructName () const =0
 Retrieve the class name of the 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...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void Write (ostream_type &Stream) const =0
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const =0
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const =0
 Write object to the stream. More...
 

Static Public Member Functions

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 class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
 Demotes object to previous version of the frame spec. More...
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
 Demotes object to previous version of the frame spec. More...
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
 Promotes object to another version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
 Promotes object to another version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
 Promotes object to another version of the frame spec. More...
 

Detailed Description

Base for all frame objects.

This is the base class for all frame objects that need to be written to or read from a frame stream.

Constructor & Destructor Documentation

◆ Object() [1/6]

FrameCPP::Common::FrameSpec::Object::Object ( class_type  Class,
const Description *  Description 
)

constructor

Allocation of the object's resources.

Parameters
[in]ClassA unique identifier that identifies the class of object.
[in]DescriptionDescription of the class

◆ Object() [2/6]

FrameCPP::Common::FrameSpec::Object::Object ( const Object Source)

copy constructor

Parameters
[in]SourceObject to duplicate

◆ Object() [3/6]

FrameCPP::Common::FrameSpec::Object::Object ( class_type  Class,
const Description *  Description 
)

constructor

Parameters
[in]ClassA unique identifier that identifies the class of object.
[in]DescriptionDescription of the class

◆ Object() [4/6]

FrameCPP::Common::FrameSpec::Object::Object ( const Object Source)

copy constructor

Parameters
[in]SourceObject to duplicate

◆ Object() [5/6]

FrameCPP::Common::FrameSpec::Object::Object ( class_type  Class,
const Description *  Description 
)

constructor

Parameters
[in]ClassA unique identifier that identifies the class of object.
[in]DescriptionDescription of the class

◆ Object() [6/6]

FrameCPP::Common::FrameSpec::Object::Object ( const Object Source)

copy constructor

Parameters
[in]SourceObject to duplicate

Member Function Documentation

◆ Bytes() [1/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes ( const StreamBase &  Stream) const
pure virtualinherited

◆ Bytes() [2/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes ( const StreamBase &  Stream) const
pure virtualinherited

◆ Bytes() [3/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes ( const StreamBase &  Stream) const
pure virtualinherited

◆ demote() [1/3]

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ demote() [2/3]

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ demote() [3/3]

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/3]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [3/3]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetDescription() [1/3]

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

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
virtual

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
virtual

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ ObjectStructName() [1/3]

virtual const char* FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName ( ) const
pure virtualinherited

◆ ObjectStructName() [2/3]

virtual const char* FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName ( ) const
pure virtualinherited

◆ ObjectStructName() [3/3]

virtual const char* FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName ( ) const
pure virtualinherited

◆ operator=() [1/3]

const FrameSpec::Object & FrameCPP::Common::FrameSpec::Object::operator= ( const Object Source)
inline

Assignement operator.

Assignment operator.

Parameters
[in]SourceThe instance to replicate.
Returns
The modified object.

◆ operator=() [2/3]

const Object& FrameCPP::Common::FrameSpec::Object::operator= ( const Object Source)

Assignement operator.

Parameters
[in]SourceThe instance to replicate.
Returns
The modified object.

◆ operator=() [3/3]

const Object& FrameCPP::Common::FrameSpec::Object::operator= ( const Object Source)

Assignement operator.

Parameters
[in]SourceThe instance to replicate.
Returns
The modified object.

◆ promote() [1/3]

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ promote() [2/3]

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ promote() [3/3]

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedpure virtualinherited

◆ PromoteObject() [1/6]

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

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

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

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

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

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.

◆ 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_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_3::FrameH.

◆ 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_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_3::FrameH.

◆ 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_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_3::FrameH.

◆ Write() [1/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type &  Stream) const
pure virtualinherited

◆ Write() [2/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type &  Stream) const
pure virtualinherited

◆ Write() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type &  Stream) const
pure virtualinherited

◆ WriteNext() [1/3]

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

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

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

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.

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