ldas-tools-framecpp 2.8.1
|
Holder of Stream reference to an object within the stream. More...
#include <PTR_STRUCT.hh>
Public Member Functions | |
PTR_STRUCT () | |
Default constructor. More... | |
PTR_STRUCT (data_class_type ClassId, data_instance_type Instance) | |
Constructor. More... | |
virtual class_type | Class () const |
Retrieve the class identifier. More... | |
virtual void | Class (class_type Value) |
Establish the class identifier. More... | |
data_class_type | ClassRaw () const |
Retrieve the class identifier. | |
virtual instance_type | Instance () const |
Retrieve the instance of the class. More... | |
virtual void | Instance (instance_type Value) |
Establish the instance of the class. More... | |
data_instance_type | InstanceRaw () const |
Establish the instance of the class. More... | |
const PTR_STRUCT & | operator= (const PTR_STRUCT &RHS) |
Assignment operator. More... | |
cmn_streamsize_type | Bytes (const StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual PTR_STRUCT * | Create (IStream &Stream) const |
Virtual constructor. More... | |
virtual PTR_STRUCT * | Clone () const |
Virtual constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual void | Write (OStream &Stream) const |
Write the structure to the stream. More... | |
bool | operator== (const PTR_STRUCT &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
bool | operator!= (const PTR_STRUCT &RHS) const |
comparison operator More... | |
PTR_STRUCT () | |
Default constructor. More... | |
PTR_STRUCT (data_class_type ClassId, data_instance_type Instance) | |
Constructor. More... | |
virtual class_type | Class () const |
Retrieve the class identifier. More... | |
virtual void | Class (class_type Value) |
Establish the class identifier. More... | |
data_class_type | ClassRaw () const |
Retrieve the class identifier. | |
virtual instance_type | Instance () const |
Retrieve the instance of the class. More... | |
virtual void | Instance (instance_type Value) |
Establish the instance of the class. More... | |
data_instance_type | InstanceRaw () const |
Establish the instance of the class. More... | |
const PTR_STRUCT & | operator= (const PTR_STRUCT &RHS) |
Assignment operator. More... | |
cmn_streamsize_type | Bytes (const StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual PTR_STRUCT * | Create (IStream &Stream) const |
Virtual constructor. More... | |
virtual PTR_STRUCT * | Clone () const |
Virtual constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual void | Write (OStream &Stream) const |
Write the structure to the stream. More... | |
bool | operator== (const PTR_STRUCT &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
bool | operator!= (const PTR_STRUCT &RHS) const |
comparison operator More... | |
PTR_STRUCT () | |
Default constructor. More... | |
PTR_STRUCT (data_class_type ClassId, data_instance_type Instance) | |
Constructor. More... | |
virtual class_type | Class () const |
Retrieve the class identifier. More... | |
virtual void | Class (class_type Value) |
Establish the class identifier. More... | |
data_class_type | ClassRaw () const |
Retrieve the class identifier. | |
virtual instance_type | Instance () const |
Retrieve the instance of the class. More... | |
virtual void | Instance (instance_type Value) |
Establish the instance of the class. More... | |
data_instance_type | InstanceRaw () const |
Establish the instance of the class. More... | |
const PTR_STRUCT & | operator= (const PTR_STRUCT &RHS) |
Assignment operator. More... | |
cmn_streamsize_type | Bytes (const StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual PTR_STRUCT * | Create (IStream &Stream) const |
Virtual constructor. More... | |
virtual PTR_STRUCT * | Clone () const |
Virtual constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual void | Write (OStream &Stream) const |
Write the structure to the stream. More... | |
bool | operator== (const PTR_STRUCT &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
bool | operator!= (const PTR_STRUCT &RHS) const |
comparison operator More... | |
bool | IsNULL () const |
Determine if the reference represents a NULL reference. More... | |
bool | IsNULL () const |
Determine if the reference represents a NULL reference. More... | |
bool | IsNULL () const |
Determine if the reference represents a NULL reference. More... | |
class_type | GetClass () const |
Retrieve the class identifier. 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... | |
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... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Create () const |
constructor - virtual | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
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 cmn_streamsize_type | Bytes () |
Number of bytes needed to write this structure. More... | |
static cmn_streamsize_type | Bytes () |
Number of bytes needed to write this structure. More... | |
static cmn_streamsize_type | Bytes () |
Number of bytes needed to write this structure. More... | |
static std::string | Desc (const std::string &Type) |
Describe the reference object. More... | |
static std::string | Desc (const std::string &Type) |
Describe the reference object. More... | |
static std::string | Desc (const std::string &Type) |
Describe the reference 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 | 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... | |
Static Public Attributes | |
static const PTR_STRUCT & | NULL_PTR = PTR_STRUCT< DC, DI >( 0, 0 ) |
Version specific NULL reference. | |
Protected Member Functions | |
virtual FrameSpec::ObjectInterface::demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual FrameSpec::ObjectInterface::promote_ret_type | promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) const |
Promotes object to another version of the frame spec. More... | |
virtual FrameSpec::ObjectInterface::demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual FrameSpec::ObjectInterface::promote_ret_type | promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) const |
Promotes object to another version of the frame spec. More... | |
virtual FrameSpec::ObjectInterface::demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual FrameSpec::ObjectInterface::promote_ret_type | promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) const |
Promotes object to another version of the frame spec. More... | |
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. | |
Holder of Stream reference to an object within the stream.
This is a version specific interface to the information.
|
inline |
Default constructor.
|
inline |
Constructor.
[in] | ClassId | |
[in] | Instance |
FrameCPP::Common::PTR_STRUCT< DC, DI >::PTR_STRUCT | ( | ) |
Default constructor.
FrameCPP::Common::PTR_STRUCT< DC, DI >::PTR_STRUCT | ( | data_class_type | ClassId, |
data_instance_type | Instance | ||
) |
Constructor.
[in] | ClassId | |
[in] | Instance |
FrameCPP::Common::PTR_STRUCT< DC, DI >::PTR_STRUCT | ( | ) |
Default constructor.
FrameCPP::Common::PTR_STRUCT< DC, DI >::PTR_STRUCT | ( | data_class_type | ClassId, |
data_instance_type | Instance | ||
) |
Constructor.
[in] | ClassId | |
[in] | Instance |
|
inlinestatic |
Number of bytes needed to write this structure.
|
static |
Number of bytes needed to write this structure.
|
static |
Number of bytes needed to write this structure.
|
inlinevirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Retrieve the class identifier.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Retrieve the class identifier.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Retrieve the class identifier.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Establish the class identifier.
[in] | Value | The class identifier. |
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Establish the class identifier.
[in] | Value | The class identifier. |
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Establish the class identifier.
[in] | Value | The class identifier. |
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
inlinevirtual |
Virtual constructor.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Virtual constructor.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Virtual constructor.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
inlinevirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprotectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inlinestaticinherited |
Describe the reference object.
[in] | Type | The type of object being referenced. |
Output the descriptive text that needs to be part of the FrSE object used to describe the entirety of an object.
|
staticinherited |
Describe the reference object.
[in] | Type | The type of object being referenced. |
|
staticinherited |
Describe the reference object.
[in] | Type | The type of object being referenced. |
|
inlineinherited |
Retrieve the class identifier.
|
inherited |
Retrieve the class identifier.
|
inherited |
Retrieve the class identifier.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Retrieve the instance of the class.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Retrieve the instance of the class.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Retrieve the instance of the class.
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Establish the instance of the class.
[in] | Value | The instance of the class. |
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Establish the instance of the class.
[in] | Value | The instance of the class. |
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
virtual |
Establish the instance of the class.
[in] | Value | The instance of the class. |
Implements FrameCPP::Common::PTR_STRUCT_BASE.
|
inline |
Establish the instance of the class.
|
inline |
Establish the instance of the class.
|
inline |
Establish the instance of the class.
|
inlineinherited |
Determine if the reference represents a NULL reference.
A NULL reference is used to terminate a list of objects.
|
inherited |
Determine if the reference represents a NULL reference.
|
inherited |
Determine if the reference represents a NULL reference.
|
inlinevirtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
comparison operator
[in] | RHS | The PTR_STRUCT to compare. |
bool FrameCPP::Common::PTR_STRUCT< DC, DI >::operator!= | ( | const PTR_STRUCT< DC, DI > & | RHS | ) | const |
comparison operator
[in] | RHS | The PTR_STRUCT to compare. |
bool FrameCPP::Common::PTR_STRUCT< DC, DI >::operator!= | ( | const PTR_STRUCT< DC, DI > & | RHS | ) | const |
comparison operator
[in] | RHS | The PTR_STRUCT to compare. |
const PTR_STRUCT< DC, DI > & PTR_STRUCT::operator= | ( | const PTR_STRUCT< DC, DI > & | RHS | ) |
Assignment operator.
[in] | RHS | The source to copy. |
const PTR_STRUCT & FrameCPP::Common::PTR_STRUCT< DC, DI >::operator= | ( | const PTR_STRUCT< DC, DI > & | RHS | ) |
Assignment operator.
[in] | RHS | The source to copy. |
const PTR_STRUCT & FrameCPP::Common::PTR_STRUCT< DC, DI >::operator= | ( | const PTR_STRUCT< DC, DI > & | RHS | ) |
Assignment operator.
[in] | RHS | The source to copy. |
|
inlinevirtual |
comparison operator
[in] | Obj | The stream object to compare. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
[in] | Obj | The stream object to compare. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
[in] | Obj | The stream object to compare. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
comparison operator
[in] | RHS | The PTR_STRUCT to compare. |
bool FrameCPP::Common::PTR_STRUCT< DC, DI >::operator== | ( | const PTR_STRUCT< DC, DI > & | RHS | ) | const |
comparison operator
[in] | RHS | The PTR_STRUCT to compare. |
bool FrameCPP::Common::PTR_STRUCT< DC, DI >::operator== | ( | const PTR_STRUCT< DC, DI > & | RHS | ) | const |
comparison operator
[in] | RHS | The PTR_STRUCT to compare. |
|
inlineprotectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
inlinevirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |