ldas-tools-framecpp 2.7.0
|
Implementation of the frame header structure. More...
#include <FrHeader.hh>
Classes | |
union | FrHeader_type |
Public Member Functions | |
FrHeader () | |
Constructor. | |
virtual | ~FrHeader () |
Desctructor. | |
virtual FrHeader * | Clone () const |
Copy Constructor (virtual) | |
const unsigned char * | Get8ByteEndianness () const |
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 |
Calculate the streaming size of the object. | |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Calculate the streaming size of the object. | |
virtual bool | ByteSwapping () const |
Check if byte swapping is needed. | |
checksum_type | Checksum () const |
virtual const Common::FrameSpec::Object * | Description () const |
Retrieve the objects stream description. | |
virtual FrHeader * | Create (istream_type &Stream) const |
Constructor ( virtual ) | |
virtual FrHeader * | Create (std::istream &Stream) const |
Constructor ( virtual ) | |
void | Filter (Common::StreamFilter &SFilter) const |
Perform the filter over the bytes streamed. | |
virtual const char * | ObjectStructName () const |
Retrieve the name of the frame structure. | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Perform verification of the object. | |
void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
FrHeader () | |
Constructor. | |
virtual | ~FrHeader () |
Desctructor. | |
virtual FrHeader * | Clone () const |
Copy Constructor (virtual) | |
const unsigned char * | Get8ByteEndianness () const |
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 |
Calculate the streaming size of the object. | |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Calculate the streaming size of the object. | |
virtual bool | ByteSwapping () const |
Check if byte swapping is needed. | |
checksum_type | Checksum () const |
virtual const Common::FrameSpec::Object * | Description () const |
Retrieve the objects stream description. | |
virtual FrHeader * | Create (istream_type &Stream) const |
Constructor ( virtual ) | |
virtual FrHeader * | Create (std::istream &Stream) const |
Constructor ( virtual ) | |
void | Filter (Common::StreamFilter &SFilter) const |
Perform the filter over the bytes streamed. | |
virtual const char * | ObjectStructName () const |
Retrieve the name of the frame structure. | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Perform verification of the object. | |
void | Write (ostream_type &Stream) const |
Write object to the 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. | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
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, IStream *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. | |
void | Write (OStream &Stream) const |
Static Public Member Functions | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_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, istream_type *Stream) |
Upgrade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_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, istream_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" |
File type. | |
Protected Member Functions | |
FrHeader (const FrHeader &Source) | |
Copy Constructor. | |
FrHeader (std::istream &Source) | |
virtual void | complete () |
calculate values since the object is now complete | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Upgrade an object. | |
FrHeader (const FrHeader &Source) | |
Copy Constructor. | |
FrHeader (std::istream &Source) | |
virtual void | complete () |
calculate values since the object is now complete | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Upgrade an object. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
Protected Attributes | |
frame_library_type | m_frame_library |
Private Member Functions | |
FrHeader (istream_type &Stream) | |
Constructor. | |
FrHeader (istream_type &Stream) | |
Constructor. | |
void | initialize (std::istream &Source) |
Initialize the class. | |
void | initialize (std::istream &Source) |
Initialize the class. | |
Private Attributes | |
union FrameCPP::Version_8::FrHeader::FrHeader_type | m_data |
bool | m_reorder_bytes |
State of reordering. | |
int | m_byte_order |
FrEndOfFile::chkSumFrHeader_type | m_checksum |
Object checksum. | |
INT_4U | m_checksum_value |
const class_type | m_class |
Storage for the class identifier. | |
const Description *const | m_desc |
Description for parent class. | |
Static Private Attributes | |
static const Common::FrameSpec::Info::frame_object_types | s_object_id = Common::FrameSpec::Info::FSI_FR_HEADER |
Implementation of the frame header structure.
This structure is described in section 4.3.1 of the frame specification. Its purpose is to provide a table of standard information in the host order so the reader can determine what translations need to occur.
typedef FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrHeader::checksum_type |
typedef FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrHeader::checksum_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
anonymous enum |
Libraries known to implement the frame specification.
This enumeration is intended to supply a unique identity for each library implementing the frame specification. This information along with the version of the library and the frame specification, uniquely identifies an implementation of the frame specification and can be used to code around problems with the implementation.
anonymous enum |
Libraries known to implement the frame specification.
This enumeration is intended to supply a unique identity for each library implementing the frame specification. This information along with the version of the library and the frame specification, uniquely identifies an implementation of the frame specification and can be used to code around problems with the implementation.
|
inherited |
|
inherited |
FrHeader::FrHeader | ( | ) |
Constructor.
|
virtual |
Desctructor.
Reimplemented from FrameCPP::Common::FrHeader.
|
protected |
Copy Constructor.
|
protected |
|
private |
Constructor.
Stream | Create an instance of the object from an input stream. |
FrameCPP::Version_8::FrHeader::FrHeader | ( | ) |
Constructor.
|
virtual |
Desctructor.
Reimplemented from FrameCPP::Common::FrHeader.
|
protected |
Copy Constructor.
|
protected |
|
private |
Constructor.
Stream | Create an instance of the object from an input stream. |
|
virtual |
Calculate the streaming size of the object.
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Calculate the streaming size of the object.
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Calculate the streaming size of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Calculate the streaming size of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Check if byte swapping is needed.
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Check if byte swapping is needed.
Reimplemented from FrameCPP::Common::FrHeader.
|
inline |
Retieve the value of the checksum associated with this FrHeader structure.
checksum_type FrameCPP::Version_8::FrHeader::Checksum | ( | ) | const |
|
virtual |
Copy Constructor (virtual)
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Copy Constructor (virtual)
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
calculate values since the object is now complete
Reimplemented from FrameCPP::Common::FrHeader.
|
protectedvirtual |
calculate values since the object is now complete
Reimplemented from FrameCPP::Common::FrHeader.
|
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::FrStatData, 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::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::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_4::FrTOC, and FrameCPP::Version_6::FrTOC.
|
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 |
Retrieve the objects stream description.
|
virtual |
Retrieve the objects stream description.
|
inlinevirtual |
Perform the filter over the bytes streamed.
[in] | SFilter | Filter to be applied to the stream. |
This performs the filtering operation over the raw bytes of the structure. A typical use would be to calculate the CRC checksum of this object.
Reimplemented from FrameCPP::Common::FrHeader.
|
virtual |
Perform the filter over the bytes streamed.
[in] | SFilter | Filter to be applied to the stream. |
Reimplemented from FrameCPP::Common::FrHeader.
|
inline |
Buffer holding the endian bytes for an 8 byte quantity.
const unsigned char * FrameCPP::Version_8::FrHeader::Get8ByteEndianness | ( | ) | const |
Buffer holding the endian bytes for an 8 byte quantity.
|
inline |
Return the byte order of the frame.
int FrameCPP::Version_8::FrHeader::GetByteOrder | ( | ) | const |
Return the byte order of the frame.
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Retrieve the class identifier.
|
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.
|
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 name of the frame structure.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Retrieve the name of the frame structure.
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 |
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. |
|
inherited |
|
inlineinherited |
Establish the version of the Library used.
|
inherited |
Establish the version of the Library used.
void FrameCPP::Version_8::FrHeader::SetOriginator | ( | const std::string & | Originator | ) |
Establish the originator of the frame.
void FrameCPP::Version_8::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 |
Perform verification of the object.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Perform verification of the object.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
|
virtual |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write object to the 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. |
|
private |
|
mutableprivate |
Object checksum.
This is the storage space for the checksum associated with the FrHeader structure. It is calculated at the beginning and written at the end as part of the FrEndOfFile structure.
|
private |
The checksum as calculated from reading the object from the stream.
|
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 |
State of reordering.
This variable is true if the stream endianness is not the same as the host endianness.
|
static |
File type.
The string "IGWD" to identify the file as an Interferometric Gravitational Wave Detectors frame file.
|
staticprivate |