ldas-tools-framecpp
2.7.0
|
End of File data structure. More...
#include <FrEndOfFile.hh>
Inherits FrameCPP::Common::FrEndOfFile, and FrameCPP::Common::FrEndOfFile.
Public Member Functions | |
FrEndOfFile () | |
Default constructor. More... | |
virtual | ~FrEndOfFile () |
Destructor. | |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrEndOfFile * | Clone () const |
Virtual copy constructor. | |
virtual FrEndOfFile * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual nBytes_cmn_type | NBytes () const |
Retrieve the expected size of the stream. | |
virtual nFrames_cmn_type | NFrames () const |
Retrieve the number of frames in the stream. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual void | Write (ostream_type &Stream) const |
Write the structure to the stream. More... | |
bool | operator== (const FrEndOfFile &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
FrEndOfFile::chkSum_type | GetChkSum () const |
Retrieve the checksum. More... | |
FrEndOfFile::chkSumFile_type | GetChkSumFile () const |
Retrieve the file checksum. More... | |
FrEndOfFile::chkSumFrHeader_type | GetChkSumFrHeader () const |
Retrieve the FrHeader checksum. More... | |
FrEndOfFile::nBytes_type | GetNBytes () const |
Retrieve the total number of bytes in this file. More... | |
FrEndOfFile::nFrames_type | GetNFrames () const |
Retrieve the number of frames in this file. More... | |
FrEndOfFile::seekTOC_type | GetSeekTOC () const |
Retrieve the location of the table of contents. More... | |
virtual FrEndOfFile::seekTOC_cmn_type | SeekTOC () const |
Retrieve the location of the table of contents. More... | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify the object. | |
FrEndOfFile () | |
Default constructor. More... | |
virtual | ~FrEndOfFile () |
Destructor. | |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrEndOfFile * | Clone () const |
Virtual copy constructor. | |
virtual FrEndOfFile * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual nBytes_cmn_type | NBytes () const |
Retrieve the expected size of the stream. | |
virtual nFrames_cmn_type | NFrames () const |
Retrieve the number of frames in the stream. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
virtual void | Write (ostream_type &Stream) const |
Write the structure to the stream. More... | |
bool | operator== (const FrEndOfFile &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
FrEndOfFile::chkSum_type | GetChkSum () const |
Retrieve the checksum. More... | |
FrEndOfFile::chkSumFile_type | GetChkSumFile () const |
Retrieve the file checksum. More... | |
FrEndOfFile::chkSumFrHeader_type | GetChkSumFrHeader () const |
Retrieve the FrHeader checksum. More... | |
FrEndOfFile::nBytes_type | GetNBytes () const |
Retrieve the total number of bytes in this file. More... | |
FrEndOfFile::nFrames_type | GetNFrames () const |
Retrieve the number of frames in this file. More... | |
FrEndOfFile::seekTOC_type | GetSeekTOC () const |
Retrieve the location of the table of contents. More... | |
virtual FrEndOfFile::seekTOC_cmn_type | SeekTOC () const |
Retrieve the location of the table of contents. More... | |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify the object. | |
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... | |
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 | |
Static Public Member Functions | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. 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... | |
Protected Member Functions | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. More... | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *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. | |
Protected Attributes | |
nFrames_type | m_nFrames |
Number of frames in this file. | |
nBytes_type | m_nBytes |
Total number of bytes in the file; zero if not computed. | |
seekTOC_type | m_seekTOC |
chkSumFrHeader_type | m_chkSumFrHeader |
FrHeader checksum. | |
chkSum_type | m_chkSum |
chkSumFile_type | m_chkSumFile |
File checksum. | |
End of File data structure.
FrameCPP::Version_8::FrEndOfFile::FrEndOfFile | ( | ) |
Default constructor.
FrameCPP::Version_8::FrEndOfFile::FrEndOfFile | ( | ) |
Default constructor.
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
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 |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being 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. |
|
inline |
Retrieve the checksum.
FrEndOfFile::chkSum_type FrameCPP::Version_8::FrEndOfFile::GetChkSum | ( | ) | const |
Retrieve the checksum.
|
inline |
Retrieve the file checksum.
FrEndOfFile::chkSumFile_type FrameCPP::Version_8::FrEndOfFile::GetChkSumFile | ( | ) | const |
Retrieve the file checksum.
|
inline |
Retrieve the FrHeader checksum.
FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFile::GetChkSumFrHeader | ( | ) | const |
Retrieve the FrHeader checksum.
|
inlineinherited |
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.
|
inline |
Retrieve the total number of bytes in this file.
FrEndOfFile::nBytes_type FrameCPP::Version_8::FrEndOfFile::GetNBytes | ( | ) | const |
Retrieve the total number of bytes in this file.
|
inline |
Retrieve the number of frames in this file.
FrEndOfFile::nFrames_type FrameCPP::Version_8::FrEndOfFile::GetNFrames | ( | ) | const |
Retrieve the number of frames in this file.
|
inline |
Retrieve the location of the table of contents.
FrEndOfFile::seekTOC_type FrameCPP::Version_8::FrEndOfFile::GetSeekTOC | ( | ) | const |
Retrieve the location of the table of contents.
|
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.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
bool FrameCPP::Version_8::FrEndOfFile::operator== | ( | const FrEndOfFile & | RHS | ) | const |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
bool FrameCPP::Version_8::FrEndOfFile::operator== | ( | const FrEndOfFile & | RHS | ) | const |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
|
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. |
|
inlinevirtual |
Retrieve the location of the table of contents.
|
virtual |
Retrieve the location of the table of contents.
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
|
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. |
|
protected |
Structure checksum.
|
protected |
Bytes to back up to the Beginning of the table of contents structure. If seekTOC is zero, then there is no table of contents for this file.