ldas-tools-framecpp  2.5.8
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_6::FrameH Class Reference

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_6::FrameH:
FrameCPP::Common::FrameH FrameCPP::Version_6::FrameHNPS FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect > FrameCPP::Common::FrameSpec::Object FrameCPP::Common::TOCInfo FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

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
}
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef LDASTools::AL::SharedPtr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_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_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_U_LEAP_S_TYPE ULeapS_type
 
typedef FRAME_H_LOCAL_TIME_TYPE localTime_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
}
 
typedef STRING< INT_2U > string_2_type
 
typedef LDASTools::AL::SharedPtr< TRawData > rawData_type
 
typedef Common::SearchContainer< TVect, &TVect::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< TVect, &TVect::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< TDetector, &TDetector::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< TDetector, &TDetector::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< TEvent, &TEvent::GetNameSlow > event_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< THistory, &THistory::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< TProcData, &TProcData::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< TSimData, &TSimData::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< TSimEvent, &TSimEvent::GetNameSlow > simEvent_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< TSummary, &TSummary::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< TVect, &TVect::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< TTable, &TTable::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

 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, istream_type *Stream)
 
 ~FrameH ()
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrameHClone () const
 Virtual constructor. More...
 
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (OStream &Stream) const
 Write object to the stream. More...
 
bool operator== (const FrameH &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
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, IStream *Stream)
 
const std::string & GetName () const
 Retrieve name of project. More...
 
INT_4S GetRun () const
 Run number. More...
 
INT_4U GetFrame () const
 Frame number. More...
 
INT_4U GetDataQuality () const
 Data quality flag. More...
 
const GPSTimeGetGTime () const
 Start Time. More...
 
INT_2U GetULeapS () const
 Leap seconds. More...
 
REAL_8 GetDt () const
 Frame length. More...
 
void SetName (const std::string &Name)
 Establish the name. More...
 
void SetRun (INT_4S Run)
 Establish the run number. More...
 
void SetDataQuality (INT_4U DataQuality)
 Establish the data quality flag. More...
 
void SetDt (REAL_8 Dt)
 Establish the frame duration. More...
 
void SetGTime (const GPSTime &GTime)
 Establish the start time. More...
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset. More...
 
void TOCQuery (int InfoClass,...) const
 
rawData_type GetRawData () const
 Retrieve the raw data reference. More...
 
rawData_type GetRawData ()
 Retrieve the raw data reference. More...
 
const type_typeRefType () const
 
type_typeRefType ()
 
const user_typeRefUser () const
 
user_typeRefUser ()
 
const detectSim_typeRefDetectSim () const
 
detectSim_typeRefDetectSim ()
 
const detectProc_typeRefDetectProc () const
 
detectProc_typeRefDetectProc ()
 
const history_typeRefHistory () const
 
history_typeRefHistory ()
 
const procData_typeRefProcData () const
 
procData_typeRefProcData ()
 
const simData_typeRefSimData () const
 
simData_typeRefSimData ()
 
const event_typeRefEvent () const
 
event_typeRefEvent ()
 
const simEvent_typeRefSimEvent () const
 
simEvent_typeRefSimEvent ()
 
const summaryData_typeRefSummaryData () const
 
summaryData_typeRefSummaryData ()
 
const auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
void SetRawData (rawData_type r)
 
rawData_typeAddressOfRawData () const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
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 = 13
 

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid. More...
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds. More...
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame. More...
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
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. More...
 
template<typename SE >
static void refDescription (Common::Description &Desc)
 

Protected Attributes

data_type m_data
 
ref_type m_refs
 

Member Typedef Documentation

◆ assign_stream_type

◆ auxData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxData_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::auxData_hash_iterator
inherited

◆ auxData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxData_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::auxData_iterator
inherited

◆ auxData_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::auxData_type
inherited

◆ auxTable_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxTable_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::auxTable_hash_iterator
inherited

◆ auxTable_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxTable_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::auxTable_iterator
inherited

◆ auxTable_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::auxTable_type
inherited

◆ const_auxData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxData_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_auxData_hash_iterator
inherited

◆ const_auxData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxData_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_auxData_iterator
inherited

◆ const_auxTable_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxTable_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_auxTable_hash_iterator
inherited

◆ const_auxTable_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef auxTable_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_auxTable_iterator
inherited

◆ const_detectProc_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectProc_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_detectProc_hash_iterator
inherited

◆ const_detectProc_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectProc_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_detectProc_iterator
inherited

◆ const_detectSim_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectSim_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_detectSim_hash_iterator
inherited

◆ const_detectSim_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectSim_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_detectSim_iterator
inherited

◆ const_event_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef event_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_event_hash_iterator
inherited

◆ const_event_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef event_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_event_iterator
inherited

◆ const_history_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef history_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_history_hash_iterator
inherited

◆ const_history_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef history_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_history_iterator
inherited

◆ const_procData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef procData_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_procData_hash_iterator
inherited

◆ const_procData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef procData_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_procData_iterator
inherited

◆ const_simData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simData_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_simData_hash_iterator
inherited

◆ const_simData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simData_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_simData_iterator
inherited

◆ const_simEvent_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simEvent_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_simEvent_hash_iterator
inherited

◆ const_simEvent_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simEvent_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_simEvent_iterator
inherited

◆ const_summaryData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef summaryData_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_summaryData_hash_iterator
inherited

◆ const_summaryData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef summaryData_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_summaryData_iterator
inherited

◆ const_type_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef type_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_type_hash_iterator
inherited

◆ const_type_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef type_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_type_iterator
inherited

◆ const_user_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef user_type::const_hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_user_hash_iterator
inherited

◆ const_user_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef user_type::const_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::const_user_iterator
inherited

◆ demote_arg_type

◆ demote_ret_type

◆ detectProc_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectProc_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::detectProc_hash_iterator
inherited

◆ detectProc_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectProc_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::detectProc_iterator
inherited

◆ detectProc_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TDetector, &TDetector::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::detectProc_type
inherited

◆ detectSim_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectSim_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::detectSim_hash_iterator
inherited

◆ detectSim_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef detectSim_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::detectSim_iterator
inherited

◆ detectSim_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TDetector, &TDetector::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::detectSim_type
inherited

◆ dt_type

◆ event_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef event_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::event_hash_iterator
inherited

◆ event_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef event_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::event_iterator
inherited

◆ event_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TEvent, &TEvent::GetNameSlow > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::event_type
inherited

◆ frame_spec_version_type

◆ frame_type

◆ GTime_type

◆ GTimeN_type

◆ GTimeS_type

◆ history_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef history_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::history_hash_iterator
inherited

◆ history_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef history_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::history_iterator
inherited

◆ history_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< THistory, &THistory::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::history_type
inherited

◆ localTime_type

◆ name_type

◆ object_type

typedef LDASTools::AL::SharedPtr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ procData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef procData_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::procData_hash_iterator
inherited

◆ procData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef procData_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::procData_iterator
inherited

◆ procData_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TProcData, &TProcData::GetNameSlow > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::procData_type
inherited

◆ promote_arg_type

◆ promote_ret_type

◆ rawData_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef LDASTools::AL::SharedPtr< TRawData > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::rawData_type
inherited

◆ run_type

◆ simData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simData_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::simData_hash_iterator
inherited

◆ simData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simData_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::simData_iterator
inherited

◆ simData_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TSimData, &TSimData::GetNameSlow > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::simData_type
inherited

◆ simEvent_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simEvent_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::simEvent_hash_iterator
inherited

◆ simEvent_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef simEvent_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::simEvent_iterator
inherited

◆ simEvent_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TSimEvent, &TSimEvent::GetNameSlow > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::simEvent_type
inherited

◆ string_2_type

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

◆ summaryData_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef summaryData_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::summaryData_hash_iterator
inherited

◆ summaryData_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef summaryData_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::summaryData_iterator
inherited

◆ summaryData_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TSummary, &TSummary::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::summaryData_type
inherited

◆ type_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef type_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::type_hash_iterator
inherited

◆ type_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef type_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::type_iterator
inherited

◆ type_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::type_type
inherited

◆ ULeapS_type

◆ unique_object_type

◆ user_hash_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef user_type::hash_iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::user_hash_iterator
inherited

◆ user_iterator

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef user_type::iterator FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::user_iterator
inherited

◆ user_type

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::user_type
inherited

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 

◆ copy_type

Enumerator
DETECT_SIM 
DETECT_PROC 
HISTORY 
RAW_DATA 
AUX_DATA 
AUX_TABLE 
TYPE 
USER 

Constructor & Destructor Documentation

◆ FrameH() [1/5]

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

◆ FrameH() [2/5]

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

◆ FrameH() [3/5]

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() [4/5]

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

◆ FrameH() [5/5]

FrameCPP::Version_6::FrameH::FrameH ( const Previous::FrameH Source,
istream_type Stream 
)
inline

◆ ~FrameH()

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

Reimplemented from FrameCPP::Common::FrameH.

Member Function Documentation

◆ AddressOfRawData()

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type* FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::AddressOfRawData ( ) const
inlineinherited

◆ assign()

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.

Implements FrameCPP::Common::FrameH.

◆ Bytes()

FrameCPP::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()

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

Virtual constructor.

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

◆ Create() [1/3]

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

◆ Create() [2/3]

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

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ Create() [3/3]

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

constructor - virtual

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

◆ dataDescription()

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.

◆ DataType() [1/2]

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

◆ DataType() [2/2]

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

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_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.

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetDataQuality()

INT_4U FrameHNPS::GetDataQuality ( ) const
inlineinherited

Data quality flag.

Retrieve the data quality flag associated with the frame.

Returns
The data quality flag for the frame

◆ GetDescription()

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.

◆ GetDt()

REAL_8 FrameHNPS::GetDt ( ) const
inlineinherited

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetFrame()

INT_4U FrameHNPS::GetFrame ( ) const
inlineinherited

Frame number.

Retrieve the frame number associated with the frame.

Returns
The frame number of the frame

◆ GetGTime()

const GPSTime & FrameHNPS::GetGTime ( ) const
inlineinherited

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetName()

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

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetRawData() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( ) const
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
rawData_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::GetRawData ( )
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRun()

INT_4S FrameHNPS::GetRun ( ) const
inlineinherited

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ GetULeapS()

INT_2U 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.

◆ normalizedDeltaT()

delta_t_normalized_type FrameCPP::Version_6::FrameH::normalizedDeltaT ( ) const
inlineprotectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime()

start_time_normalized_type FrameCPP::Version_6::FrameH::normalizedStartTime ( ) const
inlineprotectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ ObjectStructName()

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/2]

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

comparison operator

◆ operator==() [2/2]

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

comparison operator

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

◆ Promote()

FrameH::promote_ret_type FrameCPP::Version_6::FrameH::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_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/3]

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,
istream_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/3]

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,
IStream Stream 
)
inherited

◆ readSubset()

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

◆ RefAuxData() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const auxData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefAuxData ( ) const
inlineinherited

◆ RefAuxData() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
auxData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefAuxData ( )
inlineinherited

◆ RefAuxTable() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const auxTable_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefAuxTable ( ) const
inlineinherited

◆ RefAuxTable() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
auxTable_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefAuxTable ( )
inlineinherited

◆ refDescription()

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
template<typename SE >
static void FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::refDescription ( Common::Description Desc)
inlinestaticprotectedinherited

◆ RefDetectProc() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const detectProc_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefDetectProc ( ) const
inlineinherited

◆ RefDetectProc() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
detectProc_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefDetectProc ( )
inlineinherited

◆ RefDetectSim() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const detectSim_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefDetectSim ( ) const
inlineinherited

◆ RefDetectSim() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
detectSim_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefDetectSim ( )
inlineinherited

◆ RefEvent() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const event_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefEvent ( ) const
inlineinherited

◆ RefEvent() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
event_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefEvent ( )
inlineinherited

◆ RefHistory() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const history_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefHistory ( ) const
inlineinherited

◆ RefHistory() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
history_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefHistory ( )
inlineinherited

◆ RefProcData() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const procData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefProcData ( ) const
inlineinherited

◆ RefProcData() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
procData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefProcData ( )
inlineinherited

◆ RefSimData() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const simData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefSimData ( ) const
inlineinherited

◆ RefSimData() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
simData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefSimData ( )
inlineinherited

◆ RefSimEvent() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const simEvent_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefSimEvent ( ) const
inlineinherited

◆ RefSimEvent() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
simEvent_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefSimEvent ( )
inlineinherited

◆ RefSummaryData() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const summaryData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefSummaryData ( ) const
inlineinherited

◆ RefSummaryData() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
summaryData_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefSummaryData ( )
inlineinherited

◆ RefType() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const type_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefType ( ) const
inlineinherited

◆ RefType() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
type_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefType ( )
inlineinherited

◆ RefUser() [1/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const user_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefUser ( ) const
inlineinherited

◆ RefUser() [2/2]

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
user_type& FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::RefUser ( )
inlineinherited

◆ SetDataQuality()

void FrameHNPS::SetDataQuality ( INT_4U  DataQuality)
inlineinherited

Establish the data quality flag.

Set the data quality flag of the frame.

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

◆ SetDt()

void FrameHNPS::SetDt ( REAL_8  Dt)
inlineinherited

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetGTime()

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.

◆ SetName()

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.

◆ SetRawData()

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
void FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::SetRawData ( rawData_type  r)
inlineinherited

◆ SetRun()

void FrameHNPS::SetRun ( INT_4S  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.

◆ SetULeapS()

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.

◆ StructDescription()

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

◆ StructName()

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

◆ TOCQuery()

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

◆ VerifyObject()

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()

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

◆ Write()

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()

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

◆ m_data

data_type FrameCPP::Version_6::FrameHNPS::m_data
protectedinherited

◆ m_refs

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
ref_type FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::m_refs
protectedinherited

◆ MAX_REF

template<typename TDetector , typename TEvent , typename THistory , typename TProcData , typename TRawData , typename TSimData , typename TSimEvent , typename TSummary , typename TTable , typename TVect >
const INT_2U FrameCPP::Version_6::FrameHPST< TDetector, TEvent, THistory, TProcData, TRawData, TSimData, TSimEvent, TSummary, TTable, TVect >::MAX_REF = 13
staticinherited

◆ s_object_id

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

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