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_6::FrTOCData Class Reference

#include <FrTOCData.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOCData:
Inheritance graph
[legend]

Public Types

typedef INT_4U data_quality_type
 
typedef REAL_8 dt_type
 
typedef INT_4U frame_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef STRING namedetector_type
 
typedef INT_4U ndetector_type
 
typedef INT_8U nfirstadc_type
 
typedef INT_8U nfirstmsg_type
 
typedef INT_8U nfirstser_type
 
typedef INT_8U nfirsttable_type
 
typedef INT_4U nframe_type
 
typedef INT_4U nsh_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positionh_type
 
typedef INT_4S runs_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef INT_2S uleaps_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 
typedef std::vector< dt_typedt_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< namedetector_typenamedetector_container_type
 
typedef std::vector< nfirstadc_typenfirstadc_container_type
 
typedef std::vector< nfirstmsg_typenfirstmsg_container_type
 
typedef std::vector< nfirstser_typenfirstser_container_type
 
typedef std::vector< nfirsttable_typenfirsttable_container_type
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 
typedef std::vector< positionh_typepositionh_container_type
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef INT_4U data_quality_type
 
typedef REAL_8 dt_type
 
typedef INT_4U frame_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef STRING namedetector_type
 
typedef INT_4U ndetector_type
 
typedef INT_8U nfirstadc_type
 
typedef INT_8U nfirstmsg_type
 
typedef INT_8U nfirstser_type
 
typedef INT_8U nfirsttable_type
 
typedef INT_4U nframe_type
 
typedef INT_4U nsh_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positionh_type
 
typedef INT_4S runs_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef INT_2S uleaps_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 
typedef std::vector< dt_typedt_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< namedetector_typenamedetector_container_type
 
typedef std::vector< nfirstadc_typenfirstadc_container_type
 
typedef std::vector< nfirstmsg_typenfirstmsg_container_type
 
typedef std::vector< nfirstser_typenfirstser_container_type
 
typedef std::vector< nfirsttable_typenfirsttable_container_type
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 
typedef std::vector< positionh_typepositionh_container_type
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 

Public Member Functions

 FrTOCData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const data_quality_container_typeGetDataQuality () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
const nfirstadc_container_typeGetNFirstADC () const
 
const nfirstmsg_container_typeGetNFirstMsg () const
 
const nfirstser_container_typeGetNFirstSer () const
 
const nfirsttable_container_typeGetNFirstTable () const
 
nframe_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 
const runs_container_typeGetRuns () const
 
const shid_container_typeGetSHid () const
 
const shname_container_typeGetSHname () const
 
uleaps_type GetULeapS () const
 
const namedetector_container_typeGetNameDetector () const
 
const positiondetector_container_typeGetPositionDetector () const
 
bool operator== (const FrTOCData &RHS) const
 
 FrTOCData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const data_quality_container_typeGetDataQuality () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
const nfirstadc_container_typeGetNFirstADC () const
 
const nfirstmsg_container_typeGetNFirstMsg () const
 
const nfirstser_container_typeGetNFirstSer () const
 
const nfirsttable_container_typeGetNFirstTable () const
 
nframe_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 
const runs_container_typeGetRuns () const
 
const shid_container_typeGetSHid () const
 
const shname_container_typeGetSHname () const
 
uleaps_type GetULeapS () const
 
const namedetector_container_typeGetNameDetector () const
 
const positiondetector_container_typeGetPositionDetector () const
 
bool operator== (const FrTOCData &RHS) const
 

Static Public Member Functions

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

Protected Member Functions

void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
 FrTOCData (Common::IStream &Stream)
 
void load (Common::IStream &Stream)
 
void write (Common::OStream &Stream) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
 FrTOCData (Common::IStream &Stream)
 
void load (Common::IStream &Stream)
 
void write (Common::OStream &Stream) const
 

Protected Attributes

uleaps_type m_ULeapS
 
data_quality_container_type m_dataQuality
 
gtimes_container_type m_GTimeS
 
gtimen_container_type m_GTimeN
 
dt_container_type m_dt
 
runs_container_type m_runs
 
frame_container_type m_frame
 
positiondetector_container_type m_positionDetector
 
positionh_container_type m_positionH
 
namedetector_container_type m_nameDetector
 
nfirstadc_container_type m_nFirstADC
 
nfirstser_container_type m_nFirstSer
 
nfirsttable_container_type m_nFirstTable
 
nfirstmsg_container_type m_nFirstMsg
 
shid_container_type m_SHid
 
shname_container_type m_SHname
 

Member Typedef Documentation

◆ data_quality_container_type [1/2]

◆ data_quality_container_type [2/2]

◆ data_quality_type [1/2]

◆ data_quality_type [2/2]

◆ dt_container_type [1/2]

◆ dt_container_type [2/2]

◆ dt_type [1/2]

◆ dt_type [2/2]

◆ frame_container_type [1/2]

◆ frame_container_type [2/2]

◆ frame_type [1/2]

◆ frame_type [2/2]

◆ gtimen_container_type [1/2]

◆ gtimen_container_type [2/2]

◆ gtimen_type [1/2]

◆ gtimen_type [2/2]

◆ gtimes_container_type [1/2]

◆ gtimes_container_type [2/2]

◆ gtimes_type [1/2]

◆ gtimes_type [2/2]

◆ namedetector_container_type [1/2]

◆ namedetector_container_type [2/2]

◆ namedetector_type [1/2]

◆ namedetector_type [2/2]

◆ ndetector_type [1/2]

◆ ndetector_type [2/2]

◆ nfirstadc_container_type [1/2]

◆ nfirstadc_container_type [2/2]

◆ nfirstadc_type [1/2]

◆ nfirstadc_type [2/2]

◆ nfirstmsg_container_type [1/2]

◆ nfirstmsg_container_type [2/2]

◆ nfirstmsg_type [1/2]

◆ nfirstmsg_type [2/2]

◆ nfirstser_container_type [1/2]

◆ nfirstser_container_type [2/2]

◆ nfirstser_type [1/2]

◆ nfirstser_type [2/2]

◆ nfirsttable_container_type [1/2]

◆ nfirsttable_container_type [2/2]

◆ nfirsttable_type [1/2]

◆ nfirsttable_type [2/2]

◆ nframe_type [1/2]

◆ nframe_type [2/2]

◆ nsh_type [1/2]

◆ nsh_type [2/2]

◆ positiondetector_container_type [1/2]

◆ positiondetector_container_type [2/2]

◆ positiondetector_type [1/2]

◆ positiondetector_type [2/2]

◆ positionh_container_type [1/2]

◆ positionh_container_type [2/2]

◆ positionh_type [1/2]

◆ positionh_type [2/2]

◆ runs_container_type [1/2]

◆ runs_container_type [2/2]

◆ runs_type [1/2]

◆ runs_type [2/2]

◆ shid_container_type [1/2]

◆ shid_container_type [2/2]

◆ shid_type [1/2]

◆ shid_type [2/2]

◆ shname_container_type [1/2]

◆ shname_container_type [2/2]

◆ shname_type [1/2]

◆ shname_type [2/2]

◆ uleaps_type [1/2]

◆ uleaps_type [2/2]

Constructor & Destructor Documentation

◆ FrTOCData() [1/4]

FrameCPP::Version_6::FrTOCData::FrTOCData ( )
inline

◆ FrTOCData() [2/4]

FrameCPP::Version_6::FrTOCData::FrTOCData ( Common::IStream Stream)
protected

◆ FrTOCData() [3/4]

FrameCPP::Version_6::FrTOCData::FrTOCData ( )

◆ FrTOCData() [4/4]

FrameCPP::Version_6::FrTOCData::FrTOCData ( Common::IStream Stream)
protected

Member Function Documentation

◆ Bytes() [1/2]

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

◆ Bytes() [2/2]

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

◆ Description() [1/2]

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

◆ Description() [2/2]

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

◆ forEach() [1/2]

void FrameCPP::Version_6::FrTOCData::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_6::FrTOCData::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.

◆ GetDataQuality() [1/2]

const FrTOCData::data_quality_container_type & FrameCPP::Version_6::FrTOCData::GetDataQuality ( ) const
inline

◆ GetDataQuality() [2/2]

const data_quality_container_type & FrameCPP::Version_6::FrTOCData::GetDataQuality ( ) const

◆ GetDt() [1/2]

const FrTOCData::dt_container_type & FrameCPP::Version_6::FrTOCData::GetDt ( ) const
inline

◆ GetDt() [2/2]

const dt_container_type & FrameCPP::Version_6::FrTOCData::GetDt ( ) const

◆ GetFrame() [1/2]

const FrTOCData::frame_container_type & FrameCPP::Version_6::FrTOCData::GetFrame ( ) const
inline

◆ GetFrame() [2/2]

const frame_container_type & FrameCPP::Version_6::FrTOCData::GetFrame ( ) const

◆ GetGTimeN() [1/2]

const FrTOCData::gtimen_container_type & FrameCPP::Version_6::FrTOCData::GetGTimeN ( ) const
inline

◆ GetGTimeN() [2/2]

const gtimes_container_type & FrameCPP::Version_6::FrTOCData::GetGTimeN ( ) const

◆ GetGTimeS() [1/2]

const FrTOCData::gtimes_container_type & FrameCPP::Version_6::FrTOCData::GetGTimeS ( ) const
inline

◆ GetGTimeS() [2/2]

const gtimen_container_type & FrameCPP::Version_6::FrTOCData::GetGTimeS ( ) const

◆ GetNameDetector() [1/2]

const FrTOCData::namedetector_container_type & FrameCPP::Version_6::FrTOCData::GetNameDetector ( ) const
inline

◆ GetNameDetector() [2/2]

const namedetector_container_type & FrameCPP::Version_6::FrTOCData::GetNameDetector ( ) const

◆ GetNFirstADC() [1/2]

const FrTOCData::nfirstadc_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstADC ( ) const
inline

◆ GetNFirstADC() [2/2]

const nfirstadc_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstADC ( ) const

◆ GetNFirstMsg() [1/2]

const FrTOCData::nfirstmsg_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstMsg ( ) const
inline

◆ GetNFirstMsg() [2/2]

const nfirstmsg_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstMsg ( ) const

◆ GetNFirstSer() [1/2]

const FrTOCData::nfirstser_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstSer ( ) const
inline

◆ GetNFirstSer() [2/2]

const nfirstser_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstSer ( ) const

◆ GetNFirstTable() [1/2]

const FrTOCData::nfirsttable_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstTable ( ) const
inline

◆ GetNFirstTable() [2/2]

const nfirsttable_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstTable ( ) const

◆ GetNFrame() [1/2]

FrTOCData::nframe_type FrameCPP::Version_6::FrTOCData::GetNFrame ( ) const
inline

◆ GetNFrame() [2/2]

nframe_type FrameCPP::Version_6::FrTOCData::GetNFrame ( ) const

◆ GetPositionDetector() [1/2]

const FrTOCData::positiondetector_container_type & FrameCPP::Version_6::FrTOCData::GetPositionDetector ( ) const
inline

◆ GetPositionDetector() [2/2]

const positiondetector_container_type & FrameCPP::Version_6::FrTOCData::GetPositionDetector ( ) const

◆ GetPositionH() [1/2]

const FrTOCData::positionh_container_type & FrameCPP::Version_6::FrTOCData::GetPositionH ( ) const
inline

◆ GetPositionH() [2/2]

const positionh_container_type & FrameCPP::Version_6::FrTOCData::GetPositionH ( ) const

◆ GetRuns() [1/2]

const FrTOCData::runs_container_type & FrameCPP::Version_6::FrTOCData::GetRuns ( ) const
inline

◆ GetRuns() [2/2]

const runs_container_type & FrameCPP::Version_6::FrTOCData::GetRuns ( ) const

◆ GetSHid() [1/2]

const FrTOCData::shid_container_type & FrameCPP::Version_6::FrTOCData::GetSHid ( ) const
inline

◆ GetSHid() [2/2]

const shid_container_type & FrameCPP::Version_6::FrTOCData::GetSHid ( ) const

◆ GetSHname() [1/2]

const FrTOCData::shname_container_type & FrameCPP::Version_6::FrTOCData::GetSHname ( ) const
inline

◆ GetSHname() [2/2]

const shname_container_type & FrameCPP::Version_6::FrTOCData::GetSHname ( ) const

◆ GetULeapS() [1/2]

FrTOCData::uleaps_type FrameCPP::Version_6::FrTOCData::GetULeapS ( ) const
inline

◆ GetULeapS() [2/2]

uleaps_type FrameCPP::Version_6::FrTOCData::GetULeapS ( ) const

◆ load() [1/2]

void FrameCPP::Version_6::FrTOCData::load ( Common::IStream Stream)
protected

◆ load() [2/2]

void FrameCPP::Version_6::FrTOCData::load ( Common::IStream Stream)
protected

◆ operator==() [1/2]

bool FrameCPP::Version_6::FrTOCData::operator== ( const FrTOCData RHS) const
inline

◆ operator==() [2/2]

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

◆ write() [1/2]

void FrameCPP::Version_6::FrTOCData::write ( Common::OStream Stream) const
protected

◆ write() [2/2]

void FrameCPP::Version_6::FrTOCData::write ( Common::OStream Stream) const
protected

Member Data Documentation

◆ m_dataQuality

data_quality_container_type FrameCPP::Version_6::FrTOCData::m_dataQuality
protected

◆ m_dt

dt_container_type FrameCPP::Version_6::FrTOCData::m_dt
protected

◆ m_frame

frame_container_type FrameCPP::Version_6::FrTOCData::m_frame
protected

◆ m_GTimeN

gtimen_container_type FrameCPP::Version_6::FrTOCData::m_GTimeN
protected

◆ m_GTimeS

gtimes_container_type FrameCPP::Version_6::FrTOCData::m_GTimeS
protected

◆ m_nameDetector

namedetector_container_type FrameCPP::Version_6::FrTOCData::m_nameDetector
protected

◆ m_nFirstADC

nfirstadc_container_type FrameCPP::Version_6::FrTOCData::m_nFirstADC
protected

◆ m_nFirstMsg

nfirstmsg_container_type FrameCPP::Version_6::FrTOCData::m_nFirstMsg
protected

◆ m_nFirstSer

nfirstser_container_type FrameCPP::Version_6::FrTOCData::m_nFirstSer
protected

◆ m_nFirstTable

nfirsttable_container_type FrameCPP::Version_6::FrTOCData::m_nFirstTable
protected

◆ m_positionDetector

positiondetector_container_type FrameCPP::Version_6::FrTOCData::m_positionDetector
protected

◆ m_positionH

positionh_container_type FrameCPP::Version_6::FrTOCData::m_positionH
protected

◆ m_runs

runs_container_type FrameCPP::Version_6::FrTOCData::m_runs
protected

◆ m_SHid

shid_container_type FrameCPP::Version_6::FrTOCData::m_SHid
protected

◆ m_SHname

shname_container_type FrameCPP::Version_6::FrTOCData::m_SHname
protected

◆ m_ULeapS

uleaps_type FrameCPP::Version_6::FrTOCData::m_ULeapS
protected

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