ldas-tools-framecpp 2.7.0
|
#include <FrEndOfFile.hh>
Public Member Functions | |
FrEndOfFile () | |
virtual | ~FrEndOfFile () |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual FrEndOfFile * | Clone () const |
constructor - virtual copy constructor | |
virtual FrEndOfFile * | Create (istream_type &Stream) const |
constructor - virtual | |
virtual nBytes_cmn_type | NBytes () const |
virtual nFrames_cmn_type | NFrames () const |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
bool | operator== (const FrEndOfFile &RHS) const |
comparison operator | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
nBytes_type | GetNBytes () const |
nFrames_type | GetNFrames () const |
chkSum_type | GetChkSum () const |
seekTOC_type | GetSeekTOC () const |
chkType_type | GetChkType () const |
virtual FrEndOfFile::seekTOC_cmn_type | SeekTOC () const |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify an object. | |
FrEndOfFile () | |
virtual | ~FrEndOfFile () |
virtual Common::FrameSpec::size_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual FrEndOfFile * | Clone () const |
constructor - virtual copy constructor | |
virtual FrEndOfFile * | Create (istream_type &Stream) const |
constructor - virtual | |
virtual nBytes_cmn_type | NBytes () const |
virtual nFrames_cmn_type | NFrames () const |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
bool | operator== (const FrEndOfFile &RHS) const |
comparison operator | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
nBytes_type | GetNBytes () const |
nFrames_type | GetNFrames () const |
chkSum_type | GetChkSum () const |
seekTOC_type | GetSeekTOC () const |
chkType_type | GetChkType () const |
virtual FrEndOfFile::seekTOC_cmn_type | SeekTOC () const |
virtual void | VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const |
Verify an object. | |
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 | |
virtual Object * | Create (std::istream &Buffer) 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) |
Static Public Attributes | |
static const Common::FrameSpec::Info::frame_object_types | s_object_id = Common::FrameSpec::Info::FSI_FR_END_OF_FILE |
Protected Member Functions | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
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 void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
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 | |
nFrames_type | m_nFrames |
nBytes_type | m_nBytes |
chkType_type | m_chkType |
chkSum_type | m_chkSum |
seekTOC_type | m_seekTOC |
Private Member Functions | |
FrEndOfFile (istream_type &Source) | |
chkSum_cmn_type | Filter (const istream_type &Stream, Common::CheckSum &Filt, chkType_cmn_type &Type, void *Buffer, INT_8U Size) const |
Filter a sequence of bytes. | |
FrEndOfFile (istream_type &Source) | |
chkSum_cmn_type | Filter (const istream_type &Stream, Common::CheckSum &Filt, chkType_cmn_type &Type, void *Buffer, INT_8U Size) const |
Filter a sequence of bytes. | |
Private Attributes | |
const class_type | m_class |
Storage for the class identifier. | |
const Description *const | m_desc |
Description for parent class. | |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef INT_4U FrameCPP::Version_6::FrEndOfFile::chkSum_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFile::chkSum_type |
|
inherited |
|
inherited |
typedef INT_4U FrameCPP::Version_6::FrEndOfFile::chkType_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFile::chkType_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef INT_8U FrameCPP::Version_6::FrEndOfFile::nBytes_type |
typedef INT_8U FrameCPP::Version_6::FrEndOfFile::nBytes_type |
|
inherited |
|
inherited |
typedef INT_4U FrameCPP::Version_6::FrEndOfFile::nFrames_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFile::nFrames_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef INT_8U FrameCPP::Version_6::FrEndOfFile::seekTOC_type |
typedef INT_8U FrameCPP::Version_6::FrEndOfFile::seekTOC_type |
|
inherited |
|
inherited |
FrameCPP::Version_6::FrEndOfFile::FrEndOfFile | ( | ) |
|
virtual |
Reimplemented from FrameCPP::Common::FrEndOfFile.
|
private |
FrameCPP::Version_6::FrEndOfFile::FrEndOfFile | ( | ) |
|
virtual |
Reimplemented from FrameCPP::Common::FrEndOfFile.
|
private |
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
Implements FrameCPP::Common::FrEndOfFile.
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
Implements FrameCPP::Common::FrEndOfFile.
|
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 |
constructor - virtual copy constructor
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
constructor - virtual copy constructor
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
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.
|
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::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_3::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_8::FrHeader.
|
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. |
|
privatevirtual |
Filter a sequence of bytes.
[in] | Stream | The input stream for Buffer. |
[in,out] | Filt | The filter action to apply to Buffer. |
[in] | Buffer | The sequence of bytes to be filter. |
[in] | Size | The number of bytes in Buffer. |
Implements FrameCPP::Common::FrEndOfFile.
|
privatevirtual |
Filter a sequence of bytes.
[in] | Stream | The input stream for Buffer. |
[in,out] | Filt | The filter action to apply to Buffer. |
[in] | Buffer | The sequence of bytes to be filter. |
[in] | Size | The number of bytes in Buffer. |
Implements FrameCPP::Common::FrEndOfFile.
|
inline |
chkSum_type FrameCPP::Version_6::FrEndOfFile::GetChkSum | ( | ) | const |
|
inline |
chkType_type FrameCPP::Version_6::FrEndOfFile::GetChkType | ( | ) | const |
|
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.
|
inline |
nBytes_type FrameCPP::Version_6::FrEndOfFile::GetNBytes | ( | ) | const |
|
inline |
nFrames_type FrameCPP::Version_6::FrEndOfFile::GetNFrames | ( | ) | const |
|
inline |
seekTOC_type FrameCPP::Version_6::FrEndOfFile::GetSeekTOC | ( | ) | const |
|
virtual |
Implements FrameCPP::Common::FrEndOfFile.
|
virtual |
Implements FrameCPP::Common::FrEndOfFile.
|
virtual |
Implements FrameCPP::Common::FrEndOfFile.
|
virtual |
Implements FrameCPP::Common::FrEndOfFile.
|
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.
bool FrameCPP::Version_6::FrEndOfFile::operator== | ( | const FrEndOfFile & | RHS | ) | const |
comparison operator
bool FrameCPP::Version_6::FrEndOfFile::operator== | ( | const FrEndOfFile & | RHS | ) | const |
comparison operator
|
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 |
|
inlinevirtual |
Returns the file position of the start of the table of contents. If the stream has no table of contents, the value of zero is returned.
Reimplemented from FrameCPP::Common::FrEndOfFile.
|
virtual |
Returns the file position of the start of the table of contents. If the stream has no table of contents, the value of zero is returned.
Reimplemented from FrameCPP::Common::FrEndOfFile.
|
static |
|
static |
|
inlinestatic |
|
static |
|
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 object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
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. |
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
protected |
|
protected |
|
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.
|
privateinherited |
Description for parent class.
The description for the parent class composed of one FrSH and one or more FrSE elements.
|
protected |
|
protected |
|
protected |
|
static |