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 | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrTOCProcData Class Reference

Indexed elements of the FrProcData structure. More...

#include <FrTOCProcData.hh>

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

Public Types

typedef INT_4U nproc_type
 
typedef STRING name_type
 
typedef INT_8U position_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector
< position_type
proc_info_type
 
typedef std::map< name_type,
proc_info_type
MapProc_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef std::vector
< position_type
info_type
 
typedef std::map< name_type,
info_type
Map_type
 

Public Member Functions

 FrTOCProcData ()
 Default constructor. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const key_container_typeGetKeys () const
 Retrieve the keys. More...
 
const MapProc_typeGetProc () const
 Return all channels. More...
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written. More...
 
const FrTOCProcDataoperator= (const Previous::FrTOCProcData &Source)
 asignment operator More...
 
bool operator== (const FrTOCProcData &RHS) const
 equality operator More...
 
const key_container_typeGetPositionKeys () const
 

Static Public Member Functions

template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 

Protected Member Functions

 FrTOCProcData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
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
 
MapProc_type m_info
 

Detailed Description

Indexed elements of the FrProcData structure.

Member Typedef Documentation

Constructor & Destructor Documentation

FrameCPP::Version_8::FrTOCProcData::FrTOCProcData ( )

Default constructor.

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

Stream constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
[in]FrameCountThe frame offset.

Member Function Documentation

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

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
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.

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

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
void FrameCPP::Version_8::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.

const Map_type& FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( ) const
inlineprotectedinherited
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( const std::string &  Name) const
inlineprotectedinherited
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( INT_4U  Index) const
inlineprotectedinherited
const FrTOCProcData::key_container_type & FrameCPP::Version_8::FrTOCProcData::GetKeys ( ) const
inline

Retrieve the keys.

Returns
Constant container of keys.
const FrTOCProcData::MapProc_type & FrameCPP::Version_8::FrTOCProcData::GetProc ( ) const
inline

Return all channels.

Returns
Constant container to the indexed FrProcData elements.
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( const std::string &  Name) const

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrProcData element.
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( INT_4U  index) const

Return the indexed data for a named channel.

Parameters
[in]indexThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrProcData element.
const FrTOCProcData & FrameCPP::Version_8::FrTOCProcData::operator= ( const Previous::FrTOCProcData &  Source)

asignment operator

Parameters
[in]SourceThe source to be copied.
bool FrameCPP::Version_8::FrTOCProcData::operator== ( const FrTOCProcData RHS) const

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::operator== ( const PositionWithCache< STRING, FrTOCTypes::position_type > &  RHS) const
inlineprotectedinherited
void FrameCPP::Version_8::FrTOCProcData::QueryProc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)

Gather TOC info for FrProcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::setPositionsOffset ( istream_type Stream)
inlineprotectedinherited
void FrameCPP::Version_8::FrTOCProcData::write ( Common::OStream Stream) const
protected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Member Data Documentation

MapProc_type FrameCPP::Version_8::FrTOCProcData::m_info
protected
key_container_type FrameCPP::Version_8::FrTOCProcData::m_keys
protected

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