ldas-tools-framecpp  2.5.8
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_6::FrTOCProcData Class Reference

#include <FrTOCProcData.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOCProcData:
FrameCPP::Common::FrTOC::PositionWithCache< STRING, FrTOCTypes::position_type > FrameCPP::Version_6::FrTOC

Public Types

typedef Common::FrTOC::PositionWithCache< STRING, FrTOCTypes::position_typebase_type
 
typedef FrTOCTypes::n_type nproc_type
 
typedef FrTOCTypes::position_type position_type
 
typedef FrTOCTypes::position_container_type proc_info_type
 
typedef FrTOCTypes::ordered_position_container_type MapProc_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 

Public Member Functions

 FrTOCProcData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const key_container_typeGetKeys () const
 
const MapProc_typeGetProc () const
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCProcData &RHS) const
 
const key_container_typeGetPositionKeys () const
 

Static Public Member Functions

template<typename SE >
static void Description (Common::Description &Desc)
 

Protected Member Functions

 FrTOCProcData (Common::IStream &Stream, INT_4U FrameCount)
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
void cachePositions (istream_type &Stream)
 TOC optimization. More...
 
void setPositionsOffset (istream_type &Stream)
 
bool operator== (const PositionWithCache &RHS) const
 

Protected Attributes

key_container_type m_keys
 
Map_type m_info
 

Member Typedef Documentation

◆ base_type

◆ frame_count_type

◆ info_type

◆ key_container_type

◆ Map_type

◆ MapProc_type

◆ n_type

◆ name_type

◆ nproc_type

◆ position_type

◆ proc_info_type

Constructor & Destructor Documentation

◆ FrTOCProcData() [1/2]

FrameCPP::Version_6::FrTOCProcData::FrTOCProcData ( )

◆ FrTOCProcData() [2/2]

FrameCPP::Version_6::FrTOCProcData::FrTOCProcData ( Common::IStream Stream,
INT_4U  FrameCount 
)
protected

Member Function Documentation

◆ Bytes()

Common::FrameSpec::size_type FrameCPP::Version_6::FrTOCProcData::Bytes ( const Common::StreamBase Stream) const
inline

◆ cachePositions()

void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::cachePositions ( istream_type Stream)
inlineprotectedinherited

TOC optimization.

This method optimizes the TOC reading by only reading the structure offsets. Once read, it is moved into the structure.

◆ Description()

template<typename SE >
void FrameCPP::Version_6::FrTOCProcData::Description ( Common::Description Desc)
static

◆ forEach()

void FrameCPP::Version_6::FrTOCProcData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase Action 
) const
protected

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ getInfo() [1/3]

const Map_type& FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( ) const
inlineprotectedinherited

◆ getInfo() [2/3]

Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( const std::string &  Name) const
inlineprotectedinherited

◆ getInfo() [3/3]

Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( INT_4U  Index) const
inlineprotectedinherited

◆ GetKeys()

const FrTOCProcData::key_container_type & FrameCPP::Version_6::FrTOCProcData::GetKeys ( ) const
inline

◆ GetPositionKeys()

◆ GetProc() [1/3]

const FrTOCProcData::MapProc_type & FrameCPP::Version_6::FrTOCProcData::GetProc ( ) const
inline

◆ GetProc() [2/3]

FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_6::FrTOCProcData::GetProc ( const std::string &  Name) const

◆ GetProc() [3/3]

FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_6::FrTOCProcData::GetProc ( INT_4U  index) const

◆ operator==() [1/2]

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

◆ operator==() [2/2]

bool FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::operator== ( const PositionWithCache< STRING, FrTOCTypes::position_type > &  RHS) const
inlineprotectedinherited

◆ QueryProc()

void FrameCPP::Version_6::FrTOCProcData::QueryProc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

◆ setPositionsOffset()

void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::setPositionsOffset ( istream_type Stream)
inlineprotectedinherited

◆ write()

void FrameCPP::Version_6::FrTOCProcData::write ( Common::OStream Stream) const
inlineprotected

Member Data Documentation

◆ m_info

◆ m_keys


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