ldas-tools-framecpp  2.6.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrTOCData Class Reference

Helper class for data portion of the FrTOC structure. More...

#include <FrTOCData.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOCData:
FrameCPP::Version_8::FrTOC

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 FR_TOC_NFRAME_TYPE 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 FR_TOC_ULEAPS_TYPE uleaps_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 Array of integer QA words from each FrameH. More...
 
typedef std::vector< dt_typedt_container_type
 Array of frame durations in seconds. More...
 
typedef std::vector< frame_typeframe_container_type
 Array of frame numbers. More...
 
typedef std::vector< gtimen_typegtimen_container_type
 Array of integer GPS residual nanoseconds for the frame. More...
 
typedef std::vector< gtimes_typegtimes_container_type
 Array of integer GPS frame times. More...
 
typedef std::vector< namedetector_typenamedetector_container_type
 Array of FrDetector names. More...
 
typedef std::vector< nfirstadc_typenfirstadc_container_type
 Array of first FrADCData positions. More...
 
typedef std::vector< nfirstmsg_typenfirstmsg_container_type
 Array of first FrMsg positions. More...
 
typedef std::vector< nfirstser_typenfirstser_container_type
 Array of first FrSerData positions. More...
 
typedef std::vector< nfirsttable_typenfirsttable_container_type
 Array of first FrTable positions. More...
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 Array of FrDetector positions. More...
 
typedef std::vector< positionh_typepositionh_container_type
 Array of FrSH IDs. More...
 
typedef std::vector< runs_typeruns_container_type
 Array of FrameH positions. More...
 
typedef std::vector< shid_typeshid_container_type
 Array of FrSH IDs. More...
 
typedef std::vector< shname_typeshname_container_type
 Array of FrSH names. More...
 

Public Member Functions

 FrTOCData ()
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const data_quality_container_typeGetDataQuality () const
 Retreive array of integer QA words from each FrameH. More...
 
const dt_container_typeGetDt () const
 Retrieve array of frame durations in seconds. More...
 
const frame_container_typeGetFrame () const
 Retrieve array of frame numbers. More...
 
const gtimes_container_typeGetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame. More...
 
const gtimen_container_typeGetGTimeS () const
 Retrieve array of integer GPS frame times. More...
 
const nfirstadc_container_typeGetNFirstADC () const
 Retrieve array of first FrADCData positions. More...
 
const nfirstmsg_container_typeGetNFirstMsg () const
 Retrieve array of first FrMsg positions. More...
 
const nfirstser_container_typeGetNFirstSer () const
 Retrieve array of first FrSerData positions. More...
 
const nfirsttable_container_typeGetNFirstTable () const
 Retrieve array of first FrTable positions. More...
 
nFrame_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions. More...
 
const runs_container_typeGetRuns () const
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs. More...
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names. More...
 
uleaps_type GetULeapS () const
 Retrieve the number of leap seconds. More...
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names. More...
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions. More...
 
const FrTOCDataoperator= (const Previous::FrTOCData &Source)
 asignment operator More...
 
bool operator== (const FrTOCData &RHS) const
 equality operator More...
 

Static Public Member Functions

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

Protected Member Functions

 FrTOCData (Common::IStream &Stream)
 Stream Constructor. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

uleaps_type m_ULeapS
 From the first FrameH in the file. More...
 
data_quality_container_type m_dataQuality
 Array of integer QA words from each FrameH (size of nFrame) More...
 
gtimes_container_type m_GTimeS
 Array of integer GPS frame times (size of nFrame). More...
 
gtimen_container_type m_GTimeN
 Array of integer GPS residual nanoseconds for the frame (size of nFrame). More...
 
dt_container_type m_dt
 Array of frame durations in seconds (size of nFrame). More...
 
runs_container_type m_runs
 Array of run numbers. More...
 
frame_container_type m_frame
 Array of frame numbers (size of nFrame). More...
 
positiondetector_container_type m_positionDetector
 Array of FrDetector positions. More...
 
positionh_container_type m_positionH
 Array of FrameH positions, in bytes, from beginning of file. The size of this array is specified by nFrame. More...
 
namedetector_container_type m_nameDetector
 Array of FrDetector names. More...
 
nfirstadc_container_type m_nFirstADC
 Array of first FrADCData positions. More...
 
nfirstser_container_type m_nFirstSer
 Array of first FrSerData positions. More...
 
nfirsttable_container_type m_nFirstTable
 Array of first FrTable positions. More...
 
nfirstmsg_container_type m_nFirstMsg
 Array of first FrMsg positions. More...
 
shid_container_type m_SHid
 Array of FrSH IDs. More...
 
shname_container_type m_SHname
 Array of FrSH names. The size of array is specified by nSH. More...
 

Detailed Description

Helper class for data portion of the FrTOC structure.

Member Typedef Documentation

◆ data_quality_container_type

Array of integer QA words from each FrameH.

◆ data_quality_type

◆ dt_container_type

Array of frame durations in seconds.

◆ dt_type

◆ frame_container_type

Array of frame numbers.

◆ frame_type

◆ gtimen_container_type

Array of integer GPS residual nanoseconds for the frame.

◆ gtimen_type

◆ gtimes_container_type

Array of integer GPS frame times.

◆ gtimes_type

◆ namedetector_container_type

Array of FrDetector names.

◆ namedetector_type

◆ ndetector_type

◆ nfirstadc_container_type

Array of first FrADCData positions.

◆ nfirstadc_type

◆ nfirstmsg_container_type

Array of first FrMsg positions.

◆ nfirstmsg_type

◆ nfirstser_container_type

Array of first FrSerData positions.

◆ nfirstser_type

◆ nfirsttable_container_type

Array of first FrTable positions.

◆ nfirsttable_type

◆ nFrame_type

◆ nsh_type

◆ positiondetector_container_type

Array of FrDetector positions.

◆ positiondetector_type

◆ positionh_container_type

Array of FrSH IDs.

◆ positionh_type

◆ runs_container_type

Array of FrameH positions.

◆ runs_type

◆ shid_container_type

Array of FrSH IDs.

◆ shid_type

◆ shname_container_type

Array of FrSH names.

◆ shname_type

◆ uleaps_type

Constructor & Destructor Documentation

◆ FrTOCData() [1/2]

FrameCPP::Version_8::FrTOCData::FrTOCData ( )
inline

◆ FrTOCData() [2/2]

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

Stream Constructor.

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

Member Function Documentation

◆ Bytes()

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

◆ Description()

template<typename SE >
void FrameCPP::Version_8::FrTOCData::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()

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

◆ GetDataQuality()

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

Retreive array of integer QA words from each FrameH.

◆ GetDt()

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

Retrieve array of frame durations in seconds.

◆ GetFrame()

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

Retrieve array of frame numbers.

◆ GetGTimeN()

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

Retrieve array of integer GPS residual nanoseconds for the frame.

◆ GetGTimeS()

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

Retrieve array of integer GPS frame times.

◆ GetNameDetector()

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

Retrieve array of FrDetector names.

◆ GetNFirstADC()

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

Retrieve array of first FrADCData positions.

◆ GetNFirstMsg()

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

Retrieve array of first FrMsg positions.

◆ GetNFirstSer()

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

Retrieve array of first FrSerData positions.

◆ GetNFirstTable()

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

Retrieve array of first FrTable positions.

◆ GetNFrame()

FrTOCData::nFrame_type FrameCPP::Version_8::FrTOCData::GetNFrame ( ) const
inline

◆ GetPositionDetector()

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

Retrieve array of FrDetector positions.

◆ GetPositionH()

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

Retrieve array of FrameH positions.

◆ GetRuns()

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

◆ GetSHid()

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

Retrieve array of FrSH IDs.

◆ GetSHname()

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

Retrieve array of FrSH names.

◆ GetULeapS()

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

Retrieve the number of leap seconds.

◆ operator=()

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==()

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

equality operator

Parameters
[in]RHSThe FrTOCData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ write()

void FrameCPP::Version_8::FrTOCData::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_dataQuality

data_quality_container_type FrameCPP::Version_8::FrTOCData::m_dataQuality
protected

Array of integer QA words from each FrameH (size of nFrame)

◆ m_dt

dt_container_type FrameCPP::Version_8::FrTOCData::m_dt
protected

Array of frame durations in seconds (size of nFrame).

◆ m_frame

frame_container_type FrameCPP::Version_8::FrTOCData::m_frame
protected

Array of frame numbers (size of nFrame).

◆ m_GTimeN

gtimen_container_type FrameCPP::Version_8::FrTOCData::m_GTimeN
protected

Array of integer GPS residual nanoseconds for the frame (size of nFrame).

◆ m_GTimeS

gtimes_container_type FrameCPP::Version_8::FrTOCData::m_GTimeS
protected

Array of integer GPS frame times (size of nFrame).

◆ m_nameDetector

namedetector_container_type FrameCPP::Version_8::FrTOCData::m_nameDetector
protected

Array of FrDetector names.

The size of this array is specified by nDetector. They appear alphabetically.

◆ m_nFirstADC

nfirstadc_container_type FrameCPP::Version_8::FrTOCData::m_nFirstADC
protected

Array of first FrADCData positions.

Array of first FrADCData positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_nFirstMsg

nfirstmsg_container_type FrameCPP::Version_8::FrTOCData::m_nFirstMsg
protected

Array of first FrMsg positions.

Array of first FrMsg positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_nFirstSer

nfirstser_container_type FrameCPP::Version_8::FrTOCData::m_nFirstSer
protected

Array of first FrSerData positions.

Array of first FrSerData positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_nFirstTable

nfirsttable_container_type FrameCPP::Version_8::FrTOCData::m_nFirstTable
protected

Array of first FrTable positions.

Array of first FrTable positions, in bytes, from beginning of file The size of this array is specified by nFrame.

Note
The pointer is to the first table associated with FrRawData for each frame.

◆ m_positionDetector

positiondetector_container_type FrameCPP::Version_8::FrTOCData::m_positionDetector
protected

Array of FrDetector positions.

Array of FrDetector positions from the beginning of file. The size of array is specified by nDetector.

Note
Only the first occurrence for each type of FrDetector is captured.

◆ m_positionH

positionh_container_type FrameCPP::Version_8::FrTOCData::m_positionH
protected

Array of FrameH positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_runs

runs_container_type FrameCPP::Version_8::FrTOCData::m_runs
protected

Array of run numbers.

Array of run numbers. The size of this array is specified by nFrame.

◆ m_SHid

shid_container_type FrameCPP::Version_8::FrTOCData::m_SHid
protected

Array of FrSH IDs.

Array of FrSH IDs. The size of this array is specified by nSH.

◆ m_SHname

shname_container_type FrameCPP::Version_8::FrTOCData::m_SHname
protected

Array of FrSH names. The size of array is specified by nSH.

◆ m_ULeapS

uleaps_type FrameCPP::Version_8::FrTOCData::m_ULeapS
protected

From the first FrameH in the file.


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