ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrameHImpl::Data Class Reference

#include <FrameHData.hh>

Inheritance diagram for FrameCPP::Version_9::FrameHImpl::Data:
Collaboration diagram for FrameCPP::Version_9::FrameHImpl::Data:

Public Types

typedef const char *const struct_name_type
typedef const char *const struct_name_type
typedef const char *const struct_desc_type
typedef const char *const struct_desc_type
typedef INT_2U const struct_id_type
typedef INT_2U const struct_id_type
typedef FRAME_H_NAME_TYPE name_type
typedef FRAME_H_RUN_TYPE run_type
typedef FRAME_H_FRAME_TYPE frame_type
typedef FRAME_H_DATA_QUALITY_TYPE dataQuality_type
typedef FRAME_H_G_TIME_S_TYPE GTimeS_type
typedef FRAME_H_G_TIME_N_TYPE GTimeN_type
typedef FRAME_H_G_TIME_TYPE GTime_type
typedef FRAME_H_LOCAL_TIME_TYPE localTime_type
typedef FRAME_H_DT_TYPE dt_type
typedef INT_2U v3_uleaps_type
typedef INT_4S v3_localTime_type
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > v3_strain_type
typedef boost::shared_ptr< FrRawDatarawData_type
typedef Common::SearchContainer< FrVect, &FrVect::GetName > type_type
typedef type_type::iterator type_iterator
typedef type_type::const_iterator const_type_iterator
typedef type_type::hash_iterator type_hash_iterator
typedef type_type::const_hash_iterator const_type_hash_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName > user_type
typedef user_type::iterator user_iterator
typedef user_type::const_iterator const_user_iterator
typedef user_type::hash_iterator user_hash_iterator
typedef user_type::const_hash_iterator const_user_hash_iterator
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectSim_type
typedef detectSim_type::iterator detectSim_iterator
typedef detectSim_type::const_iterator const_detectSim_iterator
typedef detectSim_type::hash_iterator detectSim_hash_iterator
typedef detectSim_type::const_hash_iterator const_detectSim_hash_iterator
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectProc_type
typedef detectProc_type::iterator detectProc_iterator
typedef detectProc_type::const_iterator const_detectProc_iterator
typedef detectProc_type::hash_iterator detectProc_hash_iterator
typedef detectProc_type::const_hash_iterator const_detectProc_hash_iterator
typedef Common::SearchContainer< FrEvent, &FrEvent::GetNameSlowevent_type
typedef event_type::iterator event_iterator
typedef event_type::const_iterator const_event_iterator
typedef event_type::hash_iterator event_hash_iterator
typedef event_type::const_hash_iterator const_event_hash_iterator
typedef Common::SearchContainer< FrHistory, &FrHistory::GetName > history_type
typedef history_type::iterator history_iterator
typedef history_type::const_iterator const_history_iterator
typedef history_type::hash_iterator history_hash_iterator
typedef history_type::const_hash_iterator const_history_hash_iterator
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > procData_type
typedef procData_type::iterator procData_iterator
typedef procData_type::const_iterator const_procData_iterator
typedef procData_type::hash_iterator procData_hash_iterator
typedef procData_type::const_hash_iterator const_procData_hash_iterator
typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow > simData_type
typedef simData_type::iterator simData_iterator
typedef simData_type::const_iterator const_simData_iterator
typedef simData_type::hash_iterator simData_hash_iterator
typedef simData_type::const_hash_iterator const_simData_hash_iterator
typedef Common::SearchContainer< FrSimEvent, &FrSimEvent::GetNameSlowsimEvent_type
typedef simEvent_type::iterator simEvent_iterator
typedef simEvent_type::const_iterator const_simEvent_iterator
typedef simEvent_type::hash_iterator simEvent_hash_iterator
typedef simEvent_type::const_hash_iterator const_simEvent_hash_iterator
typedef Common::SearchContainer< FrSummary, &FrSummary::GetName > summaryData_type
typedef summaryData_type::iterator summaryData_iterator
typedef summaryData_type::const_iterator const_summaryData_iterator
typedef summaryData_type::hash_iterator summaryData_hash_iterator
typedef summaryData_type::const_hash_iterator const_summaryData_hash_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName > auxData_type
typedef auxData_type::iterator auxData_iterator
typedef auxData_type::const_iterator const_auxData_iterator
typedef auxData_type::hash_iterator auxData_hash_iterator
typedef auxData_type::const_hash_iterator const_auxData_hash_iterator
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > auxTable_type
typedef auxTable_type::iterator auxTable_iterator
typedef auxTable_type::const_iterator const_auxTable_iterator
typedef auxTable_type::hash_iterator auxTable_hash_iterator
typedef auxTable_type::const_hash_iterator const_auxTable_hash_iterator

Public Member Functions

rawData_typeAddressOfRawData () const
const name_typeGetName () const
 Retrieve name of project.
run_type GetRun () const
 Run number.
frame_type GetFrame () const
 Frame number.
dataQuality_type GetDataQuality () const
 Data quality flag.
const GTime_typeGetGTime () const
 Start Time.
dt_type GetDt () const
 Frame length.
void SetName (const name_type &Name)
 Establish the name.
void SetRun (run_type Run)
 Establish the run number.
void SetDataQuality (dataQuality_type DataQuality)
 Establish the data quality flag.
void SetDt (dt_type Dt)
 Establish the frame duration.
void SetGTime (const GTime_type &Value)
 Establish the start time.
rawData_type GetRawData () const
 Retrieve the raw data reference.
const type_typeRefType () const
const user_typeRefUser () const
const detectSim_typeRefDetectSim () const
const detectProc_typeRefDetectProc () const
const history_typeRefHistory () const
const procData_typeRefProcData () const
const simData_typeRefSimData () const
const event_typeRefEvent () const
const simEvent_typeRefSimEvent () const
const summaryData_typeRefSummaryData () const
const auxData_typeRefAuxData () const
const auxTable_typeRefAuxTable () const
void SetRawData (rawData_type r)
bool operator== (const FrameH &RHS) const

Static Public Member Functions

static struct_name_type FrameSpecName ()
static struct_name_type FrameSpecName ()
static struct_name_type StructName ()
static struct_name_type StructName ()
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.

Static Public Attributes

static struct_name_type struct_name
static struct_desc_type struct_desc
static struct_id_type struct_id
static const INT_2U MAX_REF

Protected Attributes

name_type name
run_type run
frame_type frame
dataQuality_type dataQuality
GTime_type GTime
dt_type dt
type_type type
user_type user
detectSim_type detectSim
detectProc_type detectProc
history_type history
rawData_type rawData
procData_type procData
simData_type simData
event_type event
simEvent_type simEvent
summaryData_type summaryData
auxData_type auxData
auxTable_type auxTable

Detailed Description

Note
  • Changes introduced in Version 9
    • Removed ULeapS (INT_2U)
  • Changes introduced in Version 8
    • Added per object checksum
  • Changes introduced in Version 7
  • Changes introduced in Version 6
  • Changes introduced in Version 5
    • Removed localTime
  • Changes introduced in Version 4
  • Changes introduced in Version 3

Member Typedef Documentation

◆ auxData_hash_iterator

◆ auxData_iterator

◆ auxData_type

◆ auxTable_hash_iterator

◆ auxTable_iterator

◆ auxTable_type

◆ const_auxData_hash_iterator

◆ const_auxData_iterator

◆ const_auxTable_hash_iterator

◆ const_auxTable_iterator

◆ const_detectProc_hash_iterator

◆ const_detectProc_iterator

◆ const_detectSim_hash_iterator

◆ const_detectSim_iterator

◆ const_event_hash_iterator

◆ const_event_iterator

◆ const_history_hash_iterator

◆ const_history_iterator

◆ const_procData_hash_iterator

◆ const_procData_iterator

◆ const_simData_hash_iterator

◆ const_simData_iterator

◆ const_simEvent_hash_iterator

◆ const_simEvent_iterator

◆ const_summaryData_hash_iterator

◆ const_summaryData_iterator

◆ const_type_hash_iterator

◆ const_type_iterator

◆ const_user_hash_iterator

◆ const_user_iterator

◆ dataQuality_type

◆ detectProc_hash_iterator

◆ detectProc_iterator

◆ detectProc_type

◆ detectSim_hash_iterator

◆ detectSim_iterator

◆ detectSim_type

◆ dt_type

◆ event_hash_iterator

◆ event_iterator

◆ event_type

◆ frame_type

◆ GTime_type

◆ GTimeN_type

◆ GTimeS_type

◆ history_hash_iterator

◆ history_iterator

◆ history_type

◆ localTime_type

◆ name_type

◆ procData_hash_iterator

◆ procData_iterator

◆ procData_type

◆ rawData_type

◆ run_type

◆ simData_hash_iterator

◆ simData_iterator

◆ simData_type

◆ simEvent_hash_iterator

◆ simEvent_iterator

◆ simEvent_type

◆ struct_desc_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ summaryData_hash_iterator

◆ summaryData_iterator

◆ summaryData_type

◆ type_hash_iterator

◆ type_iterator

◆ type_type

◆ user_hash_iterator

◆ user_iterator

◆ user_type

◆ v3_localTime_type

◆ v3_strain_type

◆ v3_uleaps_type

Member Function Documentation

◆ AddressOfRawData()

◆ FrameSpecDescription() [1/2]

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetDataQuality()

Data quality flag.

Retrieve the data quality flag associated with the frame

Returns
The data quality flag for the frame

◆ GetDt()

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetFrame()

Frame number.

Retrieve the frame number associated with the frame

Returns
The frame number of the frame

◆ GetGTime()

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetName()

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetRawData()

Retrieve the raw data reference.

Set the number of leap seconds since GPS epoc.

Returns
A pointer to the raw data structure.

◆ GetRun()

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ operator==()

◆ RefAuxData()

◆ RefAuxTable()

◆ RefDetectProc()

◆ RefDetectSim()

◆ RefEvent()

◆ RefHistory()

◆ RefProcData()

◆ RefSimData()

◆ RefSimEvent()

◆ RefSummaryData()

◆ RefType()

◆ RefUser()

◆ SetDataQuality()

Establish the data quality flag.

Set the data quality flag of the frame.

Parameters
[in]DataQualityThe value of the data quality flag.

◆ SetDt()

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetGTime()

Establish the start time.

Set the start time of the frame.

Parameters
[in]ValueThe start time of the frame.

◆ SetName()

Establish the name.

Set the project name of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.

Parameters
[in]NameThe name to associate with the frame

◆ SetRawData()

◆ SetRun()

Establish the run number.

Set the run number of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.

Parameters
[in]RunThe run number to associate with the frame.

◆ StructName() [1/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

Member Data Documentation

◆ auxData

auxData_type FrameH::auxData
protectedinherited

◆ auxTable

auxTable_type FrameH::auxTable
protectedinherited

◆ dataQuality

dataQuality_type FrameH::dataQuality
protectedinherited

◆ detectProc

detectProc_type FrameH::detectProc
protectedinherited

◆ detectSim

detectSim_type FrameH::detectSim
protectedinherited

◆ dt

dt_type FrameH::dt
protectedinherited

◆ event

event_type FrameH::event
protectedinherited

◆ frame

frame_type FrameH::frame
protectedinherited

◆ GTime

GTime_type FrameH::GTime
protectedinherited

◆ history

history_type FrameH::history
mutableprotectedinherited

◆ MAX_REF

const INT_2U FrameH::MAX_REF
staticinherited

◆ name

name_type FrameH::name
protectedinherited

◆ procData

procData_type FrameH::procData
protectedinherited

◆ rawData

rawData_type FrameH::rawData
protectedinherited

◆ run

run_type FrameH::run
protectedinherited

◆ simData

simData_type FrameH::simData
protectedinherited

◆ simEvent

simEvent_type FrameH::simEvent
protectedinherited

◆ struct_desc

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ summaryData

summaryData_type FrameH::summaryData
protectedinherited

◆ type

type_type FrameH::type
protectedinherited

◆ user

user_type FrameH::user
protectedinherited

The documentation for this class was generated from the following file:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/impl/FrameHData.hh