ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_6::FrameH Class Referenceabstract

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_6::FrameH:
Collaboration diagram for FrameCPP::Version_6::FrameH:

Public Types

typedef Common::FrameH::assign_stream_type assign_stream_type
 
typedef Common::FrameH::assign_stream_type assign_stream_type
 
enum  copy_type {
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 ,
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080
}
 
enum  copy_type {
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 ,
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080
}
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
typedef stream_base_type promote_stream_type
 
typedef FRAME_H_NAME_TYPE name_type
 
typedef FRAME_H_NAME_TYPE name_type
 
typedef FRAME_H_RUN_TYPE run_type
 
typedef FRAME_H_RUN_TYPE run_type
 
typedef FRAME_H_FRAME_TYPE frame_type
 
typedef FRAME_H_FRAME_TYPE frame_type
 
typedef FRAME_H_DATA_QUALITY_TYPE dataQuality_type
 
typedef FRAME_H_DATA_QUALITY_TYPE dataQuality_type
 
typedef FRAME_H_G_TIME_S_TYPE GTimeS_type
 
typedef FRAME_H_G_TIME_S_TYPE GTimeS_type
 
typedef FRAME_H_G_TIME_N_TYPE GTimeN_type
 
typedef FRAME_H_G_TIME_N_TYPE GTimeN_type
 
typedef FRAME_H_G_TIME_TYPE GTime_type
 
typedef FRAME_H_G_TIME_TYPE GTime_type
 
typedef FRAME_H_U_LEAP_S_TYPE ULeapS_type
 
typedef FRAME_H_U_LEAP_S_TYPE ULeapS_type
 
typedef FRAME_H_LOCAL_TIME_TYPE localTime_type
 
typedef FRAME_H_LOCAL_TIME_TYPE localTime_type
 
typedef FRAME_H_DT_TYPE dt_type
 
typedef FRAME_H_DT_TYPE dt_type
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 
typedef boost::shared_ptr< FrRawDatarawData_type
 
typedef boost::shared_ptr< FrRawDatarawData_type
 
typedef boost::shared_ptr< FrRawDatarawData_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > type_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > type_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > type_type
 
typedef type_type::iterator type_iterator
 
typedef type_type::iterator type_iterator
 
typedef type_type::iterator type_iterator
 
typedef type_type::const_iterator const_type_iterator
 
typedef type_type::const_iterator const_type_iterator
 
typedef type_type::const_iterator const_type_iterator
 
typedef type_type::hash_iterator type_hash_iterator
 
typedef type_type::hash_iterator type_hash_iterator
 
typedef type_type::hash_iterator type_hash_iterator
 
typedef type_type::const_hash_iterator const_type_hash_iterator
 
typedef type_type::const_hash_iterator const_type_hash_iterator
 
typedef type_type::const_hash_iterator const_type_hash_iterator
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > user_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > user_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > user_type
 
typedef user_type::iterator user_iterator
 
typedef user_type::iterator user_iterator
 
typedef user_type::iterator user_iterator
 
typedef user_type::const_iterator const_user_iterator
 
typedef user_type::const_iterator const_user_iterator
 
typedef user_type::const_iterator const_user_iterator
 
typedef user_type::hash_iterator user_hash_iterator
 
typedef user_type::hash_iterator user_hash_iterator
 
typedef user_type::hash_iterator user_hash_iterator
 
typedef user_type::const_hash_iterator const_user_hash_iterator
 
typedef user_type::const_hash_iterator const_user_hash_iterator
 
typedef user_type::const_hash_iterator const_user_hash_iterator
 
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectSim_type
 
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectSim_type
 
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectSim_type
 
typedef detectSim_type::iterator detectSim_iterator
 
typedef detectSim_type::iterator detectSim_iterator
 
typedef detectSim_type::iterator detectSim_iterator
 
typedef detectSim_type::const_iterator const_detectSim_iterator
 
typedef detectSim_type::const_iterator const_detectSim_iterator
 
typedef detectSim_type::const_iterator const_detectSim_iterator
 
typedef detectSim_type::hash_iterator detectSim_hash_iterator
 
typedef detectSim_type::hash_iterator detectSim_hash_iterator
 
typedef detectSim_type::hash_iterator detectSim_hash_iterator
 
typedef detectSim_type::const_hash_iterator const_detectSim_hash_iterator
 
typedef detectSim_type::const_hash_iterator const_detectSim_hash_iterator
 
typedef detectSim_type::const_hash_iterator const_detectSim_hash_iterator
 
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectProc_type
 
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectProc_type
 
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectProc_type
 
typedef detectProc_type::iterator detectProc_iterator
 
typedef detectProc_type::iterator detectProc_iterator
 
typedef detectProc_type::iterator detectProc_iterator
 
typedef detectProc_type::const_iterator const_detectProc_iterator
 
typedef detectProc_type::const_iterator const_detectProc_iterator
 
typedef detectProc_type::const_iterator const_detectProc_iterator
 
typedef detectProc_type::hash_iterator detectProc_hash_iterator
 
typedef detectProc_type::hash_iterator detectProc_hash_iterator
 
typedef detectProc_type::hash_iterator detectProc_hash_iterator
 
typedef detectProc_type::const_hash_iterator const_detectProc_hash_iterator
 
typedef detectProc_type::const_hash_iterator const_detectProc_hash_iterator
 
typedef detectProc_type::const_hash_iterator const_detectProc_hash_iterator
 
typedef Common::SearchContainer< FrEvent, &FrEvent::GetNameSlowevent_type
 
typedef Common::SearchContainer< FrEvent, &FrEvent::GetNameSlowevent_type
 
typedef Common::SearchContainer< FrEvent, &FrEvent::GetNameSlowevent_type
 
typedef event_type::iterator event_iterator
 
typedef event_type::iterator event_iterator
 
typedef event_type::iterator event_iterator
 
typedef event_type::const_iterator const_event_iterator
 
typedef event_type::const_iterator const_event_iterator
 
typedef event_type::const_iterator const_event_iterator
 
typedef event_type::hash_iterator event_hash_iterator
 
typedef event_type::hash_iterator event_hash_iterator
 
typedef event_type::hash_iterator event_hash_iterator
 
typedef event_type::const_hash_iterator const_event_hash_iterator
 
typedef event_type::const_hash_iterator const_event_hash_iterator
 
typedef event_type::const_hash_iterator const_event_hash_iterator
 
typedef Common::SearchContainer< FrHistory, &FrHistory::GetName > history_type
 
typedef Common::SearchContainer< FrHistory, &FrHistory::GetName > history_type
 
typedef Common::SearchContainer< FrHistory, &FrHistory::GetName > history_type
 
typedef history_type::iterator history_iterator
 
typedef history_type::iterator history_iterator
 
typedef history_type::iterator history_iterator
 
typedef history_type::const_iterator const_history_iterator
 
typedef history_type::const_iterator const_history_iterator
 
typedef history_type::const_iterator const_history_iterator
 
typedef history_type::hash_iterator history_hash_iterator
 
typedef history_type::hash_iterator history_hash_iterator
 
typedef history_type::hash_iterator history_hash_iterator
 
typedef history_type::const_hash_iterator const_history_hash_iterator
 
typedef history_type::const_hash_iterator const_history_hash_iterator
 
typedef history_type::const_hash_iterator const_history_hash_iterator
 
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > procData_type
 
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > procData_type
 
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > procData_type
 
typedef procData_type::iterator procData_iterator
 
typedef procData_type::iterator procData_iterator
 
typedef procData_type::iterator procData_iterator
 
typedef procData_type::const_iterator const_procData_iterator
 
typedef procData_type::const_iterator const_procData_iterator
 
typedef procData_type::const_iterator const_procData_iterator
 
typedef procData_type::hash_iterator procData_hash_iterator
 
typedef procData_type::hash_iterator procData_hash_iterator
 
typedef procData_type::hash_iterator procData_hash_iterator
 
typedef procData_type::const_hash_iterator const_procData_hash_iterator
 
typedef procData_type::const_hash_iterator const_procData_hash_iterator
 
typedef procData_type::const_hash_iterator const_procData_hash_iterator
 
typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow > simData_type
 
typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow > simData_type
 
typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow > simData_type
 
typedef simData_type::iterator simData_iterator
 
typedef simData_type::iterator simData_iterator
 
typedef simData_type::iterator simData_iterator
 
typedef simData_type::const_iterator const_simData_iterator
 
typedef simData_type::const_iterator const_simData_iterator
 
typedef simData_type::const_iterator const_simData_iterator
 
typedef simData_type::hash_iterator simData_hash_iterator
 
typedef simData_type::hash_iterator simData_hash_iterator
 
typedef simData_type::hash_iterator simData_hash_iterator
 
typedef simData_type::const_hash_iterator const_simData_hash_iterator
 
typedef simData_type::const_hash_iterator const_simData_hash_iterator
 
typedef simData_type::const_hash_iterator const_simData_hash_iterator
 
typedef Common::SearchContainer< FrSimEvent, &FrSimEvent::GetNameSlowsimEvent_type
 
typedef Common::SearchContainer< FrSimEvent, &FrSimEvent::GetNameSlowsimEvent_type
 
typedef Common::SearchContainer< FrSimEvent, &FrSimEvent::GetNameSlowsimEvent_type
 
typedef simEvent_type::iterator simEvent_iterator
 
typedef simEvent_type::iterator simEvent_iterator
 
typedef simEvent_type::iterator simEvent_iterator
 
typedef simEvent_type::const_iterator const_simEvent_iterator
 
typedef simEvent_type::const_iterator const_simEvent_iterator
 
typedef simEvent_type::const_iterator const_simEvent_iterator
 
typedef simEvent_type::hash_iterator simEvent_hash_iterator
 
typedef simEvent_type::hash_iterator simEvent_hash_iterator
 
typedef simEvent_type::hash_iterator simEvent_hash_iterator
 
typedef simEvent_type::const_hash_iterator const_simEvent_hash_iterator
 
typedef simEvent_type::const_hash_iterator const_simEvent_hash_iterator
 
typedef simEvent_type::const_hash_iterator const_simEvent_hash_iterator
 
typedef Common::SearchContainer< FrSummary, &FrSummary::GetName > summaryData_type
 
typedef Common::SearchContainer< FrSummary, &FrSummary::GetName > summaryData_type
 
typedef Common::SearchContainer< FrSummary, &FrSummary::GetName > summaryData_type
 
typedef summaryData_type::iterator summaryData_iterator
 
typedef summaryData_type::iterator summaryData_iterator
 
typedef summaryData_type::iterator summaryData_iterator
 
typedef summaryData_type::const_iterator const_summaryData_iterator
 
typedef summaryData_type::const_iterator const_summaryData_iterator
 
typedef summaryData_type::const_iterator const_summaryData_iterator
 
typedef summaryData_type::hash_iterator summaryData_hash_iterator
 
typedef summaryData_type::hash_iterator summaryData_hash_iterator
 
typedef summaryData_type::hash_iterator summaryData_hash_iterator
 
typedef summaryData_type::const_hash_iterator const_summaryData_hash_iterator
 
typedef summaryData_type::const_hash_iterator const_summaryData_hash_iterator
 
typedef summaryData_type::const_hash_iterator const_summaryData_hash_iterator
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > auxData_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > auxData_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > auxData_type
 
typedef auxData_type::iterator auxData_iterator
 
typedef auxData_type::iterator auxData_iterator
 
typedef auxData_type::iterator auxData_iterator
 
typedef auxData_type::const_iterator const_auxData_iterator
 
typedef auxData_type::const_iterator const_auxData_iterator
 
typedef auxData_type::const_iterator const_auxData_iterator
 
typedef auxData_type::hash_iterator auxData_hash_iterator
 
typedef auxData_type::hash_iterator auxData_hash_iterator
 
typedef auxData_type::hash_iterator auxData_hash_iterator
 
typedef auxData_type::const_hash_iterator const_auxData_hash_iterator
 
typedef auxData_type::const_hash_iterator const_auxData_hash_iterator
 
typedef auxData_type::const_hash_iterator const_auxData_hash_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > auxTable_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > auxTable_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > auxTable_type
 
typedef auxTable_type::iterator auxTable_iterator
 
typedef auxTable_type::iterator auxTable_iterator
 
typedef auxTable_type::iterator auxTable_iterator
 
typedef auxTable_type::const_iterator const_auxTable_iterator
 
typedef auxTable_type::const_iterator const_auxTable_iterator
 
typedef auxTable_type::const_iterator const_auxTable_iterator
 
typedef auxTable_type::hash_iterator auxTable_hash_iterator
 
typedef auxTable_type::hash_iterator auxTable_hash_iterator
 
typedef auxTable_type::hash_iterator auxTable_hash_iterator
 
typedef auxTable_type::const_hash_iterator const_auxTable_hash_iterator
 
typedef auxTable_type::const_hash_iterator const_auxTable_hash_iterator
 
typedef auxTable_type::const_hash_iterator const_auxTable_hash_iterator
 

Public Member Functions

 FrameH ()
 
 FrameH (const FrameH &frame)
 
 FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0)
 
 FrameH (const FrameHNPS &Source)
 
 FrameH (const Previous::FrameH &Source, stream_base_type *Stream)
 
 ~FrameH ()
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (OStream &Stream) const
 Write object to the stream.
 
bool operator== (const FrameH &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrameH ()
 
 FrameH (const FrameH &frame)
 
 FrameH (const std::string &name, INT_4S run, INT_4U frame, const GPSTime &time, INT_2U uLeapS, const REAL_8 dt, INT_4U dqual=0)
 
 FrameH (const FrameHNPS &Source)
 
 FrameH (const Previous::FrameH &Source, stream_base_type *Stream)
 
 ~FrameH ()
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (OStream &Stream) const
 Write object to the stream.
 
bool operator== (const FrameH &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
virtual void assign (assign_stream_type &Stream)=0
 Assign the contents of the instance.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
 
const std::string & GetName () const
 Retrieve name of project.
 
const std::string & GetName () const
 Retrieve name of project.
 
run_type GetRun () const
 Run number.
 
run_type GetRun () const
 Run number.
 
frame_type GetFrame () const
 Frame number.
 
frame_type GetFrame () const
 Frame number.
 
dataQuality_type GetDataQuality () const
 Data quality flag.
 
dataQuality_type GetDataQuality () const
 Data quality flag.
 
const GPSTimeGetGTime () const
 Start Time.
 
const GPSTimeGetGTime () const
 Start Time.
 
ULeapS_type GetULeapS () const
 Leap seconds.
 
ULeapS_type GetULeapS () const
 Leap seconds.
 
dt_type GetDt () const
 Frame length.
 
dt_type GetDt () const
 Frame length.
 
void SetName (const std::string &Name)
 Establish the name.
 
void SetName (const std::string &Name)
 Establish the name.
 
void SetRun (run_type Run)
 Establish the run number.
 
void SetRun (run_type Run)
 Establish the run number.
 
void SetDataQuality (dataQuality_type DataQuality)
 Establish the data quality flag.
 
void SetDataQuality (dataQuality_type DataQuality)
 Establish the data quality flag.
 
void SetDt (dt_type Dt)
 Establish the frame duration.
 
void SetDt (dt_type Dt)
 Establish the frame duration.
 
void SetGTime (const GPSTime &GTime)
 Establish the start time.
 
void SetGTime (const GPSTime &GTime)
 Establish the start time.
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
rawData_type GetRawData () const
 Retrieve the raw data reference.
 
rawData_type GetRawData ()
 Retrieve the raw data reference.
 
rawData_type GetRawData () const
 Retrieve the raw data reference.
 
rawData_type GetRawData ()
 Retrieve the raw data reference.
 
rawData_type GetRawData () const
 Retrieve the raw data reference.
 
rawData_type GetRawData ()
 Retrieve the raw data reference.
 
rawData_type GetRawData () const
 Retrieve the raw data reference.
 
rawData_type GetRawData ()
 Retrieve the raw data reference.
 
const type_typeRefType () const
 
type_typeRefType ()
 
const type_typeRefType () const
 
type_typeRefType ()
 
const type_typeRefType () const
 
type_typeRefType ()
 
const type_typeRefType () const
 
type_typeRefType ()
 
const user_typeRefUser () const
 
user_typeRefUser ()
 
const user_typeRefUser () const
 
user_typeRefUser ()
 
const user_typeRefUser () const
 
user_typeRefUser ()
 
const user_typeRefUser () const
 
user_typeRefUser ()
 
const detectSim_typeRefDetectSim () const
 
detectSim_typeRefDetectSim ()
 
const detectSim_typeRefDetectSim () const
 
detectSim_typeRefDetectSim ()
 
const detectSim_typeRefDetectSim () const
 
detectSim_typeRefDetectSim ()
 
const detectSim_typeRefDetectSim () const
 
detectSim_typeRefDetectSim ()
 
const detectProc_typeRefDetectProc () const
 
detectProc_typeRefDetectProc ()
 
const detectProc_typeRefDetectProc () const
 
detectProc_typeRefDetectProc ()
 
const detectProc_typeRefDetectProc () const
 
detectProc_typeRefDetectProc ()
 
const detectProc_typeRefDetectProc () const
 
detectProc_typeRefDetectProc ()
 
const history_typeRefHistory () const
 
history_typeRefHistory ()
 
const history_typeRefHistory () const
 
history_typeRefHistory ()
 
const history_typeRefHistory () const
 
history_typeRefHistory ()
 
const history_typeRefHistory () const
 
history_typeRefHistory ()
 
const procData_typeRefProcData () const
 
procData_typeRefProcData ()
 
const procData_typeRefProcData () const
 
procData_typeRefProcData ()
 
const procData_typeRefProcData () const
 
procData_typeRefProcData ()
 
const procData_typeRefProcData () const
 
procData_typeRefProcData ()
 
const simData_typeRefSimData () const
 
simData_typeRefSimData ()
 
const simData_typeRefSimData () const
 
simData_typeRefSimData ()
 
const simData_typeRefSimData () const
 
simData_typeRefSimData ()
 
const simData_typeRefSimData () const
 
simData_typeRefSimData ()
 
const event_typeRefEvent () const
 
event_typeRefEvent ()
 
const event_typeRefEvent () const
 
event_typeRefEvent ()
 
const event_typeRefEvent () const
 
event_typeRefEvent ()
 
const event_typeRefEvent () const
 
event_typeRefEvent ()
 
const simEvent_typeRefSimEvent () const
 
simEvent_typeRefSimEvent ()
 
const simEvent_typeRefSimEvent () const
 
simEvent_typeRefSimEvent ()
 
const simEvent_typeRefSimEvent () const
 
simEvent_typeRefSimEvent ()
 
const simEvent_typeRefSimEvent () const
 
simEvent_typeRefSimEvent ()
 
const summaryData_typeRefSummaryData () const
 
summaryData_typeRefSummaryData ()
 
const summaryData_typeRefSummaryData () const
 
summaryData_typeRefSummaryData ()
 
const summaryData_typeRefSummaryData () const
 
summaryData_typeRefSummaryData ()
 
const summaryData_typeRefSummaryData () const
 
summaryData_typeRefSummaryData ()
 
const auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
void SetRawData (rawData_type r)
 
void SetRawData (rawData_type r)
 
void SetRawData (rawData_type r)
 
void SetRawData (rawData_type r)
 
rawData_typeAddressOfRawData () const
 
rawData_typeAddressOfRawData () const
 
rawData_typeAddressOfRawData () const
 
rawData_typeAddressOfRawData () const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, stream_base_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, stream_base_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType, typename CurrentType>
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType, typename CurrentType>
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<class T>
static int DataType (const T *Data)
 
template<class T>
static int DataType (const T &Data)
 
template<class T>
static int DataType (const T *Data)
 
template<class T>
static int DataType (const T &Data)
 

Static Public Attributes

static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FRAME_H
 
static const INT_2U MAX_REF
 
static const INT_2U MAX_REF
 

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid.
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid.
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
void assign (assign_stream_type &Stream)
 Hook to provide table of contents information.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 

Static Protected Member Functions

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

Protected Attributes

data_type m_data
 
ref_type m_refs
 
ref_type m_refs
 

Private Member Functions

 FrameH (istream_type &Stream)
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, stream_base_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, stream_base_type *Stream) const
 Upgrade an object.
 
 FrameH (istream_type &Stream)
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, stream_base_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, stream_base_type *Stream) const
 Upgrade an object.
 

Private Attributes

const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Member Typedef Documentation

◆ assign_stream_type [1/2]

typedef Common::FrameH::assign_stream_type FrameCPP::Version_6::FrameH::assign_stream_type

◆ assign_stream_type [2/2]

typedef Common::FrameH::assign_stream_type FrameCPP::Version_6::FrameH::assign_stream_type

◆ auxData_hash_iterator [1/3]

◆ auxData_hash_iterator [2/3]

◆ auxData_hash_iterator [3/3]

◆ auxData_iterator [1/3]

◆ auxData_iterator [2/3]

◆ auxData_iterator [3/3]

◆ auxData_type [1/3]

◆ auxData_type [2/3]

◆ auxData_type [3/3]

◆ auxTable_hash_iterator [1/3]

◆ auxTable_hash_iterator [2/3]

◆ auxTable_hash_iterator [3/3]

◆ auxTable_iterator [1/3]

◆ auxTable_iterator [2/3]

◆ auxTable_iterator [3/3]

◆ auxTable_type [1/3]

◆ auxTable_type [2/3]

◆ auxTable_type [3/3]

◆ const_auxData_hash_iterator [1/3]

◆ const_auxData_hash_iterator [2/3]

◆ const_auxData_hash_iterator [3/3]

◆ const_auxData_iterator [1/3]

◆ const_auxData_iterator [2/3]

◆ const_auxData_iterator [3/3]

◆ const_auxTable_hash_iterator [1/3]

◆ const_auxTable_hash_iterator [2/3]

◆ const_auxTable_hash_iterator [3/3]

◆ const_auxTable_iterator [1/3]

◆ const_auxTable_iterator [2/3]

◆ const_auxTable_iterator [3/3]

◆ const_detectProc_hash_iterator [1/3]

◆ const_detectProc_hash_iterator [2/3]

◆ const_detectProc_hash_iterator [3/3]

◆ const_detectProc_iterator [1/3]

◆ const_detectProc_iterator [2/3]

◆ const_detectProc_iterator [3/3]

◆ const_detectSim_hash_iterator [1/3]

◆ const_detectSim_hash_iterator [2/3]

◆ const_detectSim_hash_iterator [3/3]

◆ const_detectSim_iterator [1/3]

◆ const_detectSim_iterator [2/3]

◆ const_detectSim_iterator [3/3]

◆ const_event_hash_iterator [1/3]

◆ const_event_hash_iterator [2/3]

◆ const_event_hash_iterator [3/3]

◆ const_event_iterator [1/3]

◆ const_event_iterator [2/3]

◆ const_event_iterator [3/3]

◆ const_history_hash_iterator [1/3]

◆ const_history_hash_iterator [2/3]

◆ const_history_hash_iterator [3/3]

◆ const_history_iterator [1/3]

◆ const_history_iterator [2/3]

◆ const_history_iterator [3/3]

◆ const_procData_hash_iterator [1/3]

◆ const_procData_hash_iterator [2/3]

◆ const_procData_hash_iterator [3/3]

◆ const_procData_iterator [1/3]

◆ const_procData_iterator [2/3]

◆ const_procData_iterator [3/3]

◆ const_simData_hash_iterator [1/3]

◆ const_simData_hash_iterator [2/3]

◆ const_simData_hash_iterator [3/3]

◆ const_simData_iterator [1/3]

◆ const_simData_iterator [2/3]

◆ const_simData_iterator [3/3]

◆ const_simEvent_hash_iterator [1/3]

◆ const_simEvent_hash_iterator [2/3]

◆ const_simEvent_hash_iterator [3/3]

◆ const_simEvent_iterator [1/3]

◆ const_simEvent_iterator [2/3]

◆ const_simEvent_iterator [3/3]

◆ const_summaryData_hash_iterator [1/3]

◆ const_summaryData_hash_iterator [2/3]

◆ const_summaryData_hash_iterator [3/3]

◆ const_summaryData_iterator [1/3]

◆ const_summaryData_iterator [2/3]

◆ const_summaryData_iterator [3/3]

◆ const_type_hash_iterator [1/3]

◆ const_type_hash_iterator [2/3]

◆ const_type_hash_iterator [3/3]

◆ const_type_iterator [1/3]

◆ const_type_iterator [2/3]

◆ const_type_iterator [3/3]

◆ const_user_hash_iterator [1/3]

◆ const_user_hash_iterator [2/3]

◆ const_user_hash_iterator [3/3]

◆ const_user_iterator [1/3]

◆ const_user_iterator [2/3]

◆ const_user_iterator [3/3]

◆ dataQuality_type [1/2]

◆ dataQuality_type [2/2]

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ demote_stream_type [1/2]

◆ demote_stream_type [2/2]

◆ detectProc_hash_iterator [1/3]

◆ detectProc_hash_iterator [2/3]

◆ detectProc_hash_iterator [3/3]

◆ detectProc_iterator [1/3]

◆ detectProc_iterator [2/3]

◆ detectProc_iterator [3/3]

◆ detectProc_type [1/3]

◆ detectProc_type [2/3]

◆ detectProc_type [3/3]

◆ detectSim_hash_iterator [1/3]

◆ detectSim_hash_iterator [2/3]

◆ detectSim_hash_iterator [3/3]

◆ detectSim_iterator [1/3]

◆ detectSim_iterator [2/3]

◆ detectSim_iterator [3/3]

◆ detectSim_type [1/3]

◆ detectSim_type [2/3]

◆ detectSim_type [3/3]

◆ dt_type [1/2]

◆ dt_type [2/2]

◆ event_hash_iterator [1/3]

◆ event_hash_iterator [2/3]

◆ event_hash_iterator [3/3]

◆ event_iterator [1/3]

◆ event_iterator [2/3]

◆ event_iterator [3/3]

◆ event_type [1/3]

◆ event_type [2/3]

◆ event_type [3/3]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ frame_type [1/2]

◆ frame_type [2/2]

◆ GTime_type [1/2]

◆ GTime_type [2/2]

◆ GTimeN_type [1/2]

◆ GTimeN_type [2/2]

◆ GTimeS_type [1/2]

◆ GTimeS_type [2/2]

◆ history_hash_iterator [1/3]

◆ history_hash_iterator [2/3]

◆ history_hash_iterator [3/3]

◆ history_iterator [1/3]

◆ history_iterator [2/3]

◆ history_iterator [3/3]

◆ history_type [1/3]

◆ history_type [2/3]

◆ history_type [3/3]

◆ localTime_type [1/2]

◆ localTime_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ procData_hash_iterator [1/3]

◆ procData_hash_iterator [2/3]

◆ procData_hash_iterator [3/3]

◆ procData_iterator [1/3]

◆ procData_iterator [2/3]

◆ procData_iterator [3/3]

◆ procData_type [1/3]

◆ procData_type [2/3]

◆ procData_type [3/3]

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ promote_stream_type [1/2]

◆ promote_stream_type [2/2]

◆ rawData_type [1/3]

◆ rawData_type [2/3]

◆ rawData_type [3/3]

◆ run_type [1/2]

◆ run_type [2/2]

◆ simData_hash_iterator [1/3]

◆ simData_hash_iterator [2/3]

◆ simData_hash_iterator [3/3]

◆ simData_iterator [1/3]

◆ simData_iterator [2/3]

◆ simData_iterator [3/3]

◆ simData_type [1/3]

◆ simData_type [2/3]

◆ simData_type [3/3]

◆ simEvent_hash_iterator [1/3]

◆ simEvent_hash_iterator [2/3]

◆ simEvent_hash_iterator [3/3]

◆ simEvent_iterator [1/3]

◆ simEvent_iterator [2/3]

◆ simEvent_iterator [3/3]

◆ simEvent_type [1/3]

◆ simEvent_type [2/3]

◆ simEvent_type [3/3]

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ summaryData_hash_iterator [1/3]

◆ summaryData_hash_iterator [2/3]

◆ summaryData_hash_iterator [3/3]

◆ summaryData_iterator [1/3]

◆ summaryData_iterator [2/3]

◆ summaryData_iterator [3/3]

◆ summaryData_type [1/3]

◆ summaryData_type [2/3]

◆ summaryData_type [3/3]

◆ type_hash_iterator [1/3]

◆ type_hash_iterator [2/3]

◆ type_hash_iterator [3/3]

◆ type_iterator [1/3]

◆ type_iterator [2/3]

◆ type_iterator [3/3]

◆ type_type [1/3]

◆ type_type [2/3]

◆ type_type [3/3]

◆ ULeapS_type [1/2]

◆ ULeapS_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

◆ user_hash_iterator [1/3]

◆ user_hash_iterator [2/3]

◆ user_hash_iterator [3/3]

◆ user_iterator [1/3]

◆ user_iterator [2/3]

◆ user_iterator [3/3]

◆ user_type [1/3]

◆ user_type [2/3]

◆ user_type [3/3]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ copy_type [1/2]

enum FrameCPP::Common::FrameH::copy_type
inherited
Enumerator
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

◆ copy_type [2/2]

enum FrameCPP::Common::FrameH::copy_type
inherited
Enumerator
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

Constructor & Destructor Documentation

◆ FrameH() [1/12]

FrameH::FrameH ( )

◆ FrameH() [2/12]

FrameH::FrameH ( const FrameH & frame)

◆ FrameH() [3/12]

FrameH::FrameH ( const std::string & name,
INT_4S run,
INT_4U frame,
const GPSTime & time,
INT_2U uLeapS,
const REAL_8 dt,
INT_4U dqual = 0 )

◆ FrameH() [4/12]

FrameH::FrameH ( const FrameHNPS & Source)

◆ FrameH() [5/12]

FrameH::FrameH ( const Previous::FrameH & Source,
stream_base_type * Stream )
inline

◆ ~FrameH() [1/2]

FrameH::~FrameH ( )
virtual

Reimplemented from FrameCPP::Common::FrameH.

◆ FrameH() [6/12]

FrameH::FrameH ( istream_type & Stream)
private

◆ FrameH() [7/12]

FrameCPP::Version_6::FrameH::FrameH ( )

◆ FrameH() [8/12]

FrameCPP::Version_6::FrameH::FrameH ( const FrameH & frame)

◆ FrameH() [9/12]

FrameCPP::Version_6::FrameH::FrameH ( const std::string & name,
INT_4S run,
INT_4U frame,
const GPSTime & time,
INT_2U uLeapS,
const REAL_8 dt,
INT_4U dqual = 0 )

◆ FrameH() [10/12]

FrameCPP::Version_6::FrameH::FrameH ( const FrameHNPS & Source)

◆ FrameH() [11/12]

FrameCPP::Version_6::FrameH::FrameH ( const Previous::FrameH & Source,
stream_base_type * Stream )

◆ ~FrameH() [2/2]

FrameCPP::Version_6::FrameH::~FrameH ( )
virtual

Reimplemented from FrameCPP::Common::FrameH.

◆ FrameH() [12/12]

FrameCPP::Version_6::FrameH::FrameH ( istream_type & Stream)
private

Member Function Documentation

◆ AddressOfRawData() [1/4]

◆ AddressOfRawData() [2/4]

◆ AddressOfRawData() [3/4]

◆ AddressOfRawData() [4/4]

◆ assign() [1/4]

virtual void FrameCPP::Common::FrameH::assign ( assign_stream_type & Stream)
pure virtualinherited

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

◆ assign() [2/4]

void FrameH::assign ( assign_stream_type & Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ assign() [3/4]

virtual void FrameCPP::Version_6::FrameH::assign ( assign_stream_type & Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ assign() [4/4]

void FrameHNPS::assign ( assign_stream_type & Stream)
inlineprotectedinherited

Hook to provide table of contents information.

Assign the contents of the instance

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameH::Bytes ( const Common::StreamBase & Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_6::FrameH::Bytes ( const Common::StreamBase & Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Clone() [1/2]

FrameH * FrameH::Clone ( ) const
virtual

Virtual constructor.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Clone() [2/2]

virtual FrameH * FrameCPP::Version_6::FrameH::Clone ( ) const
virtual

Virtual constructor.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [1/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, and FrVect.

◆ Create() [2/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream & Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

◆ Create() [3/4]

FrameH * FrameH::Create ( istream_type & Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [4/4]

virtual FrameH * FrameCPP::Version_6::FrameH::Create ( istream_type & Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ dataDescription() [1/2]

template<typename SE>
void FrameHNPS::dataDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.

Append descriptions of the fields managed by this object to the user supplied Description object.

◆ dataDescription() [2/2]

template<typename SE>
static void FrameCPP::Version_6::FrameHNPS::dataDescription ( Common::Description & Desc)
staticprotectedinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.

◆ DataType() [1/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T>
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote() [1/2]

FrameH::demote_ret_type FrameH::demote ( INT_2U Target,
demote_arg_type Obj,
stream_base_type * Stream ) const
privatevirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_6::FrameH::demote ( INT_2U Target,
demote_arg_type Obj,
stream_base_type * Stream ) const
privatevirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDataQuality() [1/2]

FrameHNPS::dataQuality_type FrameHNPS::GetDataQuality ( ) const
inlineinherited

Data quality flag.

Retrieve the data quality flag associated with the frame.

Returns
The data quality flag for the frame

◆ GetDataQuality() [2/2]

dataQuality_type FrameCPP::Version_6::FrameHNPS::GetDataQuality ( ) const
inherited

Data quality flag.

Returns
The data quality flag for the frame

◆ GetDescription() [1/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [3/4]

◆ GetDescription() [4/4]

◆ GetDt() [1/2]

FrameHNPS::dt_type FrameHNPS::GetDt ( ) const
inlineinherited

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetDt() [2/2]

dt_type FrameCPP::Version_6::FrameHNPS::GetDt ( ) const
inherited

Frame length.

Returns
Length of frame in seconds.

◆ GetFrame() [1/2]

FrameHNPS::frame_type FrameHNPS::GetFrame ( ) const
inlineinherited

Frame number.

Retrieve the frame number associated with the frame.

Returns
The frame number of the frame

◆ GetFrame() [2/2]

frame_type FrameCPP::Version_6::FrameHNPS::GetFrame ( ) const
inherited

Frame number.

Returns
The frame number of the frame

◆ GetGTime() [1/2]

const GPSTime & FrameHNPS::GetGTime ( ) const
inlineinherited

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetGTime() [2/2]

const GPSTime & FrameCPP::Version_6::FrameHNPS::GetGTime ( ) const
inherited

Start Time.

Returns
The start time of the frame

◆ GetName() [1/2]

const std::string & FrameHNPS::GetName ( ) const
inlineinherited

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetName() [2/2]

const std::string & FrameCPP::Version_6::FrameHNPS::GetName ( ) const
inherited

Retrieve name of project.

Returns
Name of project

◆ GetRawData() [1/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [2/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [3/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [4/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [5/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [6/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [7/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [8/8]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRun() [1/2]

FrameHNPS::run_type FrameHNPS::GetRun ( ) const
inlineinherited

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ GetRun() [2/2]

run_type FrameCPP::Version_6::FrameHNPS::GetRun ( ) const
inherited

Run number.

Returns
The run number of the frame

◆ GetULeapS() [1/2]

FrameHNPS::ULeapS_type FrameHNPS::GetULeapS ( ) const
inlineinherited

Leap seconds.

Retrieve the number of leap seconds associated with the frame.

Returns
The integer number of leap seconds associated with the start time.

◆ GetULeapS() [2/2]

ULeapS_type FrameCPP::Version_6::FrameHNPS::GetULeapS ( ) const
inherited

Leap seconds.

Returns
The integer number of leap seconds associated with the start time.

◆ normalizedDeltaT() [1/2]

delta_t_normalized_type FrameH::normalizedDeltaT ( ) const
inlineprotectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedDeltaT() [2/2]

virtual delta_t_normalized_type FrameCPP::Version_6::FrameH::normalizedDeltaT ( ) const
protectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [1/2]

start_time_normalized_type FrameH::normalizedStartTime ( ) const
inlineprotectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [2/2]

virtual start_time_normalized_type FrameCPP::Version_6::FrameH::normalizedStartTime ( ) const
protectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ ObjectStructName() [1/2]

const char * FrameH::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_6::FrameH::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/4]

bool FrameH::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_6::FrameH::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/4]

bool FrameH::operator== ( const FrameH & RHS) const
inline

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_6::FrameH::operator== ( const FrameH & RHS) const

comparison operator

◆ Promote() [1/2]

FrameH::promote_ret_type FrameH::Promote ( INT_2U Source,
promote_arg_type Obj,
stream_base_type * Stream )
inlinestatic

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_6::FrameH::Promote ( INT_2U Source,
promote_arg_type Obj,
stream_base_type * Stream )
static

◆ promote() [1/2]

FrameH::promote_ret_type FrameH::promote ( INT_2U Target,
promote_arg_type Obj,
stream_base_type * Stream ) const
privatevirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_6::FrameH::promote ( INT_2U Target,
promote_arg_type Obj,
stream_base_type * Stream ) const
privatevirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/5]

template<typename PreviousType, typename CurrentType>
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/5]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/5]

template<typename PreviousType, typename CurrentType>
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/5]

template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target,
FrameSpec::ObjectInterface::frame_spec_version_type Source,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream )
inherited

◆ readSubset() [1/2]

void FrameH::readSubset ( istream_type & Stream,
INT_4U ElementMask )
protectedvirtual

◆ readSubset() [2/2]

virtual void FrameCPP::Version_6::FrameH::readSubset ( istream_type & Stream,
INT_4U ElementMask )
protectedvirtual

◆ RefAuxData() [1/8]

◆ RefAuxData() [2/8]

◆ RefAuxData() [3/8]

◆ RefAuxData() [4/8]

◆ RefAuxData() [5/8]

◆ RefAuxData() [6/8]

◆ RefAuxData() [7/8]

◆ RefAuxData() [8/8]

◆ RefAuxTable() [1/8]

◆ RefAuxTable() [2/8]

◆ RefAuxTable() [3/8]

◆ RefAuxTable() [4/8]

◆ RefAuxTable() [5/8]

◆ RefAuxTable() [6/8]

◆ RefAuxTable() [7/8]

◆ RefAuxTable() [8/8]

◆ refDescription() [1/4]

static void FrameCPP::Version_6::FrameHPST< FrDetector, FrEvent, FrHistory, FrProcData, FrRawData, FrSimData, FrSimEvent, FrSummary, FrTable, FrVect >::refDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

◆ refDescription() [2/4]

static void FrameCPP::Version_6::FrameHPST< FrDetector, FrEvent, FrHistory, FrProcData, FrRawData, FrSimData, FrSimEvent, FrSummary, FrTable, FrVect >::refDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

◆ refDescription() [3/4]

static void FrameCPP::Version_6::FrameHPST< FrDetector, FrEvent, FrHistory, FrProcData, FrRawData, FrSimData, FrSimEvent, FrSummary, FrTable, FrVect >::refDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

◆ refDescription() [4/4]

static void FrameCPP::Version_6::FrameHPST< FrDetector, FrEvent, FrHistory, FrProcData, FrRawData, FrSimData, FrSimEvent, FrSummary, FrTable, FrVect >::refDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

◆ RefDetectProc() [1/8]

◆ RefDetectProc() [2/8]

◆ RefDetectProc() [3/8]

◆ RefDetectProc() [4/8]

◆ RefDetectProc() [5/8]

◆ RefDetectProc() [6/8]

◆ RefDetectProc() [7/8]

◆ RefDetectProc() [8/8]

◆ RefDetectSim() [1/8]

◆ RefDetectSim() [2/8]

◆ RefDetectSim() [3/8]

◆ RefDetectSim() [4/8]

◆ RefDetectSim() [5/8]

◆ RefDetectSim() [6/8]

◆ RefDetectSim() [7/8]

◆ RefDetectSim() [8/8]

◆ RefEvent() [1/8]

◆ RefEvent() [2/8]

◆ RefEvent() [3/8]

◆ RefEvent() [4/8]

◆ RefEvent() [5/8]

◆ RefEvent() [6/8]

◆ RefEvent() [7/8]

◆ RefEvent() [8/8]

◆ RefHistory() [1/8]

◆ RefHistory() [2/8]

◆ RefHistory() [3/8]

◆ RefHistory() [4/8]

◆ RefHistory() [5/8]

◆ RefHistory() [6/8]

◆ RefHistory() [7/8]

◆ RefHistory() [8/8]

◆ RefProcData() [1/8]

◆ RefProcData() [2/8]

◆ RefProcData() [3/8]

◆ RefProcData() [4/8]

◆ RefProcData() [5/8]

◆ RefProcData() [6/8]

◆ RefProcData() [7/8]

◆ RefProcData() [8/8]

◆ RefSimData() [1/8]

◆ RefSimData() [2/8]

◆ RefSimData() [3/8]

◆ RefSimData() [4/8]

◆ RefSimData() [5/8]

◆ RefSimData() [6/8]

◆ RefSimData() [7/8]

◆ RefSimData() [8/8]

◆ RefSimEvent() [1/8]

◆ RefSimEvent() [2/8]

◆ RefSimEvent() [3/8]

◆ RefSimEvent() [4/8]

◆ RefSimEvent() [5/8]

◆ RefSimEvent() [6/8]

◆ RefSimEvent() [7/8]

◆ RefSimEvent() [8/8]

◆ RefSummaryData() [1/8]

◆ RefSummaryData() [2/8]

◆ RefSummaryData() [3/8]

◆ RefSummaryData() [4/8]

◆ RefSummaryData() [5/8]

◆ RefSummaryData() [6/8]

◆ RefSummaryData() [7/8]

◆ RefSummaryData() [8/8]

◆ RefType() [1/8]

◆ RefType() [2/8]

◆ RefType() [3/8]

◆ RefType() [4/8]

◆ RefType() [5/8]

◆ RefType() [6/8]

◆ RefType() [7/8]

◆ RefType() [8/8]

◆ RefUser() [1/8]

◆ RefUser() [2/8]

◆ RefUser() [3/8]

◆ RefUser() [4/8]

◆ RefUser() [5/8]

◆ RefUser() [6/8]

◆ RefUser() [7/8]

◆ RefUser() [8/8]

◆ SetDataQuality() [1/2]

void FrameHNPS::SetDataQuality ( dataQuality_type DataQuality)
inlineinherited

Establish the data quality flag.

Set the data quality flag of the frame.

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

◆ SetDataQuality() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetDataQuality ( dataQuality_type DataQuality)
inherited

Establish the data quality flag.

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

◆ SetDt() [1/2]

void FrameHNPS::SetDt ( dt_type Dt)
inlineinherited

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetDt() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetDt ( dt_type Dt)
inherited

Establish the frame duration.

Parameters
[in]DtThe length of the frame in seconds

◆ SetGTime() [1/2]

void FrameHNPS::SetGTime ( const GPSTime & GTime)
inlineinherited

Establish the start time.

Set the start time of the frame.

Parameters
[in]GTimeThe start time of the frame.

◆ SetGTime() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetGTime ( const GPSTime & GTime)
inherited

Establish the start time.

Parameters
[in]GTimeThe start time of the frame.

◆ SetName() [1/2]

void FrameHNPS::SetName ( const std::string & Name)
inlineinherited

Establish the name.

Parameters
[in]NameThe name to associate with the frame

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

◆ SetName() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetName ( const std::string & Name)
inherited

Establish the name.

Parameters
[in]NameThe name to associate with the frame

◆ SetRawData() [1/4]

◆ SetRawData() [2/4]

◆ SetRawData() [3/4]

◆ SetRawData() [4/4]

◆ SetRun() [1/2]

void FrameHNPS::SetRun ( run_type Run)
inlineinherited

Establish the run number.

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

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

◆ SetRun() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetRun ( run_type Run)
inherited

Establish the run number.

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

◆ SetULeapS() [1/2]

void FrameHNPS::SetULeapS ( ULeapS_type Value)
inlineinherited

Establish leap second offset.

Set the number of leap seconds since GPS epoc.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ SetULeapS() [2/2]

void FrameCPP::Version_6::FrameHNPS::SetULeapS ( ULeapS_type Value)
inherited

Establish leap second offset.

Parameters
[in]ValueNumber of leap seconds since GPS epoc.

◆ StructDescription() [1/2]

const Description * FrameH::StructDescription ( )
static

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_6::FrameH::StructDescription ( )
static

◆ StructName() [1/2]

const char * FrameH::StructName ( )
inlinestatic

◆ StructName() [2/2]

static const char * FrameCPP::Version_6::FrameH::StructName ( )
static

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ VerifyObject() [1/2]

void FrameH::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
protectedvirtual

Verify the object as being valid.

Parameters
[in]VerifierThe instance of the Verify object where state information is stored.
[in]StreamThe input stream from which the object is being read.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ VerifyObject() [2/2]

virtual void FrameCPP::Version_6::FrameH::VerifyObject ( Common::Verify & Verifier,
Common::IFrameStream & Stream ) const
protectedvirtual

Verify the object as being valid.

Parameters
[in]VerifierThe instance of the Verify object where state information is stored.
[in]StreamThe input stream from which the object is being read.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ vTOCQuery() [1/2]

void FrameHNPS::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtualinherited

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_6::FrameHNPS::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtualinherited

◆ Write() [1/2]

void FrameH::Write ( OStream & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/2]

virtual void FrameCPP::Version_6::FrameH::Write ( OStream & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

data_type FrameHNPS::m_data
protectedinherited

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ m_refs [1/2]

◆ m_refs [2/2]

◆ MAX_REF [1/2]

◆ MAX_REF [2/2]

◆ s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameH::s_object_id = Common::FrameSpec::Info::FSI_FRAME_H
staticinherited

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