ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO Class Reference

#include <FrTOCDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO:
Collaboration diagram for FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO:

Public Types

typedef INT_4U data_quality_type
 
typedef INT_4U data_quality_type
 
typedef REAL_8 dt_type
 
typedef REAL_8 dt_type
 
typedef std::string file_base_name_type
 
typedef std::string file_base_name_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef INT_4U gtimes_type
 
typedef std::string namedetector_type
 
typedef std::string namedetector_type
 
typedef INT_4U ndetector_type
 
typedef INT_4U ndetector_type
 
typedef FR_TOC_NFRAME_TYPE nFrame_type
 
typedef FR_TOC_NFRAME_TYPE nFrame_type
 
typedef INT_4U nsh_type
 
typedef INT_4U nsh_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positionh_type
 
typedef INT_8U positionh_type
 
typedef INT_2U shid_type
 
typedef INT_2U shid_type
 
typedef std::string shname_type
 
typedef std::string shname_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 Array of integer QA words from each FrameH.
 
typedef std::vector< data_quality_typedata_quality_container_type
 Array of integer QA words from each FrameH.
 
typedef std::vector< dt_typedt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< dt_typedt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< gtimen_typegtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
typedef std::vector< gtimen_typegtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
typedef std::vector< gtimes_typegtimes_container_type
 Array of integer GPS frame times.
 
typedef std::vector< gtimes_typegtimes_container_type
 Array of integer GPS frame times.
 
typedef std::vector< namedetector_typenamedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< namedetector_typenamedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 Array of FrDetector positions.
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 Array of FrDetector positions.
 
typedef std::vector< positionh_typepositionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< positionh_typepositionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< shid_typeshid_container_type
 Array of FrSH IDs.
 
typedef std::vector< shid_typeshid_container_type
 Array of FrSH IDs.
 
typedef std::vector< shname_typeshname_container_type
 Array of FrSH names.
 
typedef std::vector< shname_typeshname_container_type
 Array of FrSH names.
 

Public Member Functions

 FrTOCDataClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const FrTOCDataClassicIOoperator= (const Previous::FrTOCImpl::FrTOCDataClassicIO &Source)
 asignment operator
 
FrTOCDataClassicIOoperator= (FrTOCDataClassicIO &&TOC)
 
void Load (istream_type &Stream)
 Read contents from stream.
 
 FrTOCDataClassicIO ()=default
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
const FrTOCDataClassicIOoperator= (const Previous::FrTOCImpl::FrTOCDataClassicIO &Source)
 asignment operator
 
FrTOCDataClassicIOoperator= (FrTOCDataClassicIO &&TOC)
 
void Load (istream_type &Stream)
 Read contents from stream.
 
const file_base_name_typeGetFileBaseName () const
 Retrieve file base name at time of creation.
 
const file_base_name_typeGetFileBaseName () const
 Retrieve file base name at time of creation.
 
const data_quality_container_typeGetDataQuality () const
 Retreive array of integer QA words from each FrameH.
 
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 dt_container_typeGetDt () const
 Retrieve array of frame durations in seconds.
 
const gtimes_container_typeGetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame.
 
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 gtimen_container_typeGetGTimeS () const
 Retrieve array of integer GPS frame times.
 
nFrame_type GetNFrame () const
 
nFrame_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
void SetFileBaseName (const file_base_name_type &Source) const
 Set file base name.
 
void SetFileBaseName (const file_base_name_type &Source) const
 Set file base name.
 
bool operator== (const FrTOCHeader &RHS) const
 equality operator
 
bool operator== (const FrTOCHeader &RHS) const
 equality operator
 

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

file_base_name_type fileBaseName
 The name of the file at the time of creation.
 
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).
 
positiondetector_container_type m_positionDetector
 Array of FrDetector positions.
 
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.
 
shid_container_type m_SHid
 Array of FrSH IDs.
 
shname_container_type m_SHname
 Array of FrSH names. The size of array is specified by nSH.
 

Private Types

typedef STRING io_namedetector_type
 
typedef STRING io_shname_type
 
typedef STRING io_namedetector_type
 
typedef STRING io_shname_type
 

Member Typedef Documentation

◆ data_quality_container_type [1/2]

Array of integer QA words from each FrameH.

◆ data_quality_container_type [2/2]

Array of integer QA words from each FrameH.

◆ data_quality_type [1/2]

◆ data_quality_type [2/2]

◆ dt_container_type [1/2]

typedef std::vector< dt_type > FrameCPP::v9::FrTOCHeader::dt_container_type
inherited

Array of frame durations in seconds.

◆ dt_container_type [2/2]

typedef std::vector< dt_type > FrameCPP::v9::FrTOCHeader::dt_container_type
inherited

Array of frame durations in seconds.

◆ dt_type [1/2]

typedef REAL_8 FrameCPP::v9::FrTOCHeader::dt_type
inherited

◆ dt_type [2/2]

typedef REAL_8 FrameCPP::v9::FrTOCHeader::dt_type
inherited

◆ file_base_name_type [1/2]

typedef std::string FrameCPP::v9::FrTOCHeader::file_base_name_type
inherited

◆ file_base_name_type [2/2]

typedef std::string FrameCPP::v9::FrTOCHeader::file_base_name_type
inherited

◆ gtimen_container_type [1/2]

Array of integer GPS residual nanoseconds for the frame.

◆ gtimen_container_type [2/2]

Array of integer GPS residual nanoseconds for the frame.

◆ gtimen_type [1/2]

typedef INT_4U FrameCPP::v9::FrTOCHeader::gtimen_type
inherited

◆ gtimen_type [2/2]

typedef INT_4U FrameCPP::v9::FrTOCHeader::gtimen_type
inherited

◆ gtimes_container_type [1/2]

Array of integer GPS frame times.

◆ gtimes_container_type [2/2]

Array of integer GPS frame times.

◆ gtimes_type [1/2]

typedef INT_4U FrameCPP::v9::FrTOCHeader::gtimes_type
inherited

◆ gtimes_type [2/2]

typedef INT_4U FrameCPP::v9::FrTOCHeader::gtimes_type
inherited

◆ io_namedetector_type [1/2]

◆ io_namedetector_type [2/2]

◆ io_shname_type [1/2]

◆ io_shname_type [2/2]

◆ namedetector_container_type [1/2]

◆ namedetector_container_type [2/2]

◆ namedetector_type [1/2]

typedef std::string FrameCPP::v9::FrTOCHeader::namedetector_type
inherited

◆ namedetector_type [2/2]

typedef std::string FrameCPP::v9::FrTOCHeader::namedetector_type
inherited

◆ ndetector_type [1/2]

◆ ndetector_type [2/2]

◆ nFrame_type [1/2]

◆ nFrame_type [2/2]

◆ nsh_type [1/2]

typedef INT_4U FrameCPP::v9::FrTOCHeader::nsh_type
inherited

◆ nsh_type [2/2]

typedef INT_4U FrameCPP::v9::FrTOCHeader::nsh_type
inherited

◆ positiondetector_container_type [1/2]

◆ positiondetector_container_type [2/2]

◆ positiondetector_type [1/2]

◆ positiondetector_type [2/2]

◆ positionh_container_type [1/2]

Array of FrSH IDs.

◆ positionh_container_type [2/2]

Array of FrSH IDs.

◆ positionh_type [1/2]

◆ positionh_type [2/2]

◆ shid_container_type [1/2]

Array of FrSH IDs.

◆ shid_container_type [2/2]

Array of FrSH IDs.

◆ shid_type [1/2]

typedef INT_2U FrameCPP::v9::FrTOCHeader::shid_type
inherited

◆ shid_type [2/2]

typedef INT_2U FrameCPP::v9::FrTOCHeader::shid_type
inherited

◆ shname_container_type [1/2]

Array of FrSH names.

◆ shname_container_type [2/2]

Array of FrSH names.

◆ shname_type [1/2]

typedef std::string FrameCPP::v9::FrTOCHeader::shname_type
inherited

◆ shname_type [2/2]

typedef std::string FrameCPP::v9::FrTOCHeader::shname_type
inherited

Constructor & Destructor Documentation

◆ FrTOCDataClassicIO() [1/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::FrTOCDataClassicIO ( )
default

◆ FrTOCDataClassicIO() [2/2]

FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::FrTOCDataClassicIO ( )
default

Member Function Documentation

◆ Bytes() [1/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Bytes ( const Common::StreamBase & Stream) const
inline

◆ Bytes() [2/2]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Bytes ( const Common::StreamBase & Stream) const
inline

◆ Description() [1/2]

template<typename SE>
static void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Description ( Common::Description & Desc)
inlinestatic

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_9::FrTOCImpl::FrTOCDataClassicIO::Description ( Common::Description & Desc)
inlinestatic

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_9::FrTOCImpl::FrTOCDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotected

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ forEach() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotected

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 data_quality_container_type & FrameCPP::v9::FrTOCHeader::GetDataQuality ( ) const
inlineinherited

Retreive array of integer QA words from each FrameH.

◆ GetDataQuality() [2/2]

const data_quality_container_type & FrameCPP::v9::FrTOCHeader::GetDataQuality ( ) const
inlineinherited

Retreive array of integer QA words from each FrameH.

◆ GetDt() [1/2]

const dt_container_type & FrameCPP::v9::FrTOCHeader::GetDt ( ) const
inlineinherited

Retrieve array of frame durations in seconds.

◆ GetDt() [2/2]

const dt_container_type & FrameCPP::v9::FrTOCHeader::GetDt ( ) const
inlineinherited

Retrieve array of frame durations in seconds.

◆ GetFileBaseName() [1/2]

const file_base_name_type & FrameCPP::v9::FrTOCHeader::GetFileBaseName ( ) const
inlineinherited

Retrieve file base name at time of creation.

◆ GetFileBaseName() [2/2]

const file_base_name_type & FrameCPP::v9::FrTOCHeader::GetFileBaseName ( ) const
inlineinherited

Retrieve file base name at time of creation.

◆ GetGTimeN() [1/2]

const gtimes_container_type & FrameCPP::v9::FrTOCHeader::GetGTimeN ( ) const
inlineinherited

Retrieve array of integer GPS residual nanoseconds for the frame.

◆ GetGTimeN() [2/2]

const gtimes_container_type & FrameCPP::v9::FrTOCHeader::GetGTimeN ( ) const
inlineinherited

Retrieve array of integer GPS residual nanoseconds for the frame.

◆ GetGTimeS() [1/2]

const gtimen_container_type & FrameCPP::v9::FrTOCHeader::GetGTimeS ( ) const
inlineinherited

Retrieve array of integer GPS frame times.

◆ GetGTimeS() [2/2]

const gtimen_container_type & FrameCPP::v9::FrTOCHeader::GetGTimeS ( ) const
inlineinherited

Retrieve array of integer GPS frame times.

◆ GetNameDetector() [1/2]

const namedetector_container_type & FrameCPP::v9::FrTOCHeader::GetNameDetector ( ) const
inlineinherited

Retrieve array of FrDetector names.

◆ GetNameDetector() [2/2]

const namedetector_container_type & FrameCPP::v9::FrTOCHeader::GetNameDetector ( ) const
inlineinherited

Retrieve array of FrDetector names.

◆ GetNFrame() [1/2]

nFrame_type FrameCPP::v9::FrTOCHeader::GetNFrame ( ) const
inlineinherited

◆ GetNFrame() [2/2]

nFrame_type FrameCPP::v9::FrTOCHeader::GetNFrame ( ) const
inlineinherited

◆ GetPositionDetector() [1/2]

const positiondetector_container_type & FrameCPP::v9::FrTOCHeader::GetPositionDetector ( ) const
inlineinherited

Retrieve array of FrDetector positions.

◆ GetPositionDetector() [2/2]

const positiondetector_container_type & FrameCPP::v9::FrTOCHeader::GetPositionDetector ( ) const
inlineinherited

Retrieve array of FrDetector positions.

◆ GetPositionH() [1/2]

const positionh_container_type & FrameCPP::v9::FrTOCHeader::GetPositionH ( ) const
inlineinherited

Retrieve array of FrameH positions.

◆ GetPositionH() [2/2]

const positionh_container_type & FrameCPP::v9::FrTOCHeader::GetPositionH ( ) const
inlineinherited

Retrieve array of FrameH positions.

◆ GetSHid() [1/2]

const shid_container_type & FrameCPP::v9::FrTOCHeader::GetSHid ( ) const
inlineinherited

Retrieve array of FrSH IDs.

◆ GetSHid() [2/2]

const shid_container_type & FrameCPP::v9::FrTOCHeader::GetSHid ( ) const
inlineinherited

Retrieve array of FrSH IDs.

◆ GetSHname() [1/2]

const shname_container_type & FrameCPP::v9::FrTOCHeader::GetSHname ( ) const
inlineinherited

Retrieve array of FrSH names.

◆ GetSHname() [2/2]

const shname_container_type & FrameCPP::v9::FrTOCHeader::GetSHname ( ) const
inlineinherited

Retrieve array of FrSH names.

◆ Load() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Load ( istream_type & Stream)
inline

Read contents from stream.

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

◆ Load() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Load ( istream_type & Stream)
inline

Read contents from stream.

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

◆ operator=() [1/4]

const FrTOCDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCDataClassicIO & Source)
inline

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [2/4]

const FrTOCDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::operator= ( const Previous::FrTOCImpl::FrTOCDataClassicIO & Source)
inline

asignment operator

Parameters
[in]SourceThe source to be copied.

◆ operator=() [3/4]

FrTOCDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::operator= ( FrTOCDataClassicIO && TOC)
inline

◆ operator=() [4/4]

FrTOCDataClassicIO & FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::operator= ( FrTOCDataClassicIO && TOC)
inline

◆ operator==() [1/2]

bool FrameCPP::v9::FrTOCHeader::operator== ( const FrTOCHeader & RHS) const
inlineinherited

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::v9::FrTOCHeader::operator== ( const FrTOCHeader & RHS) const
inlineinherited

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.

◆ SetFileBaseName() [1/2]

void FrameCPP::v9::FrTOCHeader::SetFileBaseName ( const file_base_name_type & Source) const
inlineinherited

Set file base name.

◆ SetFileBaseName() [2/2]

void FrameCPP::v9::FrTOCHeader::SetFileBaseName ( const file_base_name_type & Source) const
inlineinherited

Set file base name.

◆ write() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::write ( Common::OStream & Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::write ( Common::OStream & Stream) const
inlineprotected

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Member Data Documentation

◆ fileBaseName

file_base_name_type FrameCPP::v9::FrTOCHeader::fileBaseName
mutableprotectedinherited

The name of the file at the time of creation.

◆ m_dataQuality

data_quality_container_type FrameCPP::v9::FrTOCHeader::m_dataQuality
protectedinherited

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

◆ m_dt

dt_container_type FrameCPP::v9::FrTOCHeader::m_dt
protectedinherited

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

◆ m_GTimeN

gtimen_container_type FrameCPP::v9::FrTOCHeader::m_GTimeN
protectedinherited

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

◆ m_GTimeS

gtimes_container_type FrameCPP::v9::FrTOCHeader::m_GTimeS
protectedinherited

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

◆ m_nameDetector

namedetector_container_type FrameCPP::v9::FrTOCHeader::m_nameDetector
protectedinherited

Array of FrDetector names.

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

◆ m_positionDetector

positiondetector_container_type FrameCPP::v9::FrTOCHeader::m_positionDetector
protectedinherited

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::v9::FrTOCHeader::m_positionH
protectedinherited

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

◆ m_SHid

shid_container_type FrameCPP::v9::FrTOCHeader::m_SHid
protectedinherited

Array of FrSH IDs.

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

◆ m_SHname

shname_container_type FrameCPP::v9::FrTOCHeader::m_SHname
protectedinherited

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


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