ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
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:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrTOCProcData:
Collaboration graph
[legend]

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_typeproc_info_type
 
typedef std::map< name_type, proc_info_typeMapProc_type
 
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_typeproc_info_type
 
typedef std::map< name_type, proc_info_typeMapProc_type
 

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

 FrTOCProcData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
 FrTOCProcData (Common::IStream &Stream, INT_4U FrameCount)
 Stream constructor.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 

Protected Attributes

key_container_type m_keys
 
MapProc_type m_info
 

Detailed Description

Indexed elements of the FrProcData structure.

Member Typedef Documentation

◆ key_container_type [1/2]

◆ key_container_type [2/2]

◆ MapProc_type [1/2]

◆ MapProc_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nproc_type [1/2]

◆ nproc_type [2/2]

◆ position_type [1/2]

◆ position_type [2/2]

◆ proc_info_type [1/2]

◆ proc_info_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCProcData() [1/4]

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

Default constructor.

◆ FrTOCProcData() [2/4]

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.

◆ FrTOCProcData() [3/4]

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

Default constructor.

◆ FrTOCProcData() [4/4]

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

◆ Bytes() [1/2]

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.

◆ Bytes() [2/2]

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

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.

◆ Description() [1/2]

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.

◆ Description() [2/2]

template<typename SE >
static 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.

◆ forEach() [1/2]

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.

◆ forEach() [2/2]

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.

◆ GetKeys() [1/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

const key_container_type & FrameCPP::Version_8::FrTOCProcData::GetKeys ( ) const

Retrieve the keys.

Returns
Constant container of keys.

◆ GetProc() [1/6]

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

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [2/6]

const MapProc_type & FrameCPP::Version_8::FrTOCProcData::GetProc ( ) const

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [3/6]

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.

◆ GetProc() [4/6]

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.

◆ GetProc() [5/6]

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.

◆ GetProc() [6/6]

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.

◆ operator=() [1/2]

const FrTOCProcData & FrameCPP::Version_8::FrTOCProcData::operator= ( const Previous::FrTOCProcData & Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

const FrTOCProcData & FrameCPP::Version_8::FrTOCProcData::operator= ( const Previous::FrTOCProcData & Source)

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

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.

◆ operator==() [2/2]

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.

◆ QueryProc() [1/2]

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.

◆ QueryProc() [2/2]

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.

◆ write() [1/2]

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.

◆ write() [2/2]

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

◆ m_info

MapProc_type FrameCPP::Version_8::FrTOCProcData::m_info
protected

◆ m_keys

key_container_type FrameCPP::Version_8::FrTOCProcData::m_keys
protected

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