ldas-tools-framecpp  2.5.8
Classes | Typedefs | Functions | Variables
FrameCPP::Version_8 Namespace Reference

Implementation of the version 8 specification. More...

Classes

class  Dimension
 Dimension information for a Vect. More...
 
class  FrAdcData
 ADC Data. More...
 
class  FrameH
 Frame Header. More...
 
class  FrDetector
 Detector data. More...
 
class  FrEndOfFile
 End of File data structure. More...
 
class  FrEndOfFrame
 End of Frame data structure. More...
 
class  FrEvent
 Event data structure definition. More...
 
class  FrHeader
 Implementation of the frame header structure. More...
 
class  FrHistory
 History Structure Definition. More...
 
class  FrMsg
 Message Log Data Structure Definition. More...
 
class  FrProcData
 Post-Processed Data Structure Definition. More...
 
class  FrRawData
 Raw Data Structgure Definition. More...
 
class  FrSE
 Contains field information of a dictionary structure. More...
 
class  FrSerData
 Raw Data Structure Definition. More...
 
class  FrSH
 Contains class information of a dictionary structure. More...
 
class  FrSimData
 Simulated Data Structure Definition. More...
 
class  FrSimEvent
 Simulated Event Data Structure Definition. More...
 
class  FrStatData
 Static Data Structure Definition. More...
 
class  FrSummary
 Summary Data Structure Definition. More...
 
class  FrTable
 Table Data Structure Definition. More...
 
class  FrTOC
 Table of Contents Data Structure Definition. More...
 
class  FrTOCAdcData
 Indexed elements of the FrAdcData structure. More...
 
class  FrTOCData
 Helper class for data portion of the FrTOC structure. More...
 
class  FrTOCEvent
 Indexed elements of the FrEvent structure. More...
 
class  FrTOCProcData
 Indexed elements of the FrProcData structure. More...
 
class  FrTOCSerData
 Indexed elements of the FrSerData structure. More...
 
class  FrTOCSimData
 Indexed elements of the FrSimData structure. More...
 
class  FrTOCSimEvent
 Indexed elements of the FrSimEvent structure. More...
 
class  FrTOCStatData
 Indexed elements of the FrSimData structure. More...
 
class  FrTOCSummary
 Indexed elements of the FrSummary structure. More...
 
struct  FrTOCTypes
 
class  FrVect
 Vector Data Structure Definition. More...
 
class  ObjectWithChecksum
 

Typedefs

typedef FR_ADC_DATA_NPS_NAMESPACE ::FrAdcDataNPS FrAdcDataNPS
 
typedef FR_ADC_DATA_PS_NAMESPACE ::FrAdcDataPST< FrVect, FrVectFrAdcDataPS
 
typedef Previous::FrameHNPS FrameHNPS
 Non-PTR_STRUCT elements of the FrameH structure. More...
 
typedef Version_6::FrameHPST< FrDetector, FrEvent, FrHistory, FrProcData, FrRawData, FrSimData, FrSimEvent, FrSummary, FrTable, FrVectFrameHPS
 PTR_STRUCT elements of the FrmaeH structure. More...
 
typedef REAL_4 dt_type
 
typedef INT_8U position_type
 
typedef INT_4U checksum_type
 
typedef Common::FrameSpec::class_type class_type
 
typedef Common::IFrameStreamWrapper< 8, FrAdcData, FrameH, FrProcData, FrSerData, FrSimData, FrRawData, FrEvent, FrSimEventIFrameStream
 
typedef Common::IFrameStreamPlanWrapper< 8, FrAdcData, FrameH, FrProcData, FrSerData, FrSimData, FrRawData, FrEvent, FrSimEventIFrameStreamPlan
 
typedef Previous::FrEvent::FrEventStorage FrEventStorage
 
typedef FrEventRefsT< FrVect, FrTableFrEventRefs
 
typedef FR_PROC_DATA_PS_NAMESPACE ::FrProcDataPST< FrVect, FrVect, FrTable, FrHistoryFrProcDataPS
 
typedef Previous::FrSimData::FrSimDataStorage FrSimDataStorage
 
typedef FrSimDataRefsT< FrVect, FrTableFrSimDataRefs
 
typedef Previous::FrSimEvent::FrSimEventNPS FrSimEventNPS
 
typedef Version_4::FrSimEventPST< PTR_STRUCT, FrVect, FrTableFrSimEventPS
 
typedef Previous::FrStatData::FrStatDataNPS FrStatDataNPS
 
typedef Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTableFrStatDataPS
 
typedef Previous::FrTable::FrTableNPS FrTableNPS
 
typedef Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > > FrTablePS
 
typedef Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U > StreamRef
 Common Elements of all frame structures. More...
 

Functions

bool init_frame_spec ()
 
void FrAdcData:: vTOCQuery (int InfoClass, va_list vl) const
 
template<>
FrVect::type_type FrVect::GetDataType< std::string > ()
 

Variables

const Common::DetectorNamesDetectorNameTable = dnt_init( )
 
const CHAR_U DATA_FORMAT_VERSION = 8
 
const CHAR_U LIBRARY_MINOR_VERSION = 1
 

Detailed Description

Implementation of the version 8 specification.

This namespace implements the Version 8 of the frame specification as described in the docuemnt LIGO-T970130-v1 dated March 4, 2009.

Typedef Documentation

◆ checksum_type

◆ class_type

◆ dt_type

◆ FrAdcDataNPS

◆ FrAdcDataPS

◆ FrameHNPS

Non-PTR_STRUCT elements of the FrameH structure.

This class contains the data members of the FrameH structure that are not refernced by a pointer. This allows for easier migration into future frame specifications.

◆ FrameHPS

PTR_STRUCT elements of the FrmaeH structure.

This class contains the PTR_STRUCT references of the FrameH structure. This allows for easier migration into future frame specifications.

◆ FrEventRefs

◆ FrEventStorage

typedef Previous::FrEvent::FrEventStorage FrameCPP::Version_8::FrEventStorage

◆ FrProcDataPS

◆ FrSimDataRefs

◆ FrSimDataStorage

typedef Previous::FrSimData::FrSimDataStorage FrameCPP::Version_8::FrSimDataStorage

◆ FrSimEventNPS

typedef Previous::FrSimEvent::FrSimEventNPS FrameCPP::Version_8::FrSimEventNPS

◆ FrSimEventPS

◆ FrStatDataNPS

typedef Previous::FrStatData::FrStatDataNPS FrameCPP::Version_8::FrStatDataNPS
Todo:
Needs documentation

◆ FrStatDataPS

◆ FrTableNPS

typedef Previous::FrTable::FrTableNPS FrameCPP::Version_8::FrTableNPS

◆ FrTablePS

typedef Version_4:: FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > > FrameCPP::Version_8::FrTablePS

◆ IFrameStream

◆ IFrameStreamPlan

◆ position_type

◆ StreamRef

typedef Common::StreamRef2< INT_8U , CHAR_U , CHAR_U , INT_4U > FrameCPP::Version_8::StreamRef

Common Elements of all frame structures.

This type is to provide the common components of all frame structures written to a stream. This implements table 6 in section 4.3.2 of the frame specification document.

Function Documentation

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

◆ init_frame_spec()

bool FrameCPP::Version_8::init_frame_spec ( )

◆ vTOCQuery()

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

Variable Documentation

◆ DATA_FORMAT_VERSION

const CHAR_U FrameCPP::Version_8::DATA_FORMAT_VERSION = 8

◆ DetectorNameTable

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

◆ LIBRARY_MINOR_VERSION

const CHAR_U FrameCPP::Version_8::LIBRARY_MINOR_VERSION = 1