ldas-tools-framecpp  2.7.0
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:
Inheritance graph
[legend]

Public Types

typedef std::vector< data_quality_type > data_quality_container_type
 Array of integer QA words from each FrameH.
 
typedef std::vector< dt_type > dt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< frame_type > frame_container_type
 Array of frame numbers.
 
typedef std::vector< gtimen_type > gtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
typedef std::vector< gtimes_type > gtimes_container_type
 Array of integer GPS frame times.
 
typedef std::vector< namedetector_type > namedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< nfirstadc_type > nfirstadc_container_type
 Array of first FrADCData positions.
 
typedef std::vector< nfirstmsg_type > nfirstmsg_container_type
 Array of first FrMsg positions.
 
typedef std::vector< nfirstser_type > nfirstser_container_type
 Array of first FrSerData positions.
 
typedef std::vector< nfirsttable_type > nfirsttable_container_type
 Array of first FrTable positions.
 
typedef std::vector< positiondetector_type > positiondetector_container_type
 Array of FrDetector positions.
 
typedef std::vector< positionh_type > positionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< runs_type > runs_container_type
 Array of FrameH positions.
 
typedef std::vector< shid_type > shid_container_type
 Array of FrSH IDs.
 
typedef std::vector< shname_type > shname_container_type
 Array of FrSH names.
 
typedef std::vector< data_quality_type > data_quality_container_type
 Array of integer QA words from each FrameH.
 
typedef std::vector< dt_type > dt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< frame_type > frame_container_type
 Array of frame numbers.
 
typedef std::vector< gtimen_type > gtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
typedef std::vector< gtimes_type > gtimes_container_type
 Array of integer GPS frame times.
 
typedef std::vector< namedetector_type > namedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< nfirstadc_type > nfirstadc_container_type
 Array of first FrADCData positions.
 
typedef std::vector< nfirstmsg_type > nfirstmsg_container_type
 Array of first FrMsg positions.
 
typedef std::vector< nfirstser_type > nfirstser_container_type
 Array of first FrSerData positions.
 
typedef std::vector< nfirsttable_type > nfirsttable_container_type
 Array of first FrTable positions.
 
typedef std::vector< positiondetector_type > positiondetector_container_type
 Array of FrDetector positions.
 
typedef std::vector< positionh_type > positionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< runs_type > runs_container_type
 Array of FrameH positions.
 
typedef std::vector< shid_type > shid_container_type
 Array of FrSH IDs.
 
typedef std::vector< shname_type > shname_container_type
 Array of FrSH names.
 

Public Member Functions

const data_quality_container_typeGetDataQuality () const
 Retreive array of integer QA words from each FrameH.
 
const dt_container_typeGetDt () const
 Retrieve array of frame durations in seconds.
 
const frame_container_typeGetFrame () const
 Retrieve array of frame numbers.
 
const gtimes_container_typeGetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame.
 
const gtimen_container_typeGetGTimeS () const
 Retrieve array of integer GPS frame times.
 
const nfirstadc_container_typeGetNFirstADC () const
 Retrieve array of first FrADCData positions.
 
const nfirstmsg_container_typeGetNFirstMsg () const
 Retrieve array of first FrMsg positions.
 
const nfirstser_container_typeGetNFirstSer () const
 Retrieve array of first FrSerData positions.
 
const nfirsttable_container_typeGetNFirstTable () const
 Retrieve array of first FrTable positions.
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
uleaps_type GetULeapS () const
 Retrieve the number of leap seconds.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
const FrTOCDataoperator= (const Previous::FrTOCData &Source)
 asignment operator More...
 
bool operator== (const FrTOCData &RHS) const
 equality operator More...
 
const data_quality_container_typeGetDataQuality () const
 Retreive array of integer QA words from each FrameH.
 
const dt_container_typeGetDt () const
 Retrieve array of frame durations in seconds.
 
const frame_container_typeGetFrame () const
 Retrieve array of frame numbers.
 
const gtimes_container_typeGetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame.
 
const gtimen_container_typeGetGTimeS () const
 Retrieve array of integer GPS frame times.
 
const nfirstadc_container_typeGetNFirstADC () const
 Retrieve array of first FrADCData positions.
 
const nfirstmsg_container_typeGetNFirstMsg () const
 Retrieve array of first FrMsg positions.
 
const nfirstser_container_typeGetNFirstSer () const
 Retrieve array of first FrSerData positions.
 
const nfirsttable_container_typeGetNFirstTable () const
 Retrieve array of first FrTable positions.
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
uleaps_type GetULeapS () const
 Retrieve the number of leap seconds.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
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...
 
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...
 
 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.
 
data_quality_container_type m_dataQuality
 Array of integer QA words from each FrameH (size of nFrame)
 
gtimes_container_type m_GTimeS
 Array of integer GPS frame times (size of nFrame).
 
gtimen_container_type m_GTimeN
 Array of integer GPS residual nanoseconds for the frame (size of nFrame).
 
dt_container_type m_dt
 Array of frame durations in seconds (size of nFrame).
 
runs_container_type m_runs
 Array of run numbers. More...
 
frame_container_type m_frame
 Array of frame numbers (size of nFrame).
 
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.
 
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.
 

Detailed Description

Helper class for data portion of the FrTOC structure.

Constructor & Destructor Documentation

◆ FrTOCData() [1/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.

◆ 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

◆ Description() [1/2]

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.

◆ Description() [2/2]

template<typename SE >
static 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() [1/2]

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.

◆ forEach() [2/2]

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.

◆ operator=() [1/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/2]

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

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator==() [1/2]

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.

◆ operator==() [2/2]

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

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() [1/2]

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.

◆ write() [2/2]

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_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_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.


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