ldas-tools-framecpp
2.5.8
|
Generalized common elements of frame structure. More...
#include <StreamRef.hh>
Public Types | |
typedef StreamRef2< LT, CKT, CT, IT > | self_type |
typedef INT_2U | class_type |
typedef INT_4U | instance_type |
typedef INT_8U | length_type |
typedef FrameSpec::version_type | frame_spec_version_type |
typedef LDASTools::AL::SharedPtr < Object > | object_type |
typedef std::unique_ptr< Object > | unique_object_type |
typedef object_type | demote_arg_type |
typedef object_type | demote_ret_type |
typedef object_type | promote_arg_type |
typedef object_type | promote_ret_type |
Public Member Functions | |
StreamRef2 () | |
Constructor. More... | |
virtual | ~StreamRef2 () |
Destructor. More... | |
FrameSpec::size_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual FrameSpec::size_type | SizeOf () const |
virtual INT_2U | GetChkType () const |
virtual class_type | GetClass () const |
virtual instance_type | GetInstance () const |
virtual length_type | GetLength () const |
virtual void | SetChkType (INT_2U ChkType) |
virtual void | SetClass (class_type Class) |
virtual void | SetInstance (instance_type Instance) |
virtual void | SetLength (length_type Length) |
virtual self_type * | Create (IStream &Stream) const |
constructor - virtual More... | |
virtual self_type * | Clone () const |
constructor - virtual copy constructor More... | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. More... | |
virtual void | Write (OStream &Stream) const |
Write object to the stream. More... | |
virtual bool | operator== (const StreamRef2< LT, CKT, CT, IT > &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator 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... | |
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) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
Static Public Member Functions | |
static FrameSpec::size_type | Bytes () |
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... | |
Protected Member Functions | |
virtual void | assign (IStringStream &Stream) |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const |
Down grade an object. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, IStream *Stream) const |
Upgrade an object. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
Generalized common elements of frame structure.
This templated implementation simplifies the actual implementation of the common elements of all frame structures by having each of the storage elements have a separate template parameter.
This implementation supports versions of the frame specification which require the chkType field.
LT | Data type for the length field. |
CKT | Data type for the chkType field. |
CT | Data type for the class field. |
IT | Data type for the instance field. |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef StreamRef2< LT, CKT, CT, IT> FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::self_type |
|
inherited |
FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::StreamRef2 | ( | ) |
Constructor.
|
virtual |
Destructor.
|
inlineprotectedvirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
inlinestatic |
|
virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtual |
constructor - virtual copy constructor
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, and FrameCPP::Version_4::FrTOC.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.
|
inlinevirtual |
constructor - virtual
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Down grade an object.
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. |
|
inlinevirtual |
|
inlinevirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
inlinevirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
inlinevirtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtual |
comparison operator
|
inlinevirtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Upgrade an object.
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. |
|
inherited |
|
inlinevirtual |
|
inlinevirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
inlinevirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
inlinevirtual |
Implements FrameCPP::Common::StreamRefInterface.
|
virtual |
Implements FrameCPP::Common::StreamRefInterface.
|
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_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
inlinevirtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
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. |