ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO Class Reference

#include <FrTOCProcDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO:
Collaboration diagram for FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO:

Classes

class  input_iterator
 

Public Types

typedef INT_4U nproc_type
 
typedef INT_4U nproc_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 
typedef std::vector< position_typeproc_info_type
 
typedef std::vector< position_typeproc_info_type
 
typedef std::map< name_type, proc_info_typeMapProc_type
 
typedef std::map< name_type, proc_info_typeMapProc_type
 

Public Member Functions

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

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

void cachePositions (istream_type &Stream)
 TOC optimization.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void setPositionsOffset (istream_type &Stream)
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void cachePositions (istream_type &Stream)
 TOC optimization.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void setPositionsOffset (istream_type &Stream)
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 

Protected Attributes

key_container_type m_keys
 
MapProc_type m_info
 

Private Types

typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< position_typepositions_cache_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< position_typepositions_cache_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 

Private Attributes

frame_count_type frame_count { 0 }
 
positions_cache_type positions_cache
 
position_type positions_cache_offset { 0 }
 

Member Typedef Documentation

◆ frame_count_type [1/2]

◆ frame_count_type [2/2]

◆ info_type [1/2]

◆ info_type [2/2]

◆ key_container_type [1/2]

◆ key_container_type [2/2]

◆ Map_type [1/2]

◆ Map_type [2/2]

◆ MapProc_type [1/2]

◆ MapProc_type [2/2]

◆ n_type [1/2]

◆ n_type [2/2]

◆ name_type [1/2]

typedef std::string FrameCPP::v8::FrTOCProcData::name_type
inherited

◆ name_type [2/2]

typedef std::string FrameCPP::v8::FrTOCProcData::name_type
inherited

◆ nproc_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCProcData::nproc_type
inherited

◆ nproc_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCProcData::nproc_type
inherited

◆ position_type [1/2]

◆ position_type [2/2]

◆ positions_cache_type [1/2]

◆ positions_cache_type [2/2]

◆ proc_info_type [1/2]

◆ proc_info_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCProcDataClassicIO() [1/2]

FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::FrTOCProcDataClassicIO ( )
default

Default constructor.

◆ FrTOCProcDataClassicIO() [2/2]

FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::FrTOCProcDataClassicIO ( )
default

Default constructor.

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::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::FrTOCImpl::FrTOCProcDataClassicIO::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.

◆ cachePositions() [1/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::cachePositions ( istream_type & Stream)
inlineprotected

TOC optimization.

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

◆ cachePositions() [2/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::cachePositions ( istream_type & Stream)
inlineprotected

TOC optimization.

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

◆ Description() [1/2]

template<typename SE>
static void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::Description ( Common::Description & Desc)
inlinestatic

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::FrTOCImpl::FrTOCProcDataClassicIO::Description ( Common::Description & Desc)
inlinestatic

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::FrTOCImpl::FrTOCProcDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotected

Iterate over contents.

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

◆ forEach() [2/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotected

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 key_container_type & FrameCPP::v8::FrTOCProcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

const key_container_type & FrameCPP::v8::FrTOCProcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.

◆ GetProc() [1/6]

const MapProc_type & FrameCPP::v8::FrTOCProcData::GetProc ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [2/6]

const MapProc_type & FrameCPP::v8::FrTOCProcData::GetProc ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [3/6]

MapProc_type::const_iterator FrameCPP::v8::FrTOCProcData::GetProc ( const std::string & Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrProcData element.

◆ GetProc() [4/6]

MapProc_type::const_iterator FrameCPP::v8::FrTOCProcData::GetProc ( const std::string & Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrProcData element.

◆ GetProc() [5/6]

MapProc_type::const_iterator FrameCPP::v8::FrTOCProcData::GetProc ( INT_4U Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrProcData element.

◆ GetProc() [6/6]

MapProc_type::const_iterator FrameCPP::v8::FrTOCProcData::GetProc ( INT_4U Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrProcData element.

◆ Load() [1/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [2/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ operator=() [1/4]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/4]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [3/4]

FrTOCProcDataClassicIO & FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::operator= ( FrTOCProcDataClassicIO && TOC)
inline

◆ operator=() [4/4]

FrTOCProcDataClassicIO & FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::operator= ( FrTOCProcDataClassicIO && TOC)
inline

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::operator== ( const FrTOCProcDataClassicIO & RHS) const

equality operator

Parameters
[in]RHSThe FrTOCProcData 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::FrTOCImpl::FrTOCProcDataClassicIO::operator== ( const FrTOCProcDataClassicIO & RHS) const

equality operator

Parameters
[in]RHSThe FrTOCProcData 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::FrTOCImpl::FrTOCProcDataClassicIO::QueryProc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

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::FrTOCImpl::FrTOCProcDataClassicIO::QueryProc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inline

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.

◆ setPositionsOffset() [1/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::setPositionsOffset ( istream_type & Stream)
inlineprotected

◆ setPositionsOffset() [2/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::setPositionsOffset ( istream_type & Stream)
inlineprotected

◆ write() [1/2]

void FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::write ( Common::OStream & Stream) const
inlineprotected

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::FrTOCImpl::FrTOCProcDataClassicIO::write ( Common::OStream & Stream) const
inlineprotected

Write the structure to the stream.

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

Member Data Documentation

◆ frame_count

frame_count_type FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::frame_count { 0 }
private

◆ m_info

MapProc_type FrameCPP::v8::FrTOCProcData::m_info
protectedinherited

◆ m_keys

key_container_type FrameCPP::v8::FrTOCProcData::m_keys
protectedinherited

◆ positions_cache

positions_cache_type FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::positions_cache
private

A cache of the positions of the FrAdcData structures within the stream.

◆ positions_cache_offset

position_type FrameCPP::Version_8::FrTOCImpl::FrTOCProcDataClassicIO::positions_cache_offset { 0 }
private

The number of bytes from the end of the stream where the array containing the FrAdcData offsets.


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