ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_4::FrTOCData Class Reference

#include <FrTOCData.hh>

Inheritance diagram for FrameCPP::Version_4::FrTOCData:
Collaboration diagram for FrameCPP::Version_4::FrTOCData:

Public Types

typedef INT_2S uleaps_type
 
typedef INT_4S localTime_type
 
typedef INT_4U nframe_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef REAL_8 dt_type
 
typedef INT_4S runs_type
 
typedef INT_4U frame_type
 
typedef INT_4U nsh_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< dt_typedt_container_type
 Array of FrDetector names.
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< position_typepositionH_container_type
 
typedef std::vector< position_typenFirstADC_container_type
 
typedef std::vector< position_typenFirstSer_container_type
 
typedef std::vector< position_typenFirstTable_container_type
 
typedef std::vector< position_typenFirstMsg_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef INT_2S uleaps_type
 
typedef INT_4S localTime_type
 
typedef INT_4U nframe_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef REAL_8 dt_type
 
typedef INT_4S runs_type
 
typedef INT_4U frame_type
 
typedef INT_4U nsh_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< dt_typedt_container_type
 Array of FrDetector names.
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< position_typepositionH_container_type
 
typedef std::vector< position_typenFirstADC_container_type
 
typedef std::vector< position_typenFirstSer_container_type
 
typedef std::vector< position_typenFirstTable_container_type
 
typedef std::vector< position_typenFirstMsg_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef INT_8U position_type
 
typedef INT_8U position_type
 

Public Member Functions

 FrTOCData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
localTime_type GetLocalTime () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
nframe_type GetNFrame () const
 
const nFirstADC_container_typeGetNFirstADC () const
 
const nFirstSer_container_typeGetNFirstSer () const
 
const nFirstTable_container_typeGetNFirstTable () const
 
const nFirstMsg_container_typeGetNFirstMsg () 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
 
bool operator== (const FrTOCData &RHS) const
 
 FrTOCData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
localTime_type GetLocalTime () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
nframe_type GetNFrame () const
 
const nFirstADC_container_typeGetNFirstADC () const
 
const nFirstSer_container_typeGetNFirstSer () const
 
const nFirstTable_container_typeGetNFirstTable () const
 
const nFirstMsg_container_typeGetNFirstMsg () 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
 
bool operator== (const FrTOCData &RHS) const
 

Static Public Member Functions

static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 

Protected Member Functions

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

Protected Attributes

uleaps_type m_ULeapS
 
localTime_type m_localTime
 
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
 
positionH_container_type m_positionH
 
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

◆ 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]

◆ localTime_type [1/2]

◆ localTime_type [2/2]

◆ nFirstADC_container_type [1/2]

◆ nFirstADC_container_type [2/2]

◆ nFirstMsg_container_type [1/2]

◆ nFirstMsg_container_type [2/2]

◆ nFirstSer_container_type [1/2]

◆ nFirstSer_container_type [2/2]

◆ nFirstTable_container_type [1/2]

◆ nFirstTable_container_type [2/2]

◆ nframe_type [1/2]

◆ nframe_type [2/2]

◆ nsh_type [1/2]

◆ nsh_type [2/2]

◆ position_type [1/2]

◆ position_type [2/2]

◆ positionH_container_type [1/2]

◆ positionH_container_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_4::FrTOCData::FrTOCData ( )
inline

◆ FrTOCData() [2/4]

FrameCPP::Version_4::FrTOCData::FrTOCData ( Common::IStream & Stream)
protected

◆ FrTOCData() [3/4]

FrameCPP::Version_4::FrTOCData::FrTOCData ( )

◆ FrTOCData() [4/4]

FrameCPP::Version_4::FrTOCData::FrTOCData ( Common::IStream & Stream)
protected

Member Function Documentation

◆ Bytes() [1/2]

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

◆ Bytes() [2/2]

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

◆ Description() [1/2]

void FrameCPP::Version_4::FrTOCData::Description ( Common::Description & Desc)
static

◆ Description() [2/2]

static void FrameCPP::Version_4::FrTOCData::Description ( Common::Description & Desc)
static

◆ forEach() [1/2]

void FrameCPP::Version_4::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_4::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.

◆ GetDt() [1/2]

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

◆ GetDt() [2/2]

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

◆ GetFrame() [1/2]

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

◆ GetFrame() [2/2]

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

◆ GetGTimeN() [1/2]

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

◆ GetGTimeN() [2/2]

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

◆ GetGTimeS() [1/2]

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

◆ GetGTimeS() [2/2]

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

◆ GetLocalTime() [1/2]

FrTOCData::localTime_type FrameCPP::Version_4::FrTOCData::GetLocalTime ( ) const
inline

◆ GetLocalTime() [2/2]

localTime_type FrameCPP::Version_4::FrTOCData::GetLocalTime ( ) const

◆ GetNFirstADC() [1/2]

const FrTOCData::nFirstADC_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstADC ( ) const
inline

◆ GetNFirstADC() [2/2]

const nFirstADC_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstADC ( ) const

◆ GetNFirstMsg() [1/2]

const FrTOCData::nFirstMsg_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstMsg ( ) const
inline

◆ GetNFirstMsg() [2/2]

const nFirstMsg_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstMsg ( ) const

◆ GetNFirstSer() [1/2]

const FrTOCData::nFirstSer_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstSer ( ) const
inline

◆ GetNFirstSer() [2/2]

const nFirstSer_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstSer ( ) const

◆ GetNFirstTable() [1/2]

const FrTOCData::nFirstTable_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstTable ( ) const
inline

◆ GetNFirstTable() [2/2]

const nFirstTable_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstTable ( ) const

◆ GetNFrame() [1/2]

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

◆ GetNFrame() [2/2]

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

◆ GetPositionH() [1/2]

const FrTOCData::positionH_container_type & FrameCPP::Version_4::FrTOCData::GetPositionH ( ) const
inline

◆ GetPositionH() [2/2]

const positionH_container_type & FrameCPP::Version_4::FrTOCData::GetPositionH ( ) const

◆ GetRuns() [1/2]

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

◆ GetRuns() [2/2]

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

◆ GetSHid() [1/2]

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

◆ GetSHid() [2/2]

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

◆ GetSHname() [1/2]

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

◆ GetSHname() [2/2]

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

◆ GetULeapS() [1/2]

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

◆ GetULeapS() [2/2]

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

◆ load() [1/2]

void FrameCPP::Version_4::FrTOCData::load ( Common::IStream & Stream)
protected

◆ load() [2/2]

void FrameCPP::Version_4::FrTOCData::load ( Common::IStream & Stream)
protected

◆ operator==() [1/2]

bool FrameCPP::Version_4::FrTOCData::operator== ( const FrTOCData & RHS) const
inline

◆ operator==() [2/2]

bool FrameCPP::Version_4::FrTOCData::operator== ( const FrTOCData & RHS) const

◆ write() [1/2]

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

◆ write() [2/2]

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

Member Data Documentation

◆ m_dt

dt_container_type FrameCPP::Version_4::FrTOCData::m_dt
protected

◆ m_frame

frame_container_type FrameCPP::Version_4::FrTOCData::m_frame
protected

◆ m_GTimeN

gtimen_container_type FrameCPP::Version_4::FrTOCData::m_GTimeN
protected

◆ m_GTimeS

gtimes_container_type FrameCPP::Version_4::FrTOCData::m_GTimeS
protected

◆ m_localTime

localTime_type FrameCPP::Version_4::FrTOCData::m_localTime
protected

◆ m_nFirstADC

nFirstADC_container_type FrameCPP::Version_4::FrTOCData::m_nFirstADC
protected

◆ m_nFirstMsg

nFirstMsg_container_type FrameCPP::Version_4::FrTOCData::m_nFirstMsg
protected

◆ m_nFirstSer

nFirstSer_container_type FrameCPP::Version_4::FrTOCData::m_nFirstSer
protected

◆ m_nFirstTable

nFirstTable_container_type FrameCPP::Version_4::FrTOCData::m_nFirstTable
protected

◆ m_positionH

positionH_container_type FrameCPP::Version_4::FrTOCData::m_positionH
protected

◆ m_runs

runs_container_type FrameCPP::Version_4::FrTOCData::m_runs
protected

◆ m_SHid

shid_container_type FrameCPP::Version_4::FrTOCData::m_SHid
protected

◆ m_SHname

shname_container_type FrameCPP::Version_4::FrTOCData::m_SHname
protected

◆ m_ULeapS

uleaps_type FrameCPP::Version_4::FrTOCData::m_ULeapS
protected

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