ldas-tools-framecpp 3.0.4
|
#include <FrHeader.hh>
Classes | |
union | FrHeader_type |
Public Member Functions | |
FrHeader () | |
virtual | ~FrHeader () |
virtual FrHeader * | Clone () const |
constructor - virtual copy constructor | |
const unsigned char * | Get8ByteEndianness () const |
Retrieve the buffer holding the endian bytes for an 8 byte quantity. | |
int | GetByteOrder () const |
Return the byte order of the frame. | |
void | SetOriginator (const std::string &Originator) |
Establish the originator of the frame. | |
virtual Common::FrameSpec::size_type | Bytes () const |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual bool | ByteSwapping () const |
virtual const Common::FrameSpec::Object * | Description () const |
virtual FrHeader * | Create (istream_type &Stream) const |
Constructor - virtual. | |
virtual FrHeader * | Create (std::istream &Stream) const |
Constructor - virtual. | |
void | Filter (Common::StreamFilter &SFilter) const |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify an object. | |
void | Write (Common::OStream &Stream) const |
Write Header to stream. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
FrHeader () | |
virtual | ~FrHeader () |
virtual FrHeader * | Clone () const |
constructor - virtual copy constructor | |
const unsigned char * | Get8ByteEndianness () const |
Retrieve the buffer holding the endian bytes for an 8 byte quantity. | |
int | GetByteOrder () const |
Return the byte order of the frame. | |
void | SetOriginator (const std::string &Originator) |
Establish the originator of the frame. | |
virtual Common::FrameSpec::size_type | Bytes () const |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual bool | ByteSwapping () const |
virtual const Common::FrameSpec::Object * | Description () const |
virtual FrHeader * | Create (istream_type &Stream) const |
Constructor - virtual. | |
virtual FrHeader * | Create (std::istream &Stream) const |
Constructor - virtual. | |
void | Filter (Common::StreamFilter &SFilter) const |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify an object. | |
void | Write (Common::OStream &Stream) const |
Write Header to stream. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
class_type | GetClass () const |
Retrieve the class identifier. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
virtual const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
virtual const Description * | GetDescription (ostream_type &Stream) const |
virtual const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
virtual const Description * | GetDescription (ostream_type &Stream) const |
frame_spec_version_type | FrameSpecVersion () const |
frame_spec_version_type | FrameSpecVersion () const |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
virtual Object * | Create () const |
constructor - virtual | |
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, promote_stream_type *Stream) |
frame_library_type | GetFrameLibrary () const |
Retrieve the library used to generate the frame stream. | |
frame_library_type | GetFrameLibrary () const |
Retrieve the library used to generate the frame stream. | |
std::string | GetFrameLibraryName () const |
Retrieve the library used to generate the frame stream. | |
std::string | GetFrameLibraryName () const |
Retrieve the library used to generate the frame stream. | |
library_revision_type | GetLibraryRevision () const |
library_revision_type | GetLibraryRevision () const |
version_type | GetVersion () const |
version_type | GetVersion () const |
originator_type | GetOriginator () const |
originator_type | GetOriginator () const |
virtual bool | IsValid () const |
virtual bool | IsValid () const |
void | SetLibraryVersion (INT_2U Version) |
Establish the version of the Library used. | |
void | SetLibraryVersion (INT_2U Version) |
Establish the version of the Library used. | |
void | SetVersion (INT_2U Version) |
Establish the version of the frame specification. | |
void | SetVersion (INT_2U Version) |
Establish the version of the frame specification. |
Static Public Member Functions | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream) |
Down grade an object. | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream) |
Down grade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
template<typename PreviousType, typename CurrentType> | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
template<typename PreviousType, typename CurrentType> | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
static cmn_streamsize_type | SizeOf () |
static cmn_streamsize_type | SizeOf () |
static std::string | GetFrameLibraryName (frame_library_type LibraryId) |
Retrieve the library used to generate the frame stream. | |
static std::string | GetFrameLibraryName (frame_library_type LibraryId) |
Retrieve the library used to generate the frame stream. |
Static Public Attributes | |
static const char * | ORIGINATOR_IGWD = "IGWD" |
Protected Member Functions | |
FrHeader (const FrHeader &Source) | |
FrHeader (std::istream &Source) | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type, promote_stream_type *Stream) const |
Upgrade an object. | |
FrHeader (const FrHeader &Source) | |
FrHeader (std::istream &Source) | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type, promote_stream_type *Stream) const |
Upgrade an object. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual void | complete () |
Entry point to do extra processing. | |
virtual void | complete () |
Entry point to do extra processing. |
Protected Attributes | |
frame_library_type | m_frame_library |
Private Member Functions | |
FrHeader (istream_type &Stream) | |
FrHeader (istream_type &Stream) | |
void | initialize (std::istream &Source) |
Initialize the class. | |
void | initialize (std::istream &Source) |
Initialize the class. |
Private Attributes | |
union FrameCPP::Version_3::FrHeader::FrHeader_type | m_data |
bool | m_reorder_bytes |
int | m_byte_order |
const class_type | m_class |
Storage for the class identifier. | |
const Description *const | m_desc |
Description for parent class. | |
const frame_spec_version_type | frame_spec_version |
Version of the frame specification. |
Static Private Attributes | |
static const Common::FrameSpec::Info::frame_object_types | s_object_id = Common::FrameSpec::Info::FSI_FR_HEADER |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrHeader::FrHeader | ( | ) |
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
protected |
|
protected |
|
private |
FrameCPP::Version_3::FrHeader::FrHeader | ( | ) |
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
protected |
|
protected |
|
private |
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
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.
|
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.
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
constructor - virtual copy constructor
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
constructor - virtual copy constructor
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtualinherited |
Entry point to do extra processing.
Reimplemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.
|
protectedvirtualinherited |
Entry point to do extra processing.
Reimplemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, and FrVect.
|
virtual |
Constructor - virtual.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Constructor - virtual.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Constructor - virtual.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Constructor - virtual.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Down grade an object.
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. |
|
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. |
|
virtual |
|
virtual |
|
inlinevirtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Reimplemented from FrameCPP::Common::FrHeader.
|
inlineinherited |
|
inherited |
|
inline |
Retrieve the buffer holding the endian bytes for an 8 byte quantity.
const unsigned char * FrameCPP::Version_3::FrHeader::Get8ByteEndianness | ( | ) | const |
Retrieve the buffer holding the endian bytes for an 8 byte quantity.
|
inline |
Return the byte order of the frame.
int FrameCPP::Version_3::FrHeader::GetByteOrder | ( | ) | const |
Return the byte order of the frame.
|
inlineinherited |
Retrieve the class identifier.
|
inherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
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 |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
Reimplemented in FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, and FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >.
|
virtualinherited |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
Reimplemented in FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, and FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >.
|
inlineinherited |
Retrieve the library used to generate the frame stream.
|
inherited |
Retrieve the library used to generate the frame stream.
|
inlineinherited |
Retrieve the library used to generate the frame stream.
|
inherited |
Retrieve the library used to generate the frame stream.
|
inlinestaticinherited |
Retrieve the library used to generate the frame stream.
|
staticinherited |
Retrieve the library used to generate the frame stream.
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
privateinherited |
Initialize the class.
[in,out] | Source | The source stream from which to initialize the instance. |
|
privateinherited |
Initialize the class.
[in,out] | Source | The source stream from which to initialize the instance. |
|
virtualinherited |
|
virtualinherited |
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Upgrade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Upgrade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inherited |
|
inlineinherited |
Establish the version of the Library used.
|
inherited |
Establish the version of the Library used.
void FrameCPP::Version_3::FrHeader::SetOriginator | ( | const std::string & | Originator | ) |
Establish the originator of the frame.
void FrameCPP::Version_3::FrHeader::SetOriginator | ( | const std::string & | Originator | ) |
Establish the originator of the frame.
|
inlineinherited |
Establish the version of the frame specification.
|
inherited |
Establish the version of the frame specification.
|
inlinestaticinherited |
|
staticinherited |
|
virtual |
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 from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
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 from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write Header to stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write Header to stream.
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. |
|
privateinherited |
Version of the frame specification.
The version of the frame specification for which this object was created.
|
private |
|
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.
|
private |
|
privateinherited |
Description for parent class.
The description for the parent class composed of one FrSH and one or more FrSE elements.
|
protectedinherited |
|
private |
|
static |
|
staticprivate |