ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
FrameCPP::Common::FrHeader Class Reference

#include <FrHeader.hh>

Inheritance diagram for FrameCPP::Common::FrHeader:
Inheritance graph
[legend]

Classes

union  data_type
 

Public Types

enum  frame_library_type {
  FRAME_LIBRARY_UNKNOWN = 0 , FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2 , FRAME_LIBRARY_UNKNOWN = 0 ,
  FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2
}
 
enum  frame_library_type {
  FRAME_LIBRARY_UNKNOWN = 0 , FRAME_LIBRARY_FRAMEL = 1 , FRAME_LIBRARY_FRAMECPP = 2 , 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
 
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.
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream.
 
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.
 
void SetOriginator (const std::string &Originator)
 Establish the originator of the frame.
 
void SetVersion (INT_2U Version)
 Establish the version of the frame specification.
 
void Write (OStream &Stream) const
 
const FrHeader & operator= (const FrHeader &Source)
 
 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.
 
std::string GetFrameLibraryName () const
 Retrieve the library used to generate the frame stream.
 
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.
 
void SetOriginator (const std::string &Originator)
 Establish the originator of the frame.
 
void SetVersion (INT_2U Version)
 Establish the version of the frame specification.
 
void Write (OStream &Stream) const
 
const FrHeader & operator= (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.
 
static cmn_streamsize_type SizeOf ()
 
static std::string GetFrameLibraryName (frame_library_type LibraryId)
 Retrieve the library used to generate the frame stream.
 

Protected Member Functions

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

Protected Attributes

frame_library_type m_frame_library
 

Private Member Functions

void initialize (std::istream &Source)
 Initialize the class.
 
void initialize (std::istream &Source)
 Initialize the class.
 

Private Attributes

data_type m_data
 

Member Typedef Documentation

◆ library_revision_type [1/2]

typedef FR_HEADER__LIBRARY_REVISION_TYPE FrameCPP::Common::FrHeader::library_revision_type

◆ library_revision_type [2/2]

typedef FR_HEADER__LIBRARY_REVISION_TYPE FrameCPP::Common::FrHeader::library_revision_type

◆ originator_type [1/2]

typedef CHAR* FrameCPP::Common::FrHeader::originator_type

◆ originator_type [2/2]

typedef CHAR* FrameCPP::Common::FrHeader::originator_type

◆ version_type [1/2]

typedef FR_HEADER__VERSION_TYPE FrameCPP::Common::FrHeader::version_type

◆ version_type [2/2]

typedef FR_HEADER__VERSION_TYPE FrameCPP::Common::FrHeader::version_type

Member Enumeration Documentation

◆ frame_library_type [1/2]

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

◆ frame_library_type [2/2]

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

Constructor & Destructor Documentation

◆ FrHeader() [1/8]

FrHeader::FrHeader ( IStream & Stream)

◆ FrHeader() [2/8]

FrHeader::FrHeader ( std::istringstream & Source)

◆ ~FrHeader() [1/2]

FrHeader::~FrHeader ( )
inlinevirtual

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

◆ FrHeader() [3/8]

FrHeader::FrHeader ( )
inlineprotected

◆ FrHeader() [4/8]

FrHeader::FrHeader ( const FrHeader & Source)
inlineprotected

◆ FrHeader() [5/8]

FrameCPP::Common::FrHeader::FrHeader ( IStream & Stream)

◆ FrHeader() [6/8]

FrameCPP::Common::FrHeader::FrHeader ( std::istringstream & Source)

◆ ~FrHeader() [2/2]

virtual FrameCPP::Common::FrHeader::~FrHeader ( )
virtual

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

◆ FrHeader() [7/8]

FrameCPP::Common::FrHeader::FrHeader ( )
protected

◆ FrHeader() [8/8]

FrameCPP::Common::FrHeader::FrHeader ( const FrHeader & Source)
protected

Member Function Documentation

◆ Bytes() [1/2]

cmn_streamsize_type FrHeader::Bytes ( ) const
inlinevirtual

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

◆ Bytes() [2/2]

virtual cmn_streamsize_type FrameCPP::Common::FrHeader::Bytes ( ) const
virtual

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

◆ ByteSwapping() [1/2]

bool FrHeader::ByteSwapping ( ) const
virtual

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

◆ ByteSwapping() [2/2]

virtual bool FrameCPP::Common::FrHeader::ByteSwapping ( ) const
virtual

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

◆ complete() [1/2]

void FrHeader::complete ( )
protectedvirtual

Entry point to do extra processing.

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

◆ complete() [2/2]

virtual void FrameCPP::Common::FrHeader::complete ( )
protectedvirtual

Entry point to do extra processing.

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

◆ Filter() [1/2]

void FrHeader::Filter ( StreamFilter & SFilter) const
inlinevirtual

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

◆ Filter() [2/2]

virtual void FrameCPP::Common::FrHeader::Filter ( StreamFilter & SFilter) const
virtual

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

◆ GetFrameLibrary() [1/2]

FrHeader::frame_library_type FrHeader::GetFrameLibrary ( ) const
inline

Retrieve the library used to generate the frame stream.

◆ GetFrameLibrary() [2/2]

frame_library_type FrameCPP::Common::FrHeader::GetFrameLibrary ( ) const

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [1/4]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [2/4]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [3/4]

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

Retrieve the library used to generate the frame stream.

◆ GetFrameLibraryName() [4/4]

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

Retrieve the library used to generate the frame stream.

◆ GetLibraryRevision() [1/2]

FrHeader::library_revision_type FrHeader::GetLibraryRevision ( ) const
inline

◆ GetLibraryRevision() [2/2]

library_revision_type FrameCPP::Common::FrHeader::GetLibraryRevision ( ) const

◆ GetOriginator() [1/2]

FrHeader::originator_type FrHeader::GetOriginator ( ) const
inline

◆ GetOriginator() [2/2]

originator_type FrameCPP::Common::FrHeader::GetOriginator ( ) const

◆ GetVersion() [1/2]

FrHeader::version_type FrHeader::GetVersion ( ) const
inline

◆ GetVersion() [2/2]

version_type FrameCPP::Common::FrHeader::GetVersion ( ) const

◆ initialize() [1/2]

void FrHeader::initialize ( std::istream & Source)
private

Initialize the class.

Parameters
[in,out]SourceThe source stream from which to initialize the instance.

◆ initialize() [2/2]

void FrameCPP::Common::FrHeader::initialize ( std::istream & Source)
private

Initialize the class.

Parameters
[in,out]SourceThe source stream from which to initialize the instance.

◆ IsValid() [1/2]

bool FrHeader::IsValid ( ) const
virtual

◆ IsValid() [2/2]

virtual bool FrameCPP::Common::FrHeader::IsValid ( ) const
virtual

◆ operator=() [1/2]

const FrHeader & FrHeader::operator= ( const FrHeader & Source)
inline

◆ operator=() [2/2]

const FrHeader & FrameCPP::Common::FrHeader::operator= ( const FrHeader & Source)

◆ SetLibraryVersion() [1/2]

void FrHeader::SetLibraryVersion ( INT_2U Version)
inline

Establish the version of the Library used.

◆ SetLibraryVersion() [2/2]

void FrameCPP::Common::FrHeader::SetLibraryVersion ( INT_2U Version)

Establish the version of the Library used.

◆ SetOriginator() [1/2]

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

Establish the originator of the frame.

◆ SetOriginator() [2/2]

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

Establish the originator of the frame.

◆ SetVersion() [1/2]

void FrHeader::SetVersion ( INT_2U Version)
inline

Establish the version of the frame specification.

◆ SetVersion() [2/2]

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

Establish the version of the frame specification.

◆ SizeOf() [1/2]

cmn_streamsize_type FrHeader::SizeOf ( )
inlinestatic

◆ SizeOf() [2/2]

static cmn_streamsize_type FrameCPP::Common::FrHeader::SizeOf ( )
static

◆ Write() [1/2]

void FrHeader::Write ( OStream & Stream) const

◆ Write() [2/2]

void FrameCPP::Common::FrHeader::Write ( OStream & Stream) const

Member Data Documentation

◆ m_data

data_type FrHeader::m_data
private

◆ m_frame_library

frame_library_type FrHeader::m_frame_library
protected
The documentation for this class was generated from the following files: