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

#include <FrHeader.hh>

Inheritance diagram for FrameCPP::Common::FrHeader:
FrameCPP::Version_3::FrHeader FrameCPP::Version_8::FrHeader

Public Types

enum  frame_library_type { FRAME_LIBRARY_UNKNOWN = 0, FRAME_LIBRARY_FRAMEL = 1, FRAME_LIBRARY_FRAMECPP = 2 }
 
typedef FR_HEADER__VERSION_TYPE version_type
 
typedef
FR_HEADER__LIBRARY_REVISION_TYPE 
library_revision_type
 
typedef CHAR * originator_type
 

Public Member Functions

 FrHeader (IStream &Stream)
 
 FrHeader (std::istringstream &Source)
 
virtual ~FrHeader ()
 
virtual cmn_streamsize_type Bytes () const
 
virtual bool ByteSwapping () const
 
virtual void Filter (StreamFilter &SFilter) const
 
frame_library_type GetFrameLibrary () const
 Retrieve the library used to generate the frame stream. More...
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream. More...
 
library_revision_type GetLibraryRevision () const
 
version_type GetVersion () const
 
originator_type GetOriginator () const
 
virtual bool IsValid () const
 
void SetLibraryVersion (INT_2U Version)
 Establish the version of the Library used. More...
 
void SetOriginator (const std::string &Originator)
 Establish the originator of the frame. More...
 
void SetVersion (INT_2U Version)
 Establish the version of the frame specification. More...
 
void Write (OStream &Stream) const
 
const FrHeaderoperator= (const FrHeader &Source)
 

Static Public Member Functions

static cmn_streamsize_type SizeOf ()
 
static std::string GetFrameLibraryName (frame_library_type LibraryId)
 Retrieve the library used to generate the frame stream. More...
 

Protected Member Functions

 FrHeader ()
 
 FrHeader (const FrHeader &Source)
 
virtual void complete ()
 Entry point to do extra processing. More...
 

Protected Attributes

frame_library_type m_frame_library
 

Member Typedef Documentation

typedef FR_HEADER__LIBRARY_REVISION_TYPE FrameCPP::Common::FrHeader::library_revision_type
typedef CHAR* FrameCPP::Common::FrHeader::originator_type
typedef FR_HEADER__VERSION_TYPE FrameCPP::Common::FrHeader::version_type

Member Enumeration Documentation

enum FrameCPP::Common::FrHeader::frame_library_type
Enumerator
FRAME_LIBRARY_UNKNOWN 
FRAME_LIBRARY_FRAMEL 
FRAME_LIBRARY_FRAMECPP 

Constructor & Destructor Documentation

FrameCPP::Common::FrHeader::FrHeader ( IStream Stream)
FrameCPP::Common::FrHeader::FrHeader ( std::istringstream &  Source)
FrameCPP::Common::FrHeader::~FrHeader ( )
inlinevirtual
FrameCPP::Common::FrHeader::FrHeader ( )
inlineprotected
FrameCPP::Common::FrHeader::FrHeader ( const FrHeader Source)
inlineprotected

Member Function Documentation

cmn_streamsize_type FrameCPP::Common::FrHeader::Bytes ( ) const
inlinevirtual
bool FrameCPP::Common::FrHeader::ByteSwapping ( ) const
virtual
void FrameCPP::Common::FrHeader::complete ( )
protectedvirtual

Entry point to do extra processing.

Reimplemented in FrameCPP::Version_8::FrHeader.

void FrameCPP::Common::FrHeader::Filter ( StreamFilter SFilter) const
inlinevirtual
FrHeader::frame_library_type FrameCPP::Common::FrHeader::GetFrameLibrary ( ) const
inline

Retrieve the library used to generate the frame stream.

std::string FrameCPP::Common::FrHeader::GetFrameLibraryName ( ) const
inline

Retrieve the library used to generate the frame stream.

std::string FrameCPP::Common::FrHeader::GetFrameLibraryName ( frame_library_type  LibraryId)
inlinestatic

Retrieve the library used to generate the frame stream.

FrHeader::library_revision_type FrameCPP::Common::FrHeader::GetLibraryRevision ( ) const
inline
FrHeader::originator_type FrameCPP::Common::FrHeader::GetOriginator ( ) const
inline
FrHeader::version_type FrameCPP::Common::FrHeader::GetVersion ( ) const
inline
bool FrameCPP::Common::FrHeader::IsValid ( ) const
virtual
const FrHeader & FrameCPP::Common::FrHeader::operator= ( const FrHeader Source)
inline
void FrameCPP::Common::FrHeader::SetLibraryVersion ( INT_2U  Version)
inline

Establish the version of the Library used.

void FrameCPP::Common::FrHeader::SetOriginator ( const std::string &  Originator)

Establish the originator of the frame.

void FrameCPP::Common::FrHeader::SetVersion ( INT_2U  Version)
inline

Establish the version of the frame specification.

cmn_streamsize_type FrameCPP::Common::FrHeader::SizeOf ( )
inlinestatic
void FrameCPP::Common::FrHeader::Write ( OStream Stream) const

Member Data Documentation

frame_library_type FrameCPP::Common::FrHeader::m_frame_library
protected

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