ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrameHImpl::ClassicIO< T > Class Template Referenceabstract

#include <FrameHClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrameHImpl::ClassicIO< T >:
Collaboration diagram for FrameCPP::Version_8::FrameHImpl::ClassicIO< T >:

Public Types

typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef FRAME_H_NAME_TYPE name_type
 
typedef FRAME_H_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
 
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 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::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 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::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::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 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::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 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::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::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 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::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 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::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::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 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::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 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::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::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 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::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 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::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::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 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::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 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::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::const_hash_iterator const_auxTable_hash_iterator
 
typedef auxTable_type::const_hash_iterator const_auxTable_hash_iterator
 
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 ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameH, checksum_typeself_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_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
 

Public Member Functions

 ClassicIO ()
 
 ClassicIO (const Previous::FrameH &Source, stream_base_type *Stream)
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
 ClassicIO ()
 
 ClassicIO (const Previous::FrameH &Source, stream_base_type *Stream)
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
rawData_typeAddressOfRawData () const
 
rawData_typeAddressOfRawData () const
 
const name_typeGetName () const
 Retrieve name of project.
 
const name_typeGetName () 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 GTime_typeGetGTime () const
 Start Time.
 
const GTime_typeGetGTime () 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 name_type &Name)
 Establish the name.
 
void SetName (const name_type &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 GTime_type &Value)
 Establish the start time.
 
void SetGTime (const GTime_type &Value)
 Establish the start time.
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
 
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 user_typeRefUser () const
 
user_typeRefUser ()
 
const user_typeRefUser () const
 
user_typeRefUser ()
 
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 history_typeRefHistory () const
 
history_typeRefHistory ()
 
const history_typeRefHistory () const
 
history_typeRefHistory ()
 
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 event_typeRefEvent () const
 
event_typeRefEvent ()
 
const event_typeRefEvent () const
 
event_typeRefEvent ()
 
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 auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxData_typeRefAuxData () const
 
auxData_typeRefAuxData ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
const auxTable_typeRefAuxTable () const
 
auxTable_typeRefAuxTable ()
 
void SetRawData (rawData_type r)
 
void SetRawData (rawData_type r)
 
bool operator== (const FrameH &RHS) const
 
bool operator== (const FrameH &RHS) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
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 bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
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)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
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 const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
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.
 

Static Public Attributes

static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 
static const INT_2U MAX_REF
 
static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FRAME_H
 

Protected Types

typedef Common::FrameH::assign_stream_type assign_stream_type
 
typedef Common::FrameH::assign_stream_type assign_stream_type
 

Protected Member Functions

virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Frame start time in seconds.
 
virtual start_time_normalized_type normalizedStartTime () const
 Duration of the frame.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 Limitted reading of the object.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
 
virtual delta_t_normalized_type normalizedDeltaT () const
 Frame start time in seconds.
 
virtual start_time_normalized_type normalizedStartTime () const
 Duration of the frame.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
 Limitted reading of the object.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Protected Attributes

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

Private Types

typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_typeobject_base_type
 

Private Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 
checksum_type m_chkSum
 Structure checksum.
 
checksum_type m_chkSum
 Structure checksum.
 
checksum_type m_chkSum
 Structure checksum.
 
checksum_type m_chkSum
 Structure checksum.
 
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]

template<typename T>
typedef Common::FrameH::assign_stream_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::assign_stream_type
protected

◆ assign_stream_type [2/2]

template<typename T>
typedef Common::FrameH::assign_stream_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::assign_stream_type
protected

◆ auxData_hash_iterator [1/2]

◆ auxData_hash_iterator [2/2]

◆ auxData_iterator [1/2]

◆ auxData_iterator [2/2]

◆ auxData_type [1/2]

◆ auxData_type [2/2]

◆ auxTable_hash_iterator [1/2]

◆ auxTable_hash_iterator [2/2]

◆ auxTable_iterator [1/2]

◆ auxTable_iterator [2/2]

◆ auxTable_type [1/2]

◆ auxTable_type [2/2]

◆ const_auxData_hash_iterator [1/2]

◆ const_auxData_hash_iterator [2/2]

◆ const_auxData_iterator [1/2]

◆ const_auxData_iterator [2/2]

◆ const_auxTable_hash_iterator [1/2]

◆ const_auxTable_hash_iterator [2/2]

◆ const_auxTable_iterator [1/2]

◆ const_auxTable_iterator [2/2]

◆ const_detectProc_hash_iterator [1/2]

◆ const_detectProc_hash_iterator [2/2]

◆ const_detectProc_iterator [1/2]

◆ const_detectProc_iterator [2/2]

◆ const_detectSim_hash_iterator [1/2]

◆ const_detectSim_hash_iterator [2/2]

◆ const_detectSim_iterator [1/2]

◆ const_detectSim_iterator [2/2]

◆ const_event_hash_iterator [1/2]

◆ const_event_hash_iterator [2/2]

◆ const_event_iterator [1/2]

◆ const_event_iterator [2/2]

◆ const_history_hash_iterator [1/2]

◆ const_history_hash_iterator [2/2]

◆ const_history_iterator [1/2]

◆ const_history_iterator [2/2]

◆ const_procData_hash_iterator [1/2]

◆ const_procData_hash_iterator [2/2]

◆ const_procData_iterator [1/2]

◆ const_procData_iterator [2/2]

◆ const_simData_hash_iterator [1/2]

◆ const_simData_hash_iterator [2/2]

◆ const_simData_iterator [1/2]

◆ const_simData_iterator [2/2]

◆ const_simEvent_hash_iterator [1/2]

◆ const_simEvent_hash_iterator [2/2]

◆ const_simEvent_iterator [1/2]

◆ const_simEvent_iterator [2/2]

◆ const_summaryData_hash_iterator [1/2]

◆ const_summaryData_hash_iterator [2/2]

◆ const_summaryData_iterator [1/2]

◆ const_summaryData_iterator [2/2]

◆ const_type_hash_iterator [1/2]

◆ const_type_hash_iterator [2/2]

◆ const_type_iterator [1/2]

◆ const_type_iterator [2/2]

◆ const_user_hash_iterator [1/2]

◆ const_user_hash_iterator [2/2]

◆ const_user_iterator [1/2]

◆ const_user_iterator [2/2]

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

◆ detectProc_hash_iterator [2/2]

◆ detectProc_iterator [1/2]

◆ detectProc_iterator [2/2]

◆ detectProc_type [1/2]

◆ detectProc_type [2/2]

◆ detectSim_hash_iterator [1/2]

◆ detectSim_hash_iterator [2/2]

◆ detectSim_iterator [1/2]

◆ detectSim_iterator [2/2]

◆ detectSim_type [1/2]

◆ detectSim_type [2/2]

◆ dt_type [1/2]

◆ dt_type [2/2]

◆ event_hash_iterator [1/2]

◆ event_hash_iterator [2/2]

◆ event_iterator [1/2]

◆ event_iterator [2/2]

◆ event_type [1/2]

◆ event_type [2/2]

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

◆ history_hash_iterator [2/2]

◆ history_iterator [1/2]

◆ history_iterator [2/2]

◆ history_type [1/2]

◆ history_type [2/2]

◆ io_name_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::io_name_type
private

◆ io_name_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::io_name_type
private

◆ istream_type [1/10]

◆ istream_type [2/10]

◆ istream_type [3/10]

◆ istream_type [4/10]

◆ istream_type [5/10]

◆ istream_type [6/10]

◆ istream_type [7/10]

◆ istream_type [8/10]

◆ istream_type [9/10]

◆ istream_type [10/10]

◆ localTime_type [1/2]

◆ localTime_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ object_base_type [1/2]

◆ object_base_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

◆ ostream_type [1/10]

◆ ostream_type [2/10]

◆ ostream_type [3/10]

◆ ostream_type [4/10]

◆ ostream_type [5/10]

◆ ostream_type [6/10]

◆ ostream_type [7/10]

◆ ostream_type [8/10]

◆ ostream_type [9/10]

◆ ostream_type [10/10]

◆ procData_hash_iterator [1/2]

◆ procData_hash_iterator [2/2]

◆ procData_iterator [1/2]

◆ procData_iterator [2/2]

◆ procData_type [1/2]

◆ procData_type [2/2]

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

◆ rawData_type [2/2]

◆ run_type [1/2]

◆ run_type [2/2]

◆ self_type [1/10]

◆ self_type [2/10]

◆ self_type [3/10]

◆ self_type [4/10]

◆ self_type [5/10]

◆ self_type [6/10]

◆ self_type [7/10]

◆ self_type [8/10]

◆ self_type [9/10]

◆ self_type [10/10]

◆ simData_hash_iterator [1/2]

◆ simData_hash_iterator [2/2]

◆ simData_iterator [1/2]

◆ simData_iterator [2/2]

◆ simData_type [1/2]

◆ simData_type [2/2]

◆ simEvent_hash_iterator [1/2]

◆ simEvent_hash_iterator [2/2]

◆ simEvent_iterator [1/2]

◆ simEvent_iterator [2/2]

◆ simEvent_type [1/2]

◆ simEvent_type [2/2]

◆ 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

◆ struct_desc_type [1/2]

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

◆ struct_desc_type [2/2]

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

◆ struct_id_type [1/2]

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

◆ struct_id_type [2/2]

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

◆ struct_name_type [1/2]

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

◆ struct_name_type [2/2]

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

◆ summaryData_hash_iterator [1/2]

◆ summaryData_hash_iterator [2/2]

◆ summaryData_iterator [1/2]

◆ summaryData_iterator [2/2]

◆ summaryData_type [1/2]

◆ summaryData_type [2/2]

◆ type_hash_iterator [1/2]

◆ type_hash_iterator [2/2]

◆ type_iterator [1/2]

◆ type_iterator [2/2]

◆ type_type [1/2]

◆ type_type [2/2]

◆ ULeapS_type [1/2]

◆ ULeapS_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

◆ user_hash_iterator [1/2]

◆ user_hash_iterator [2/2]

◆ user_iterator [1/2]

◆ user_iterator [2/2]

◆ user_type [1/2]

◆ user_type [2/2]

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

◆ ClassicIO() [1/4]

template<typename T>
FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [2/4]

template<typename T>
FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::ClassicIO ( const Previous::FrameH & Source,
stream_base_type * Stream )
inline

◆ ClassicIO() [3/4]

template<typename T>
FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [4/4]

template<typename T>
FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::ClassicIO ( const Previous::FrameH & Source,
stream_base_type * Stream )
inline

Member Function Documentation

◆ AddressOfRawData() [1/2]

◆ AddressOfRawData() [2/2]

◆ assign() [1/3]

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

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::assign ( assign_stream_type & Stream)
inlineprotectedvirtual

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

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::assign ( assign_stream_type & Stream)
inlineprotectedvirtual

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

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [2/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [3/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [4/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [5/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [6/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [7/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [8/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [9/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ Bytes() [10/10]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

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

◆ CheckSumDataClass() [1/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [3/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [4/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [5/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [6/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [7/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [8/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [9/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [10/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [3/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [4/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [5/10]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [6/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [7/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [8/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [9/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [10/10]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Create() [1/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [4/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [5/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [6/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [7/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [8/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [9/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [10/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [11/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [12/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [13/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [14/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [15/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [16/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [17/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [18/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [19/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [20/30]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

◆ Create() [21/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [22/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [23/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [24/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [25/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [26/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [27/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [28/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [29/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [30/30]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ 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]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprivatevirtual

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

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

◆ demote() [2/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprivatevirtual

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

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.

◆ FrameSpecDescription() [1/2]

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

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

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

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

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

◆ FrameSpecName() [2/2]

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

◆ 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]

Data quality flag.

Retrieve the data quality flag associated with the frame

Returns
The data quality flag for the frame

◆ GetDataQuality() [2/2]

Data quality flag.

Retrieve the data quality flag associated with the frame

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]

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetDt() [2/2]

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetFrame() [1/2]

Frame number.

Retrieve the frame number associated with the frame

Returns
The frame number of the frame

◆ GetFrame() [2/2]

Frame number.

Retrieve the frame number associated with the frame

Returns
The frame number of the frame

◆ GetGTime() [1/2]

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetGTime() [2/2]

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetName() [1/2]

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetName() [2/2]

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetRawData() [1/4]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [2/4]

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [3/4]

Retrieve the raw data reference.

Set the number of leap seconds since GPS epoc.

Returns
A pointer to the raw data structure.

◆ GetRawData() [4/4]

Retrieve the raw data reference.

Set the number of leap seconds since GPS epoc.

Returns
A pointer to the raw data structure.

◆ GetRun() [1/2]

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ GetRun() [2/2]

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ GetULeapS() [1/2]

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]

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() [1/2]

template<typename T>
virtual delta_t_normalized_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::normalizedDeltaT ( ) const
inlineprotectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ normalizedDeltaT() [2/2]

template<typename T>
virtual delta_t_normalized_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::normalizedDeltaT ( ) const
inlineprotectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [1/2]

template<typename T>
virtual start_time_normalized_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::normalizedStartTime ( ) const
inlineprotectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [2/2]

template<typename T>
virtual start_time_normalized_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::normalizedStartTime ( ) const
inlineprotectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ ObjectStructName() [1/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

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

◆ ObjectStructName() [2/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

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

◆ operator==() [1/3]

virtual bool FrameCPP::Common::FrameSpec::ObjectInterface::operator== ( const Object & Obj) const
pure virtualinherited

comparison operator

Implemented in anonymous_namespace{FrEvent.cc}::FrEvent, anonymous_namespace{FrSimEvent.cc}::FrSimEvent, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSH, FrameCPP::Version_9::FrSH, and FrVect.

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ pBytes() [1/2]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

◆ pBytes() [2/2]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

◆ pCreate() [1/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

◆ pCreate() [2/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

◆ Promote() [1/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprivatevirtual

Upgrade an object.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

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

◆ promote() [2/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprivatevirtual

Upgrade an object.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

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

◆ pWrite() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

◆ pWrite() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

◆ readSubset() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::readSubset ( istream_type & Stream,
INT_4U ElementMask )
inlineprotectedvirtual

Limitted reading of the object.

Parameters
[in]StreamThe input stream from which to read the object.
[in]ElementMaskMask of elements to read from the Stream

Implements FrameCPP::Common::FrameH.

◆ readSubset() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::readSubset ( istream_type & Stream,
INT_4U ElementMask )
inlineprotectedvirtual

Limitted reading of the object.

Parameters
[in]StreamThe input stream from which to read the object.
[in]ElementMaskMask of elements to read from the Stream

Implements FrameCPP::Common::FrameH.

◆ RefAuxData() [1/4]

◆ RefAuxData() [2/4]

◆ RefAuxData() [3/4]

◆ RefAuxData() [4/4]

◆ RefAuxTable() [1/4]

◆ RefAuxTable() [2/4]

◆ RefAuxTable() [3/4]

◆ RefAuxTable() [4/4]

◆ RefDetectProc() [1/4]

◆ RefDetectProc() [2/4]

◆ RefDetectProc() [3/4]

◆ RefDetectProc() [4/4]

◆ RefDetectSim() [1/4]

◆ RefDetectSim() [2/4]

◆ RefDetectSim() [3/4]

◆ RefDetectSim() [4/4]

◆ RefEvent() [1/4]

◆ RefEvent() [2/4]

◆ RefEvent() [3/4]

◆ RefEvent() [4/4]

◆ RefHistory() [1/4]

◆ RefHistory() [2/4]

◆ RefHistory() [3/4]

◆ RefHistory() [4/4]

◆ RefProcData() [1/4]

◆ RefProcData() [2/4]

◆ RefProcData() [3/4]

◆ RefProcData() [4/4]

◆ RefSimData() [1/4]

◆ RefSimData() [2/4]

◆ RefSimData() [3/4]

◆ RefSimData() [4/4]

◆ RefSimEvent() [1/4]

◆ RefSimEvent() [2/4]

◆ RefSimEvent() [3/4]

◆ RefSimEvent() [4/4]

◆ RefSummaryData() [1/4]

◆ RefSummaryData() [2/4]

◆ RefSummaryData() [3/4]

◆ RefSummaryData() [4/4]

◆ RefType() [1/4]

◆ RefType() [2/4]

◆ RefType() [3/4]

◆ RefType() [4/4]

◆ RefUser() [1/4]

◆ RefUser() [2/4]

◆ RefUser() [3/4]

◆ RefUser() [4/4]

◆ SetDataQuality() [1/2]

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]

Establish the data quality flag.

Set the data quality flag of the frame.

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

◆ SetDt() [1/2]

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetDt() [2/2]

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetGTime() [1/2]

Establish the start time.

Set the start time of the frame.

Parameters
[in]ValueThe start time of the frame.

◆ SetGTime() [2/2]

Establish the start time.

Set the start time of the frame.

Parameters
[in]ValueThe start time of the frame.

◆ SetName() [1/2]

Establish the name.

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

Parameters
[in]NameThe name to associate with the frame

◆ SetName() [2/2]

Establish the name.

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

Parameters
[in]NameThe name to associate with the frame

◆ SetRawData() [1/2]

◆ SetRawData() [2/2]

◆ SetRun() [1/2]

Establish the run number.

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

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

◆ SetRun() [2/2]

Establish the run number.

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

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

◆ SetULeapS() [1/2]

Establish leap second offset.

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

◆ SetULeapS() [2/2]

Establish leap second offset.

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

◆ StructDescription() [1/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

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

◆ StructName() [2/2]

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

◆ 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]

◆ VerifyObject() [2/2]

◆ vTOCQuery() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrameHImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [2/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [3/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [4/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [5/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [6/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [7/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [8/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [9/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [10/10]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ auxData

auxData_type FrameH::auxData
protectedinherited

◆ auxTable

auxTable_type FrameH::auxTable
protectedinherited

◆ dataQuality

dataQuality_type FrameH::dataQuality
protectedinherited

◆ detectProc

detectProc_type FrameH::detectProc
protectedinherited

◆ detectSim

detectSim_type FrameH::detectSim
protectedinherited

◆ dt

dt_type FrameH::dt
protectedinherited

◆ event

event_type FrameH::event
protectedinherited

◆ frame

frame_type FrameH::frame
protectedinherited

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

◆ GTime

GTime_type FrameH::GTime
protectedinherited

◆ history

history_type FrameH::history
mutableprotectedinherited

◆ m_chkSum [1/5]

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_chkSum [2/5]

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_chkSum [3/5]

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_chkSum [4/5]

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_chkSum [5/5]

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ 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_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.

◆ MAX_REF

static const INT_2U FrameH::MAX_REF
staticinherited

◆ name

name_type FrameH::name
protectedinherited

◆ procData

procData_type FrameH::procData
protectedinherited

◆ rawData

rawData_type FrameH::rawData
protectedinherited

◆ run

run_type FrameH::run
protectedinherited

◆ s_object_id

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

◆ simData

simData_type FrameH::simData
protectedinherited

◆ simEvent

simEvent_type FrameH::simEvent
protectedinherited

◆ struct_desc

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

◆ struct_id

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

◆ struct_name

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

◆ summaryData

summaryData_type FrameH::summaryData
protectedinherited

◆ type

type_type FrameH::type
protectedinherited

◆ ULeapS

ULeapS_type FrameH::ULeapS
protectedinherited

◆ user

user_type FrameH::user
protectedinherited

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