ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Common::FrameStream Class Reference

#include <FrameStream.hh>

Inheritance diagram for FrameCPP::Common::FrameStream:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::FrameStream:
Collaboration graph
[legend]

Public Types

typedef FrHeader::frame_library_type frame_library_type
typedef FrHeader::library_revision_type library_revision_type
typedef FrameSpec::version_type version_type
typedef const StreamRefInterface * streamref_interface_type
typedef INT_4U fr_event_offset_type
typedef INT_4U fr_sim_event_offset_type
typedef FrHeader::frame_library_type frame_library_type
typedef FrHeader::library_revision_type library_revision_type
typedef FrameSpec::version_type version_type
typedef const StreamRefInterface * streamref_interface_type
typedef INT_4U fr_event_offset_type
typedef INT_4U fr_sim_event_offset_type
typedef boost::shared_ptr< FrameSpec::Object > object_type
typedef const Dictionary::streamref_type::element_type * const_stream_ref_ptr_type
typedef const Dictionary::streamref_type::element_type * const_stream_ref_ptr_type
typedef Dictionary::streamref_type streamref_type
typedef Dictionary::streamref_type streamref_type

Public Member Functions

frame_library_type FrameLibrary () const
library_revision_type LibraryRevision () const
version_type Version () const
const std::string & GetLastError () const
const MD5Sum & GetMD5Sum () const
frame_library_type FrameLibrary () const
library_revision_type LibraryRevision () const
version_type Version () const
const std::string & GetLastError () const
const MD5Sum & GetMD5Sum () const
virtual void Cleanup ()
virtual void Cleanup ()
INT_2U GetClassId (const std::string &ClassName) const
INT_2U GetClassId (const std::string &ClassName) const
INT_2U GetFSIId (INT_2U StreamId) const
INT_2U GetFSIId (INT_2U StreamId) const
cmn_streamsize_type PtrStructBytes () const
cmn_streamsize_type PtrStructBytes () const
const_stream_ref_ptr_type ReferenceStreamRef () const
const_stream_ref_ptr_type ReferenceStreamRef () const
const Dictionary & GetDictionary () const
Dictionary & GetDictionary ()
const Dictionary & GetDictionary () const
Dictionary & GetDictionary ()

Protected Types

typedef std::unique_ptr< CheckSumFilter > checksum_filter_type
typedef std::unique_ptr< CheckSumFilter > checksum_filter_type
typedef std::unique_ptr< MD5SumFilter > md5sum_filter_type
typedef std::unique_ptr< MD5SumFilter > md5sum_filter_type
typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > streamid_to_fsiid_type
typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > streamid_to_fsiid_type
typedef boost::shared_ptr< PTR_STRUCT_BASE > ptr_struct_base_type
typedef boost::shared_ptr< PTR_STRUCT_BASE > ptr_struct_base_type

Protected Member Functions

 FrameStream (version_type Version, bool AllowZeroVersion)
virtual void frameSpecInfo (const FrameSpec::Info *Spec)
object_type morph (object_type Obj)
 Modify an object so it is appropriate for the stream.
void setLastError (const std::string &Message)
void setTOC ()
const StreamRefInterface & streamRef () const
void version_stream (version_type Version)
void frameLibrary (frame_library_type FrameLibrary)
void libraryRevision (library_revision_type LibraryRevision)
version_type memoryVersion () const
version_type streamVersion () const
virtual void reset ()
 FrameStream (version_type Version, bool AllowZeroVersion)
virtual void frameSpecInfo (const FrameSpec::Info *Spec)
object_type morph (object_type Obj)
 Modify an object so it is appropriate for the stream.
void setLastError (const std::string &Message)
void setTOC ()
const StreamRefInterface & streamRef () const
void version_stream (version_type Version)
void frameLibrary (frame_library_type FrameLibrary)
void libraryRevision (library_revision_type LibraryRevision)
version_type memoryVersion () const
version_type streamVersion () const
virtual void reset ()
const FrameSpec::Info & frameSpecInfo () const

Protected Attributes

bool m_closed_state
std::unique_ptr< MD5SumFilter > m_md5sumFilter
Dictionary m_dictionary
object_type m_null_stream_ref
ptr_struct_base_type m_ptr_struct_object
streamid_to_fsiid_type m_stream_id_to_fsi_id
checksum_filter_type m_file_checksum
 Checksum for file.
checksum_filter_type m_frame_checksum
 Checksum for frame.
checksum_filter_type m_obj_checksum
 Checksum for object.
md5sum_filter_type m_file_md5sum
 MD5Sum value for the files.

Private Types

typedef LDASTools::AL::unordered_map< std::string, INT_2U, LDASTools::AL::hash< std::string >, LDASTools::AL::CaseInsensitiveCmp > cntocid_mapping_type
typedef LDASTools::AL::unordered_map< std::string, INT_2U, LDASTools::AL::hash< std::string >, LDASTools::AL::CaseInsensitiveCmp > cntocid_mapping_type

Static Private Member Functions

static bool initialize ()
static bool initialize ()
static void cleanup_at_exit ()
static void cleanup_at_exit ()

Private Attributes

frame_library_type m_frame_library
library_revision_type m_library_revision
version_type m_memory_version
 Version number to use for frames in memory.
version_type m_stream_version
 Version number to use for frames in stream.
streamref_interface_type m_stream_ref
std::string m_last_error_message
const FrameSpec::Info * m_frame_spec
cmn_streamsize_type m_ptr_struct_bytes

Static Private Attributes

static const bool m_initialized = StreamBase::initialize( )
static cntocid_mapping_type m_class_name_to_class_id

Member Typedef Documentation

◆ checksum_filter_type [1/2]

typedef std::unique_ptr< CheckSumFilter > FrameCPP::Common::StreamBase::checksum_filter_type
protectedinherited

◆ checksum_filter_type [2/2]

typedef std::unique_ptr< CheckSumFilter > FrameCPP::Common::StreamBase::checksum_filter_type
protectedinherited

◆ cntocid_mapping_type [1/2]

typedef LDASTools::AL::unordered_map< std::string, INT_2U, LDASTools::AL::hash< std::string >, LDASTools::AL::CaseInsensitiveCmp > FrameCPP::Common::StreamBase::cntocid_mapping_type
privateinherited

◆ cntocid_mapping_type [2/2]

typedef LDASTools::AL::unordered_map< std::string, INT_2U, LDASTools::AL::hash< std::string >, LDASTools::AL::CaseInsensitiveCmp > FrameCPP::Common::StreamBase::cntocid_mapping_type
privateinherited

◆ const_stream_ref_ptr_type [1/2]

typedef const Dictionary::streamref_type::element_type* FrameCPP::Common::StreamBase::const_stream_ref_ptr_type
inherited

◆ const_stream_ref_ptr_type [2/2]

typedef const Dictionary::streamref_type::element_type* FrameCPP::Common::StreamBase::const_stream_ref_ptr_type
inherited

◆ fr_event_offset_type [1/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_event_offset_type

◆ fr_event_offset_type [2/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_event_offset_type

◆ fr_sim_event_offset_type [1/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_sim_event_offset_type

◆ fr_sim_event_offset_type [2/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_sim_event_offset_type

◆ frame_library_type [1/2]

typedef FrHeader::frame_library_type FrameCPP::Common::FrameStream::frame_library_type

◆ frame_library_type [2/2]

typedef FrHeader::frame_library_type FrameCPP::Common::FrameStream::frame_library_type

◆ library_revision_type [1/2]

typedef FrHeader::library_revision_type FrameCPP::Common::FrameStream::library_revision_type

◆ library_revision_type [2/2]

typedef FrHeader::library_revision_type FrameCPP::Common::FrameStream::library_revision_type

◆ md5sum_filter_type [1/2]

typedef std::unique_ptr< MD5SumFilter > FrameCPP::Common::StreamBase::md5sum_filter_type
protectedinherited

◆ md5sum_filter_type [2/2]

typedef std::unique_ptr< MD5SumFilter > FrameCPP::Common::StreamBase::md5sum_filter_type
protectedinherited

◆ object_type

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type

◆ ptr_struct_base_type [1/2]

typedef boost::shared_ptr< PTR_STRUCT_BASE > FrameCPP::Common::StreamBase::ptr_struct_base_type
protectedinherited

◆ ptr_struct_base_type [2/2]

typedef boost::shared_ptr< PTR_STRUCT_BASE > FrameCPP::Common::StreamBase::ptr_struct_base_type
protectedinherited

◆ streamid_to_fsiid_type [1/2]

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > FrameCPP::Common::StreamBase::streamid_to_fsiid_type
protectedinherited

◆ streamid_to_fsiid_type [2/2]

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > FrameCPP::Common::StreamBase::streamid_to_fsiid_type
protectedinherited

◆ streamref_interface_type [1/2]

typedef const StreamRefInterface* FrameCPP::Common::FrameStream::streamref_interface_type

◆ streamref_interface_type [2/2]

typedef const StreamRefInterface* FrameCPP::Common::FrameStream::streamref_interface_type

◆ streamref_type [1/2]

typedef Dictionary::streamref_type FrameCPP::Common::StreamBase::streamref_type
inherited

◆ streamref_type [2/2]

typedef Dictionary::streamref_type FrameCPP::Common::StreamBase::streamref_type
inherited

◆ version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameStream::version_type

◆ version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameStream::version_type

Constructor & Destructor Documentation

◆ FrameStream() [1/2]

FrameStream::FrameStream ( version_type Version,
bool AllowZeroVersion )
protected

◆ FrameStream() [2/2]

FrameCPP::Common::FrameStream::FrameStream ( version_type Version,
bool AllowZeroVersion )
protected

Member Function Documentation

◆ Cleanup() [1/2]

void FrameCPP::Common::StreamBase::Cleanup ( )
virtualinherited

Reimplemented in anonymous_namespace{FrEvent.cc}::IStream, anonymous_namespace{FrEvent.cc}::IStream, anonymous_namespace{FrSimEvent.cc}::IStream, anonymous_namespace{FrSimEvent.cc}::IStream, FrameCPP::Common::IFrameStream, FrameCPP::Common::IFrameStream, FrameCPP::Common::IStream, FrameCPP::Common::IStream, FrameCPP::Version_6::IStream, FrameCPP::Version_6::IStream, FrameCPP::Version_7::IStream, and FrameCPP::Version_7::IStream.

◆ Cleanup() [2/2]

virtual void FrameCPP::Common::StreamBase::Cleanup ( )
virtualinherited

Reimplemented in anonymous_namespace{FrEvent.cc}::IStream, anonymous_namespace{FrEvent.cc}::IStream, anonymous_namespace{FrSimEvent.cc}::IStream, anonymous_namespace{FrSimEvent.cc}::IStream, FrameCPP::Common::IFrameStream, FrameCPP::Common::IFrameStream, FrameCPP::Common::IStream, FrameCPP::Common::IStream, FrameCPP::Version_6::IStream, FrameCPP::Version_6::IStream, FrameCPP::Version_7::IStream, and FrameCPP::Version_7::IStream.

◆ cleanup_at_exit() [1/2]

void FrameCPP::Common::StreamBase::cleanup_at_exit ( )
staticprivateinherited

◆ cleanup_at_exit() [2/2]

void FrameCPP::Common::StreamBase::cleanup_at_exit ( )
staticprivateinherited

◆ FrameLibrary() [1/2]

FrameStream::frame_library_type FrameStream::FrameLibrary ( ) const
inline

◆ FrameLibrary() [2/2]

frame_library_type FrameCPP::Common::FrameStream::FrameLibrary ( ) const

◆ frameLibrary() [1/2]

void FrameStream::frameLibrary ( frame_library_type FrameLibrary)
inlineprotected

◆ frameLibrary() [2/2]

void FrameCPP::Common::FrameStream::frameLibrary ( frame_library_type FrameLibrary)
protected

◆ frameSpecInfo() [1/3]

const FrameSpec::Info & FrameCPP::Common::StreamBase::frameSpecInfo ( ) const
inlineprotected

◆ frameSpecInfo() [2/3]

void FrameStream::frameSpecInfo ( const FrameSpec::Info * Spec)
protectedvirtual

Reimplemented from FrameCPP::Common::StreamBase.

◆ frameSpecInfo() [3/3]

virtual void FrameCPP::Common::FrameStream::frameSpecInfo ( const FrameSpec::Info * Spec)
protectedvirtual

Reimplemented from FrameCPP::Common::StreamBase.

◆ GetClassId() [1/2]

INT_2U FrameCPP::Common::StreamBase::GetClassId ( const std::string & ClassName) const
inherited

◆ GetClassId() [2/2]

INT_2U FrameCPP::Common::StreamBase::GetClassId ( const std::string & ClassName) const
inherited

◆ GetDictionary() [1/4]

Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( )
inlineinherited

◆ GetDictionary() [2/4]

Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( )
inherited

◆ GetDictionary() [3/4]

const Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( ) const
inlineinherited

◆ GetDictionary() [4/4]

const Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( ) const
inherited

◆ GetFSIId() [1/2]

INT_2U FrameCPP::Common::StreamBase::GetFSIId ( INT_2U StreamId) const
inlineinherited

◆ GetFSIId() [2/2]

INT_2U FrameCPP::Common::StreamBase::GetFSIId ( INT_2U StreamId) const
inherited

◆ GetLastError() [1/2]

const std::string & FrameStream::GetLastError ( ) const
inline

◆ GetLastError() [2/2]

const std::string & FrameCPP::Common::FrameStream::GetLastError ( ) const

◆ GetMD5Sum() [1/2]

const MD5Sum & FrameStream::GetMD5Sum ( ) const
inline

◆ GetMD5Sum() [2/2]

const MD5Sum & FrameCPP::Common::FrameStream::GetMD5Sum ( ) const

◆ initialize() [1/2]

bool FrameCPP::Common::StreamBase::initialize ( )
staticprivateinherited

◆ initialize() [2/2]

bool FrameCPP::Common::StreamBase::initialize ( )
staticprivateinherited

◆ LibraryRevision() [1/2]

FrameStream::library_revision_type FrameStream::LibraryRevision ( ) const
inline

◆ LibraryRevision() [2/2]

library_revision_type FrameCPP::Common::FrameStream::LibraryRevision ( ) const

◆ libraryRevision() [1/2]

void FrameStream::libraryRevision ( library_revision_type LibraryRevision)
inlineprotected

◆ libraryRevision() [2/2]

void FrameCPP::Common::FrameStream::libraryRevision ( library_revision_type LibraryRevision)
protected

◆ memoryVersion() [1/2]

FrameStream::version_type FrameStream::memoryVersion ( ) const
inlineprotected

◆ memoryVersion() [2/2]

version_type FrameCPP::Common::FrameStream::memoryVersion ( ) const
protected

◆ morph() [1/2]

FrameStream::object_type FrameStream::morph ( object_type Obj)
protected

Modify an object so it is appropriate for the stream.

Parameters
[in]ObjThe object that should be transformed.
Returns
A pointer to the object appropriately converted. If no conversion was necessary, the same pointer is returned.

◆ morph() [2/2]

object_type FrameCPP::Common::FrameStream::morph ( object_type Obj)
protected

Modify an object so it is appropriate for the stream.

Parameters
[in]ObjThe object that should be transformed.
Returns
A pointer to the object appropriately converted. If no conversion was necessary, the same pointer is returned.

◆ PtrStructBytes() [1/2]

cmn_streamsize_type FrameCPP::Common::StreamBase::PtrStructBytes ( ) const
inlineinherited

◆ PtrStructBytes() [2/2]

cmn_streamsize_type FrameCPP::Common::StreamBase::PtrStructBytes ( ) const
inherited

◆ ReferenceStreamRef() [1/2]

StreamBase::const_stream_ref_ptr_type FrameCPP::Common::StreamBase::ReferenceStreamRef ( ) const
inherited

◆ ReferenceStreamRef() [2/2]

const_stream_ref_ptr_type FrameCPP::Common::StreamBase::ReferenceStreamRef ( ) const
inherited

◆ reset() [1/2]

void FrameStream::reset ( )
protectedvirtual

Reimplemented in FrameCPP::Common::IFrameStream, and FrameCPP::Common::IFrameStream.

◆ reset() [2/2]

virtual void FrameCPP::Common::FrameStream::reset ( )
protectedvirtual

Reimplemented in FrameCPP::Common::IFrameStream, and FrameCPP::Common::IFrameStream.

◆ setLastError() [1/2]

void FrameStream::setLastError ( const std::string & Message)
inlineprotected

◆ setLastError() [2/2]

void FrameCPP::Common::FrameStream::setLastError ( const std::string & Message)
protected

◆ setTOC() [1/2]

void FrameCPP::Common::FrameStream::setTOC ( )
protected

◆ setTOC() [2/2]

void FrameCPP::Common::FrameStream::setTOC ( )
protected

◆ streamRef() [1/2]

const StreamRefInterface & FrameStream::streamRef ( ) const
inlineprotected

◆ streamRef() [2/2]

const StreamRefInterface & FrameCPP::Common::FrameStream::streamRef ( ) const
protected

◆ streamVersion() [1/2]

FrameStream::version_type FrameStream::streamVersion ( ) const
inlineprotected

◆ streamVersion() [2/2]

version_type FrameCPP::Common::FrameStream::streamVersion ( ) const
protected

◆ Version() [1/2]

FrameStream::version_type FrameStream::Version ( ) const
inline

◆ Version() [2/2]

version_type FrameCPP::Common::FrameStream::Version ( ) const

◆ version_stream() [1/2]

void FrameStream::version_stream ( version_type Version)
inlineprotected

◆ version_stream() [2/2]

void FrameCPP::Common::FrameStream::version_stream ( version_type Version)
protected

Member Data Documentation

◆ m_class_name_to_class_id

cntocid_mapping_type FrameCPP::Common::StreamBase::m_class_name_to_class_id
staticprivateinherited

◆ m_closed_state

bool FrameStream::m_closed_state
protected

◆ m_dictionary

Dictionary FrameCPP::Common::StreamBase::m_dictionary
protectedinherited

◆ m_file_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_file_checksum
protectedinherited

Checksum for file.

◆ m_file_md5sum

md5sum_filter_type FrameCPP::Common::StreamBase::m_file_md5sum
protectedinherited

MD5Sum value for the files.

◆ m_frame_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_frame_checksum
protectedinherited

Checksum for frame.

◆ m_frame_library

frame_library_type FrameStream::m_frame_library
private

◆ m_frame_spec

const FrameSpec::Info * FrameCPP::Common::StreamBase::m_frame_spec
privateinherited

◆ m_initialized

const bool FrameCPP::Common::StreamBase::m_initialized = StreamBase::initialize( )
staticprivateinherited

◆ m_last_error_message

std::string FrameStream::m_last_error_message
private

◆ m_library_revision

library_revision_type FrameStream::m_library_revision
private

◆ m_md5sumFilter

std::unique_ptr< MD5SumFilter > FrameStream::m_md5sumFilter
protected

◆ m_memory_version

version_type FrameStream::m_memory_version
private

Version number to use for frames in memory.

◆ m_null_stream_ref

object_type FrameCPP::Common::StreamBase::m_null_stream_ref
protectedinherited

◆ m_obj_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_obj_checksum
protectedinherited

Checksum for object.

◆ m_ptr_struct_bytes

cmn_streamsize_type FrameCPP::Common::StreamBase::m_ptr_struct_bytes
mutableprivateinherited

◆ m_ptr_struct_object

ptr_struct_base_type FrameCPP::Common::StreamBase::m_ptr_struct_object
protectedinherited

◆ m_stream_id_to_fsi_id

streamid_to_fsiid_type FrameCPP::Common::StreamBase::m_stream_id_to_fsi_id
mutableprotectedinherited

◆ m_stream_ref

streamref_interface_type FrameStream::m_stream_ref
private

◆ m_stream_version

version_type FrameStream::m_stream_version
private

Version number to use for frames in stream.

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrameStream.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameStream.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameStream.cc