ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition > Class Template Reference

Used for TOC optimization of channel offsets. More...

#include <FrTOC.hh>

Classes

class  input_iterator

Public Types

typedef INT_4U frame_count_type
typedef INT_4U n_type
typedef TString name_type
typedef TPosition position_type
typedef std::vector< position_type > info_type
typedef std::map< name_type, info_type > Map_type
typedef std::vector< name_type > key_container_type
typedef INT_4U frame_count_type
typedef INT_4U n_type
typedef TString name_type
typedef TPosition position_type
typedef std::vector< position_type > info_type
typedef std::map< name_type, info_type > Map_type
typedef std::vector< name_type > key_container_type

Public Member Functions

Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
const key_container_type & GetPositionKeys () const
void write (Common::OStream &Stream) const
const PositionWithCache & operator= (const PositionWithCache &Source)
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
const key_container_type & GetPositionKeys () const
void write (Common::OStream &Stream) const
const PositionWithCache & operator= (const PositionWithCache &Source)

Protected Member Functions

 PositionWithCache ()
 PositionWithCache (Common::IStream &Stream, frame_count_type FrameCount)
const Map_type & getInfo () 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.
void setPositionsOffset (istream_type &Stream)
bool operator== (const PositionWithCache &RHS) const
 PositionWithCache ()
 PositionWithCache (Common::IStream &Stream, frame_count_type FrameCount)
const Map_type & getInfo () 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.
void setPositionsOffset (istream_type &Stream)
bool operator== (const PositionWithCache &RHS) const

Protected Attributes

key_container_type m_keys
Map_type m_info

Private Types

typedef std::vector< position_type > positions_cache_type
typedef std::vector< position_type > positions_cache_type

Private Attributes

frame_count_type frame_count
positions_cache_type positions_cache
position_type positions_cache_offset

Detailed Description

template<typename TString, typename TPosition>
class FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >

Used for TOC optimization of channel offsets.

Member Typedef Documentation

◆ frame_count_type [1/2]

template<typename TString, typename TPosition>
typedef INT_4U FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::frame_count_type

◆ frame_count_type [2/2]

template<typename TString, typename TPosition>
typedef INT_4U FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::frame_count_type

◆ info_type [1/2]

template<typename TString, typename TPosition>
typedef std::vector< position_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::info_type

◆ info_type [2/2]

template<typename TString, typename TPosition>
typedef std::vector< position_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::info_type

◆ key_container_type [1/2]

template<typename TString, typename TPosition>
typedef std::vector< name_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::key_container_type

◆ key_container_type [2/2]

template<typename TString, typename TPosition>
typedef std::vector< name_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::key_container_type

◆ Map_type [1/2]

template<typename TString, typename TPosition>
typedef std::map< name_type, info_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::Map_type

◆ Map_type [2/2]

template<typename TString, typename TPosition>
typedef std::map< name_type, info_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::Map_type

◆ n_type [1/2]

template<typename TString, typename TPosition>
typedef INT_4U FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::n_type

◆ n_type [2/2]

template<typename TString, typename TPosition>
typedef INT_4U FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::n_type

◆ name_type [1/2]

template<typename TString, typename TPosition>
typedef TString FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::name_type

◆ name_type [2/2]

template<typename TString, typename TPosition>
typedef TString FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::name_type

◆ position_type [1/2]

template<typename TString, typename TPosition>
typedef TPosition FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::position_type

◆ position_type [2/2]

template<typename TString, typename TPosition>
typedef TPosition FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::position_type

◆ positions_cache_type [1/2]

template<typename TString, typename TPosition>
typedef std::vector< position_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::positions_cache_type
private

◆ positions_cache_type [2/2]

template<typename TString, typename TPosition>
typedef std::vector< position_type > FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::positions_cache_type
private

Constructor & Destructor Documentation

◆ PositionWithCache() [1/4]

template<typename TString, typename TPosition>
FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::PositionWithCache ( )
inlineprotected

◆ PositionWithCache() [2/4]

template<typename TString, typename TPosition>
FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::PositionWithCache ( Common::IStream & Stream,
frame_count_type FrameCount )
inlineprotected

◆ PositionWithCache() [3/4]

template<typename TString, typename TPosition>
FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::PositionWithCache ( )
inlineprotected

◆ PositionWithCache() [4/4]

template<typename TString, typename TPosition>
FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::PositionWithCache ( Common::IStream & Stream,
frame_count_type FrameCount )
inlineprotected

Member Function Documentation

◆ Bytes() [1/2]

template<typename TString, typename TPosition>
Common::FrameSpec::size_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::Bytes ( const Common::StreamBase & Stream) const
inline

◆ Bytes() [2/2]

template<typename TString, typename TPosition>
Common::FrameSpec::size_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::Bytes ( const Common::StreamBase & Stream) const
inline

◆ cachePositions() [1/2]

template<typename TString, typename TPosition>
void FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::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]

template<typename TString, typename TPosition>
void FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::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.

◆ getInfo() [1/6]

template<typename TString, typename TPosition>
const Map_type & FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::getInfo ( ) const
inlineprotected

◆ getInfo() [2/6]

template<typename TString, typename TPosition>
const Map_type & FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::getInfo ( ) const
inlineprotected

◆ getInfo() [3/6]

template<typename TString, typename TPosition>
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::getInfo ( const std::string & Name) const
inlineprotected

◆ getInfo() [4/6]

template<typename TString, typename TPosition>
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::getInfo ( const std::string & Name) const
inlineprotected

◆ getInfo() [5/6]

template<typename TString, typename TPosition>
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::getInfo ( INT_4U Index) const
inlineprotected

◆ getInfo() [6/6]

template<typename TString, typename TPosition>
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::getInfo ( INT_4U Index) const
inlineprotected

◆ GetPositionKeys() [1/2]

template<typename TString, typename TPosition>
const key_container_type & FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::GetPositionKeys ( ) const
inline

◆ GetPositionKeys() [2/2]

template<typename TString, typename TPosition>
const key_container_type & FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::GetPositionKeys ( ) const
inline

◆ operator=() [1/2]

template<typename TString, typename TPosition>
const PositionWithCache & FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::operator= ( const PositionWithCache< TString, TPosition > & Source)
inline

◆ operator=() [2/2]

template<typename TString, typename TPosition>
const PositionWithCache & FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::operator= ( const PositionWithCache< TString, TPosition > & Source)
inline

◆ operator==() [1/2]

template<typename TString, typename TPosition>
bool FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::operator== ( const PositionWithCache< TString, TPosition > & RHS) const
inlineprotected

◆ operator==() [2/2]

template<typename TString, typename TPosition>
bool FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::operator== ( const PositionWithCache< TString, TPosition > & RHS) const
inlineprotected

◆ setPositionsOffset() [1/2]

template<typename TString, typename TPosition>
void FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::setPositionsOffset ( istream_type & Stream)
inlineprotected

◆ setPositionsOffset() [2/2]

template<typename TString, typename TPosition>
void FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::setPositionsOffset ( istream_type & Stream)
inlineprotected

◆ write() [1/2]

template<typename TString, typename TPosition>
void FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::write ( Common::OStream & Stream) const
inline

◆ write() [2/2]

template<typename TString, typename TPosition>
void FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::write ( Common::OStream & Stream) const
inline

Member Data Documentation

◆ frame_count

template<typename TString, typename TPosition>
frame_count_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::frame_count
private

◆ m_info

template<typename TString, typename TPosition>
Map_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::m_info
protected

◆ m_keys

template<typename TString, typename TPosition>
key_container_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::m_keys
protected

◆ positions_cache

template<typename TString, typename TPosition>
positions_cache_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::positions_cache
private

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

◆ positions_cache_offset

template<typename TString, typename TPosition>
position_type FrameCPP::Common::FrTOC::PositionWithCache< TString, TPosition >::positions_cache_offset
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:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrTOC.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrTOC.hh