ldas-tools-framecpp  2.7.0
Classes | Typedefs | Functions | Variables
FrameCPP::Version_6 Namespace Reference

Implementation of the version 6 specification. More...

Classes

class  Container
 
class  Dimension
 
class  FrAdcData
 
class  FrAdcDataNPS
 
class  FrameH
 
class  FrameHNPS
 Non-PTR_STRUCT elements of the FrameH structure. More...
 
class  FrameHPST
 PTR_STRUCT elements of the FrmaeH structure. More...
 
class  FrameStreamBase
 
class  FrDetector
 
class  FrEndOfFile
 
class  FrEndOfFileData
 
class  FrEndOfFrame
 
class  FrEvent
 
class  FrEventRefsT
 
class  FrEventStorage
 
class  FrMsg
 
class  FrProcData
 
class  FrProcDataNPS
 
class  FrProcDataPST
 Post-Processed Data Structure Definition. More...
 
class  FrRawData
 
class  FrSerData
 
class  FrSimData
 
class  FrSimDataStorage
 
class  FrSimEvent
 
class  FrSimEventNPS
 
class  FrStatData
 
class  FrSummary
 
class  FrTable
 Implementation of FrTable according to the frame specification. More...
 
class  FrTOC
 
class  FrTOCAdcData
 
class  FrTOCData
 
class  FrTOCEvent
 
class  FrTOCProcData
 
class  FrTOCSimData
 
class  FrTOCSimEvent
 
class  FrTOCStatData
 
struct  FrTOCTypes
 
class  FrVect
 
class  SearchContainer
 
class  StreamRefData
 

Typedefs

typedef FR_ADC_DATA_PS_NAMESPACE ::FrAdcDataPST< FrVect, FrVectFrAdcDataPS
 
typedef STRING name_type
 
typedef STRING comment_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channel_group_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channel_number_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef STRING units_type
 
typedef FR_ADC_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIMEOFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_type
 
typedef FrameHPST< FrDetector, FrEvent, FrHistory, FrProcData, FrRawData, FrSimData, FrSimEvent, FrSummary, FrTable, FrVectFrameHPS
 
typedef REAL_4 dt_type
 
typedef INT_8U position_type
 
typedef Common::IFrameStreamWrapper< 6, FrAdcData, FrameH, FrProcData, FrSerData, FrSimData, FrRawData, FrEvent, FrSimEventIFrameStream
 
typedef Common::IFrameStreamPlanWrapper< 6, FrAdcData, FrameH, FrProcData, FrSerData, FrSimData, FrRawData, FrEvent, FrSimEventIFrameStreamPlan
 
typedef FrEventRefsT< FrVect, FrTableFrEventRefs
 
typedef FrProcDataPST< FrVect, FrVect, FrTable, FrHistoryFrProcDataPS
 
typedef FrSimDataRefsT< FrVect, FrTableFrSimDataRefs
 
typedef Version_4::FrSimEventPST< PTR_STRUCT, FrVect, FrTableFrSimEventPS
 
typedef Previous::FrStatDataNPS FrStatDataNPS
 
typedef Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTableFrStatDataPS
 
typedef Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > > FrTablePS
 
typedef Common::PTR_STRUCT< INT_2U, INT_4U > PTR_STRUCT
 
typedef Common::StreamRef< INT_8U, INT_2U, INT_4U > StreamRef
 

Functions

const char * FR_ADC_DATA_DEFAULT_UNITS ()
 
bool init_frame_spec ()
 
template<typename FrEventType , typename ShadowType >
Common::OStreamFrEventParamWrite (Common::OStream &Stream, const typename FrEventType::ParamList_type &Data)
 
template<typename FrEventType , typename ShadowType >
Common::IStreamFrEventParamRead (Common::IStream &Stream, typename FrEventType::ParamList_type &Data)
 
void FrAdcData:: vTOCQuery (int InfoClass, va_list vl) const
 
template<>
INT_2U FrVect::GetDataType< std::string > ()
 
FrameHReadFrame (IFrameStream &Input)
 
void WriteFrame (OFrameStream &Stream, FrameH &Frame)
 
void WriteFrame (OFrameStream &Output, const FrameH &Frame)
 
const std::vector< Dictionary::io_calls_type > & GetClassIO ()
 
template<class LM_Container >
void ReadContainer (IFrameStream &Stream, LM_Container &Container, bool Recursive)
 
template<>
void ReadContainer (IFrameStream &Stream, dummy_type &Container, bool Recursive)
 
template<class LM_Container >
void WriteContainer (OFrameStream &Stream, const LM_Container &Container)
 
template void WriteContainer (OFrameStream &, const std::vector< int > &)
 
void Rethrow (const std::exception &Exception, const std::string &Prefix)
 

Variables

const FR_ADC_DATA_CHANNEL_GROUP_TYPE FR_ADC_DATA_DEFAULT_CHANNEL_GROUP
 
const FR_ADC_DATA_CHANNEL_NUMBER_TYPE FR_ADC_DATA_DEFAULT_CHANNEL_NUMBER = 0
 
const FR_ADC_DATA_N_BITS_TYPE FR_ADC_DATA_DEFAULT_NBITS = 0
 
const FR_ADC_DATA_BIAS_TYPE FR_ADC_DATA_DEFAULT_BIAS = 0.0
 
const FR_ADC_DATA_SLOPE_TYPE FR_ADC_DATA_DEFAULT_SLOPE = 1.0
 
const FR_ADC_DATA_FSHIFT_TYPE FR_ADC_DATA_DEFAULT_SAMPLE_RATE = -1.0
 
const FR_ADC_DATA_FSHIFT_TYPE FR_ADC_DATA_DEFAULT_FSHIFT = 0.0
 
const FR_ADC_DATA_TIMEOFFSET_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET = 0.0
 
const FR_ADC_DATA_PHASE_TYPE FR_ADC_DATA_DEFAULT_PHASE = 0.0
 
const FR_ADC_DATA_DATAVALID_TYPE FR_ADC_DATA_DEFAULT_DATA_VALID = 0
 
const CHAR_U DATA_FORMAT_VERSION = 6
 
const CHAR_U LIBRARY_MINOR_VERSION = 3
 
const Common::DetectorNamesDetectorNameTable = dnt_init( )
 
static const bool Initialized = init_frame_spec( )
 
static const FrameSpec::Info::frame_object_types s_object_id
 
const char * LibraryString = "Version6"
 

Detailed Description

Implementation of the version 6 specification.

This namespace includes classes and functions needed to implement the version 6 frame specification as described by LIGO-T970130-F-E dated August 14, 2002.

Typedef Documentation

◆ bias_type

◆ channel_group_type

◆ channel_number_type

◆ comment_type

◆ dataValid_type

◆ dt_type

The namespace Previous is to the version 4 frame specification since the version 5 frame specification was never fully implemented.

◆ FrAdcDataPS

typedef FR_ADC_DATA_PS_NAMESPACE::FrAdcDataPST< FrVect, FrVect > FrameCPP::Version_6::FrAdcDataPS

◆ FrameHPS

◆ FrEventRefs

◆ FrProcDataPS

◆ FrSimDataRefs

◆ FrSimEventPS

◆ FrStatDataNPS

typedef Previous::FrStatDataNPS FrameCPP::Version_6::FrStatDataNPS
Todo:
Needs documentation
Todo:
Needs documentation

◆ FrStatDataPS

Todo:
Needs documentation
Todo:
Needs documentation

◆ FrTablePS

◆ fShift_type

◆ IFrameStream

◆ IFrameStreamPlan

◆ name_type

◆ nBits_type

◆ phase_type

◆ position_type

◆ PTR_STRUCT

◆ sampleRate_type

◆ slope_type

◆ StreamRef

typedef Common::StreamRef< INT_8U, INT_2U, INT_4U > FrameCPP::Version_6::StreamRef

◆ timeOffset_type

◆ units_type

Function Documentation

◆ FR_ADC_DATA_DEFAULT_UNITS()

const char * FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_UNITS ( )
inline

◆ FrEventParamRead()

template<typename FrEventType , typename ShadowType >
Common::IStream & FrameCPP::Version_6::FrEventParamRead ( Common::IStream Stream,
typename FrEventType::ParamList_type &  Data 
)
inline

◆ FrEventParamWrite()

template<typename FrEventType , typename ShadowType >
Common::OStream & FrameCPP::Version_6::FrEventParamWrite ( Common::OStream Stream,
const typename FrEventType::ParamList_type &  Data 
)
inline

◆ FrVect::GetDataType< std::string >()

template<>
INT_2U FrameCPP::Version_6::FrVect::GetDataType< std::string > ( )

◆ GetClassIO()

const std::vector< Dictionary::io_calls_type > & FrameCPP::Version_6::GetClassIO ( )

◆ init_frame_spec()

bool FrameCPP::Version_6::init_frame_spec ( )

◆ ReadContainer() [1/2]

template<class LM_Container >
void FrameCPP::Version_6::ReadContainer ( IFrameStream Stream,
LM_Container &  Container,
bool  Recursive 
)

◆ ReadContainer() [2/2]

template<>
void FrameCPP::Version_6::ReadContainer ( IFrameStream Stream,
dummy_type &  Container,
bool  Recursive 
)

◆ ReadFrame()

FrameH * FrameCPP::Version_6::ReadFrame ( IFrameStream Input)

◆ Rethrow()

void FrameCPP::Version_6::Rethrow ( const std::exception &  Exception,
const std::string &  Prefix 
)

◆ vTOCQuery()

void FrAdcData:: FrameCPP::Version_6::vTOCQuery ( int  InfoClass,
va_list  vl 
) const

◆ WriteContainer() [1/2]

template<class LM_Container >
void FrameCPP::Version_6::WriteContainer ( OFrameStream Stream,
const LM_Container &  Container 
)

◆ WriteContainer() [2/2]

template void FrameCPP::Version_6::WriteContainer ( OFrameStream ,
const std::vector< int > &   
)

◆ WriteFrame() [1/2]

void FrameCPP::Version_6::WriteFrame ( OFrameStream Output,
const FrameH Frame 
)

◆ WriteFrame() [2/2]

void FrameCPP::Version_6::WriteFrame ( OFrameStream Stream,
FrameH Frame 
)

Variable Documentation

◆ DATA_FORMAT_VERSION

const CHAR_U FrameCPP::Version_6::DATA_FORMAT_VERSION = 6

◆ DetectorNameTable

const Common::DetectorNames & FrameCPP::Version_6::DetectorNameTable = dnt_init( )

◆ FR_ADC_DATA_DEFAULT_BIAS

const FR_ADC_DATA_BIAS_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_BIAS = 0.0

◆ FR_ADC_DATA_DEFAULT_CHANNEL_GROUP

const FR_ADC_DATA_CHANNEL_GROUP_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_CHANNEL_GROUP
Initial value:
=
0

◆ FR_ADC_DATA_DEFAULT_CHANNEL_NUMBER

const FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_CHANNEL_NUMBER = 0

◆ FR_ADC_DATA_DEFAULT_DATA_VALID

const FR_ADC_DATA_DATAVALID_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_DATA_VALID = 0

◆ FR_ADC_DATA_DEFAULT_FSHIFT

const FR_ADC_DATA_FSHIFT_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_FSHIFT = 0.0

◆ FR_ADC_DATA_DEFAULT_NBITS

const FR_ADC_DATA_N_BITS_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_NBITS = 0

◆ FR_ADC_DATA_DEFAULT_PHASE

const FR_ADC_DATA_PHASE_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_PHASE = 0.0

◆ FR_ADC_DATA_DEFAULT_SAMPLE_RATE

const FR_ADC_DATA_FSHIFT_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_SAMPLE_RATE = -1.0

◆ FR_ADC_DATA_DEFAULT_SLOPE

const FR_ADC_DATA_SLOPE_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_SLOPE = 1.0

◆ FR_ADC_DATA_DEFAULT_TIME_OFFSET

const FR_ADC_DATA_TIMEOFFSET_TYPE FrameCPP::Version_6::FR_ADC_DATA_DEFAULT_TIME_OFFSET = 0.0

◆ Initialized

const bool FrameCPP::Version_6::Initialized = init_frame_spec( )
static

◆ LIBRARY_MINOR_VERSION

const CHAR_U FrameCPP::Version_6::LIBRARY_MINOR_VERSION = 3

◆ LibraryString

const char * FrameCPP::Version_6::LibraryString = "Version6"

◆ s_object_id

const FrameSpec::Info::frame_object_types FrameCPP::Version_6::s_object_id
static
Initial value:
=
FrameSpec::Info::FSI_FR_SUMMARY