ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_6::FrEndOfFile Class Reference

#include <FrEndOfFile.hh>

Inheritance diagram for FrameCPP::Version_6::FrEndOfFile:
FrameCPP::Common::FrEndOfFile FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef INT_4U nFrames_type
 
typedef INT_8U nBytes_type
 
typedef INT_4U chkType_type
 
typedef INT_4U chkSum_type
 
typedef INT_8U seekTOC_type
 
typedef INT_8U nBytes_cmn_type
 
typedef INT_8U seekTOC_cmn_type
 
typedef INT_4U chkType_cmn_type
 
typedef INT_4U chkSum_cmn_type
 
typedef IStringStream assign_stream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef
LDASTools::AL::SharedPtr
< Object
object_type
 
typedef std::unique_ptr< Objectunique_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

 FrEndOfFile ()
 
virtual ~FrEndOfFile ()
 
virtual
Common::FrameSpec::size_type 
Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrEndOfFileClone () const
 constructor - virtual copy constructor More...
 
virtual FrEndOfFileCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual nBytes_cmn_type NBytes () const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
bool operator== (const FrEndOfFile &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
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. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (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)
 

Static Public Member Functions

static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
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 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. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

nFrames_type m_nFrames
 
nBytes_type m_nBytes
 
chkType_type m_chkType
 
chkSum_type m_chkSum
 
seekTOC_type m_seekTOC
 

Member Typedef Documentation

typedef IStringStream FrameCPP::Common::FrEndOfFile::assign_stream_type
inherited
typedef LDASTools::AL::SharedPtr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

Constructor & Destructor Documentation

FrameCPP::Version_6::FrEndOfFile::FrEndOfFile ( )
FrameCPP::Version_6::FrEndOfFile::~FrEndOfFile ( )
virtual

Reimplemented from FrameCPP::Common::FrEndOfFile.

Member Function Documentation

void FrameCPP::Version_6::FrEndOfFile::assign ( assign_stream_type Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

Implements FrameCPP::Common::FrEndOfFile.

FrameSpec::size_type FrameCPP::Version_6::FrEndOfFile::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrEndOfFile * FrameCPP::Version_6::FrEndOfFile::Clone ( ) const
virtual

constructor - virtual copy constructor

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

FrEndOfFile * FrameCPP::Version_6::FrEndOfFile::Create ( istream_type Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited
FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

FrEndOfFile::demote_ret_type FrameCPP::Version_6::FrEndOfFile::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.
FrEndOfFile::chkSum_type FrameCPP::Version_6::FrEndOfFile::GetChkSum ( ) const
inline
FrEndOfFile::chkType_type FrameCPP::Version_6::FrEndOfFile::GetChkType ( ) const
inline
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrEndOfFile::nBytes_type FrameCPP::Version_6::FrEndOfFile::GetNBytes ( ) const
inline
FrEndOfFile::nFrames_type FrameCPP::Version_6::FrEndOfFile::GetNFrames ( ) const
inline
FrEndOfFile::seekTOC_type FrameCPP::Version_6::FrEndOfFile::GetSeekTOC ( ) const
inline
FrEndOfFile::nBytes_cmn_type FrameCPP::Version_6::FrEndOfFile::NBytes ( ) const
virtual
const char * FrameCPP::Version_6::FrEndOfFile::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

bool FrameCPP::Version_6::FrEndOfFile::operator== ( const FrEndOfFile RHS) const

comparison operator

bool FrameCPP::Version_6::FrEndOfFile::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrEndOfFile::promote_ret_type FrameCPP::Version_6::FrEndOfFile::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.
template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited
Common::FrEndOfFile::seekTOC_cmn_type FrameCPP::Version_6::FrEndOfFile::SeekTOC ( ) const
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.

const Description * FrameCPP::Version_6::FrEndOfFile::StructDescription ( )
static
const char * FrameCPP::Version_6::FrEndOfFile::StructName ( )
inlinestatic
void FrameCPP::Version_6::FrEndOfFile::VerifyObject ( Common::Verify Verifier,
Common::IFrameStream Stream 
) const
virtual

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

void FrameCPP::Version_6::FrEndOfFile::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

chkSum_type FrameCPP::Version_6::FrEndOfFile::m_chkSum
protected
chkType_type FrameCPP::Version_6::FrEndOfFile::m_chkType
protected
nBytes_type FrameCPP::Version_6::FrEndOfFile::m_nBytes
protected
nFrames_type FrameCPP::Version_6::FrEndOfFile::m_nFrames
protected
seekTOC_type FrameCPP::Version_6::FrEndOfFile::m_seekTOC
protected
const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_6::FrEndOfFile::s_object_id = Common::FrameSpec::Info::FSI_FR_END_OF_FILE
static

The documentation for this class was generated from the following files: