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

FrameH Data Structure Definition. More...

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_3::FrameH:
Collaboration diagram for FrameCPP::Version_3::FrameH:

Public Types

typedef Common::FrameH::assign_stream_type assign_stream_type
typedef Common::FrameH::assign_stream_type assign_stream_type
enum  copy_type {
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 ,
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080
}
enum  copy_type {
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 ,
  DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,
  AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080
}
typedef FrameSpec::version_type frame_spec_version_type
typedef FrameSpec::version_type frame_spec_version_type
typedef boost::shared_ptr< Objectobject_type
typedef boost::shared_ptr< Objectobject_type
typedef std::unique_ptr< Objectunique_object_type
typedef std::unique_ptr< Objectunique_object_type
typedef object_type demote_arg_type
typedef object_type demote_arg_type
typedef object_type demote_ret_type
typedef object_type demote_ret_type
typedef stream_base_type demote_stream_type
typedef stream_base_type demote_stream_type
typedef object_type promote_arg_type
typedef object_type promote_arg_type
typedef object_type promote_ret_type
typedef object_type promote_ret_type
typedef stream_base_type promote_stream_type
typedef stream_base_type promote_stream_type
typedef FRAME_H_NAME_TYPE name_type
typedef FRAME_H_NAME_TYPE name_type
typedef FRAME_H_RUN_TYPE run_type
typedef FRAME_H_RUN_TYPE run_type
typedef FRAME_H_FRAME_TYPE frame_type
typedef FRAME_H_FRAME_TYPE frame_type
typedef FRAME_H_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 Common::SearchContainer< FrVect, &FrVect::GetName > type_type
typedef type_type::iterator type_iterator
typedef type_type::const_iterator const_type_iterator
typedef type_type::hash_iterator type_hash_iterator
typedef type_type::const_hash_iterator const_type_hash_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName > user_type
typedef user_type::iterator user_iterator
typedef user_type::const_iterator const_user_iterator
typedef user_type::hash_iterator user_hash_iterator
typedef user_type::const_hash_iterator const_user_hash_iterator
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectSim_type
typedef detectSim_type::iterator detectSim_iterator
typedef detectSim_type::const_iterator const_detectSim_iterator
typedef detectSim_type::hash_iterator detectSim_hash_iterator
typedef detectSim_type::const_hash_iterator const_detectSim_hash_iterator
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > detectProc_type
typedef detectProc_type::iterator detectProc_iterator
typedef detectProc_type::const_iterator const_detectProc_iterator
typedef detectProc_type::hash_iterator detectProc_hash_iterator
typedef detectProc_type::const_hash_iterator const_detectProc_hash_iterator
typedef Common::SearchContainer< FrTrigData, &FrTrigData::GetNameSlowtrigData_type
typedef trigData_type::iterator trigData_iterator
typedef trigData_type::const_iterator const_trigData_iterator
typedef trigData_type::hash_iterator trigData_hash_iterator
typedef trigData_type::const_hash_iterator const_trigData_hash_iterator
typedef Common::SearchContainer< FrHistory, &FrHistory::GetName > history_type
typedef history_type::iterator history_iterator
typedef history_type::const_iterator const_history_iterator
typedef history_type::hash_iterator history_hash_iterator
typedef history_type::const_hash_iterator const_history_hash_iterator
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > procData_type
typedef procData_type::iterator procData_iterator
typedef procData_type::const_iterator const_procData_iterator
typedef procData_type::hash_iterator procData_hash_iterator
typedef procData_type::const_hash_iterator const_procData_hash_iterator
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > strain_type
typedef strain_type::iterator strain_iterator
typedef strain_type::const_iterator const_strain_iterator
typedef strain_type::hash_iterator strain_hash_iterator
typedef strain_type::const_hash_iterator const_strain_hash_iterator
typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow > simData_type
typedef simData_type::iterator simData_iterator
typedef simData_type::const_iterator const_simData_iterator
typedef simData_type::hash_iterator simData_hash_iterator
typedef simData_type::const_hash_iterator const_simData_hash_iterator
typedef Common::SearchContainer< FrSummary, &FrSummary::GetName > summaryData_type
typedef summaryData_type::iterator summaryData_iterator
typedef summaryData_type::const_iterator const_summaryData_iterator
typedef summaryData_type::hash_iterator summaryData_hash_iterator
typedef summaryData_type::const_hash_iterator const_summaryData_hash_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName > auxData_type
typedef auxData_type::iterator auxData_iterator
typedef auxData_type::const_iterator const_auxData_iterator
typedef auxData_type::hash_iterator auxData_hash_iterator
typedef auxData_type::const_hash_iterator const_auxData_hash_iterator

Public Member Functions

 FrameH ()
 Default constructor.
 FrameH (const FrameH &frame)
 FrameH (const std::string &name, run_type run, frame_type frame, const GTime_type &time, ULeapS_type uLeapS, localTime_type LocalTime, const dt_type dt)
 FrameH (const FrameHNPS &Source)
 ~FrameH ()
streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual FrameHClone () const
 Virtual constructor.
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream.
bool operator== (const FrameH &RHS) const
 comparison operator
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 FrameH ()
 Default constructor.
 FrameH (const FrameH &frame)
 FrameH (const std::string &name, run_type run, frame_type frame, const GTime_type &time, ULeapS_type uLeapS, localTime_type LocalTime, const dt_type dt)
 FrameH (const FrameHNPS &Source)
 ~FrameH ()
streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual FrameHClone () const
 Virtual constructor.
virtual FrameHCreate (istream_type &Stream) const
 constructor - virtual
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream.
bool operator== (const FrameH &RHS) const
 comparison operator
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
virtual void assign (assign_stream_type &Stream)=0
 Assign the contents of the instance.
class_type GetClass () const
 Retrieve the class identifier.
class_type GetClass () const
 Retrieve the class identifier.
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
virtual const DescriptionGetDescription (ostream_type &Stream) const
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
virtual const DescriptionGetDescription (ostream_type &Stream) const
frame_spec_version_type FrameSpecVersion () const
frame_spec_version_type FrameSpecVersion () const
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
virtual ObjectCreate () const
 constructor - virtual
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
const std::string & GetName () const
const std::string & GetName () const
run_type GetRun () const
run_type GetRun () const
frame_type GetFrame () const
frame_type GetFrame () const
const GTime_typeGetGTime () const
const GTime_typeGetGTime () const
ULeapS_type GetULeapS () const
ULeapS_type GetULeapS () const
dt_type GetDt () const
dt_type GetDt () const
localTime_type GetLocalTime () const
localTime_type GetLocalTime () const
void SetRun (run_type Run)
void SetRun (run_type Run)
void SetDt (dt_type Dt)
void SetDt (dt_type Dt)
void SetGTime (const GTime_type &Value)
void SetGTime (const GTime_type &Value)
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
void SetULeapS (ULeapS_type Value)
 Establish leap second offset.
rawData_type GetRawData () const
rawData_type GetRawData ()
rawData_type GetRawData () const
rawData_type GetRawData ()
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 procData_typeRefStrain () const
procData_typeRefStrain ()
const procData_typeRefStrain () const
procData_typeRefStrain ()
const simData_typeRefSimData () const
simData_typeRefSimData ()
const simData_typeRefSimData () const
simData_typeRefSimData ()
const trigData_typeRefTrigData () const
trigData_typeRefTrigData ()
const trigData_typeRefTrigData () const
trigData_typeRefTrigData ()
const summaryData_typeRefSummaryData () const
summaryData_typeRefSummaryData ()
const summaryData_typeRefSummaryData () const
summaryData_typeRefSummaryData ()
const auxData_typeRefAuxData () const
auxData_typeRefAuxData ()
const auxData_typeRefAuxData () const
auxData_typeRefAuxData ()
void SetRawData (rawData_type r)
void SetRawData (rawData_type r)
rawData_typeAddressOfRawData () const
rawData_typeAddressOfRawData () const

Static Public Member Functions

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

Static Public Attributes

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

Protected Member Functions

virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid.
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object as being valid.
virtual void readSubset (istream_type &Stream, INT_4U ElementMask)
virtual start_time_normalized_type normalizedStartTime () const
 Frame start time in seconds.
virtual delta_t_normalized_type normalizedDeltaT () const
 Duration of the frame.
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
virtual class_type getClass () const
 Retrieve the class identifier.
virtual class_type getClass () const
 Retrieve the class identifier.
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const =0
 Demotes object to previous version of the frame spec.
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const =0
 Promotes object to another version of the frame spec.
void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
streamsize_type bytes () const
 Number of bytes required by this object.
streamsize_type bytes () const
 Number of bytes required by this object.
bool compare_nps (const FrameHNPS &RHS) const
bool compare_nps (const FrameHNPS &RHS) const
void read (istream_type &Stream)
void read (istream_type &Stream)
void write (ostream_type &Stream) const
void write (ostream_type &Stream) const

Static Protected Member Functions

static void dataDescription (Common::Description &Desc)
 Dictionary description of data.
static void dataDescription (Common::Description &Desc)
 Dictionary description of data.
static void refDescription (Common::Description &Desc)
static void refDescription (Common::Description &Desc)

Protected Attributes

name_type name
 Name of project or other experiment description.
run_type run
 Run number.
frame_type frame
 Frame number.
GTime_type GTime
 Frame start time.
ULeapS_type ULeapS
 The number of leap seconds.
localTime_type localTime
 Local seasonal time.
dt_type dt
 Frame length in seconds.
ref_type m_refs

Private Member Functions

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

Private Attributes

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

Detailed Description

FrameH Data Structure Definition.

Member Typedef Documentation

◆ assign_stream_type [1/2]

typedef Common::FrameH::assign_stream_type FrameCPP::Version_3::FrameH::assign_stream_type

◆ assign_stream_type [2/2]

typedef Common::FrameH::assign_stream_type FrameCPP::Version_3::FrameH::assign_stream_type

◆ auxData_hash_iterator

◆ auxData_iterator

◆ auxData_type

◆ const_auxData_hash_iterator

◆ const_auxData_iterator

◆ const_detectProc_hash_iterator

◆ const_detectProc_iterator

◆ const_detectSim_hash_iterator

◆ const_detectSim_iterator

◆ const_history_hash_iterator

◆ const_history_iterator

◆ const_procData_hash_iterator

◆ const_procData_iterator

◆ const_simData_hash_iterator

◆ const_simData_iterator

◆ const_strain_hash_iterator

◆ const_strain_iterator

◆ const_summaryData_hash_iterator

◆ const_summaryData_iterator

◆ const_trigData_hash_iterator

◆ const_trigData_iterator

◆ const_type_hash_iterator

◆ const_type_iterator

◆ const_user_hash_iterator

◆ const_user_iterator

◆ 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

◆ detectProc_iterator

◆ detectProc_type

◆ detectSim_hash_iterator

◆ detectSim_iterator

◆ detectSim_type

◆ dt_type [1/2]

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

◆ history_iterator

◆ history_type

◆ localTime_type [1/2]

◆ localTime_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ object_type [1/2]

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

◆ object_type [2/2]

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

◆ procData_hash_iterator

◆ procData_iterator

◆ procData_type

◆ 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

typedef boost::shared_ptr< FrRawData > FrameCPP::Version_3::FrameHPST< FrDetector, FrTrigData, FrHistory, FrProcData, FrRawData, FrSimData, FrSummary, FrVect >::rawData_type
inherited

◆ run_type [1/2]

◆ run_type [2/2]

◆ simData_hash_iterator

◆ simData_iterator

◆ simData_type

◆ strain_hash_iterator

◆ strain_iterator

◆ strain_type

◆ summaryData_hash_iterator

◆ summaryData_iterator

◆ summaryData_type

◆ trigData_hash_iterator

◆ trigData_iterator

◆ trigData_type

◆ type_hash_iterator

◆ type_iterator

◆ type_type

◆ ULeapS_type [1/2]

◆ ULeapS_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

◆ user_hash_iterator

◆ user_iterator

◆ user_type

Member Enumeration Documentation

◆ copy_type [1/2]

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

◆ copy_type [2/2]

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

Constructor & Destructor Documentation

◆ FrameH() [1/10]

FrameH::FrameH ( )

Default constructor.

Allocate resources using default values.

◆ FrameH() [2/10]

FrameH::FrameH ( const FrameH & frame)

◆ FrameH() [3/10]

FrameH::FrameH ( const std::string & name,
run_type run,
frame_type frame,
const GTime_type & time,
ULeapS_type uLeapS,
localTime_type LocalTime,
const dt_type dt )

◆ FrameH() [4/10]

FrameH::FrameH ( const FrameHNPS & Source)

◆ ~FrameH() [1/2]

FrameH::~FrameH ( )
virtual

Reimplemented from FrameCPP::Common::FrameH.

◆ FrameH() [5/10]

FrameH::FrameH ( istream_type & Stream)
private

◆ FrameH() [6/10]

FrameCPP::Version_3::FrameH::FrameH ( )

Default constructor.

◆ FrameH() [7/10]

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

◆ FrameH() [8/10]

FrameCPP::Version_3::FrameH::FrameH ( const std::string & name,
run_type run,
frame_type frame,
const GTime_type & time,
ULeapS_type uLeapS,
localTime_type LocalTime,
const dt_type dt )

◆ FrameH() [9/10]

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

◆ ~FrameH() [2/2]

FrameCPP::Version_3::FrameH::~FrameH ( )
virtual

Reimplemented from FrameCPP::Common::FrameH.

◆ FrameH() [10/10]

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

Member Function Documentation

◆ AddressOfRawData() [1/2]

◆ AddressOfRawData() [2/2]

◆ assign() [1/4]

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

Assign the contents of the instance.

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

◆ assign() [2/4]

void FrameH::assign ( assign_stream_type & Stream)
protectedvirtual

Assign the contents of the instance.

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

◆ assign() [3/4]

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

Assign the contents of the instance.

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

◆ assign() [4/4]

void FrameHNPS::assign ( assign_stream_type & Stream)
protectedinherited

Assign the contents of the instance.

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

◆ Bytes() [1/2]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [2/2]

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

Number of bytes needed to write this structure.

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

◆ bytes() [1/2]

streamsize_type FrameHNPS::bytes ( ) const
inlineprotectedinherited

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ bytes() [2/2]

streamsize_type FrameCPP::Version_3::FrameHNPS::bytes ( ) const
protectedinherited

Number of bytes required by this object.

Returns
The number of bytes need to read or write this object to a stream.

◆ Clone() [1/2]

FrameH * FrameH::Clone ( ) const
virtual

Virtual constructor.

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

◆ Clone() [2/2]

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

Virtual constructor.

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

◆ compare_nps() [1/2]

bool FrameHNPS::compare_nps ( const FrameHNPS & RHS) const
inlineprotectedinherited

◆ compare_nps() [2/2]

bool FrameCPP::Version_3::FrameHNPS::compare_nps ( const FrameHNPS & RHS) const
protectedinherited

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

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

constructor - virtual

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

◆ Create() [4/4]

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

constructor - virtual

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

◆ dataDescription() [1/2]

void FrameHNPS::dataDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ dataDescription() [2/2]

void FrameCPP::Version_3::FrameHNPS::dataDescription ( Common::Description & Desc)
staticprotectedinherited

Dictionary description of data.

Parameters
[out]DescThe handle to a dictionary description to which this type of object is to be added.

◆ demote() [1/3]

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedpure virtualinherited

Demotes object to previous version of the frame spec.

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.

Implemented in anonymous_namespace{FrEvent.cc}::FrEvent, anonymous_namespace{FrEvent.cc}::FrEvent, anonymous_namespace{FrSimEvent.cc}::FrSimEvent, 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_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< 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_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::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::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::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::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrVect, and FrVect.

◆ demote() [2/3]

FrameH::demote_ret_type FrameH::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
privatevirtual

Down grade an object.

◆ demote() [3/3]

virtual demote_ret_type FrameCPP::Version_3::FrameH::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
privatevirtual

Down grade an object.

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

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

Down grade an object.

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

◆ FrameSpecVersion() [1/2]

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

◆ FrameSpecVersion() [2/2]

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

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetDescription() [1/4]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [2/4]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [3/4]

◆ GetDescription() [4/4]

◆ GetDt() [1/2]

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

◆ GetDt() [2/2]

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

◆ GetFrame() [1/2]

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

◆ GetFrame() [2/2]

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

◆ GetGTime() [1/2]

const FrameHNPS::GTime_type & FrameHNPS::GetGTime ( ) const
inlineinherited

◆ GetGTime() [2/2]

const GTime_type & FrameCPP::Version_3::FrameHNPS::GetGTime ( ) const
inherited

◆ GetLocalTime() [1/2]

FrameHNPS::localTime_type FrameHNPS::GetLocalTime ( ) const
inlineinherited

◆ GetLocalTime() [2/2]

localTime_type FrameCPP::Version_3::FrameHNPS::GetLocalTime ( ) const
inherited

◆ GetName() [1/2]

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

◆ GetName() [2/2]

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

◆ GetRawData() [1/4]

◆ GetRawData() [2/4]

◆ GetRawData() [3/4]

◆ GetRawData() [4/4]

◆ GetRun() [1/2]

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

◆ GetRun() [2/2]

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

◆ GetULeapS() [1/2]

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

◆ GetULeapS() [2/2]

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

◆ normalizedDeltaT() [1/2]

delta_t_normalized_type FrameH::normalizedDeltaT ( ) const
inlineprotectedvirtual

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedDeltaT() [2/2]

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

Duration of the frame.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [1/2]

start_time_normalized_type FrameH::normalizedStartTime ( ) const
inlineprotectedvirtual

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ normalizedStartTime() [2/2]

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

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

◆ ObjectStructName() [1/2]

const char * FrameH::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/4]

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

comparison operator

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

◆ operator==() [2/4]

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

comparison operator

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

◆ operator==() [3/4]

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

comparison operator

◆ operator==() [4/4]

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

comparison operator

◆ Promote() [1/2]

FrameH::promote_ret_type FrameH::Promote ( frame_spec_version_type Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

◆ Promote() [2/2]

promote_ret_type FrameCPP::Version_3::FrameH::Promote ( frame_spec_version_type Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

◆ promote() [1/3]

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedpure virtualinherited

Promotes object to another version of the frame spec.

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 promoted to the next generation.

Implemented in anonymous_namespace{FrEvent.cc}::FrEvent, anonymous_namespace{FrEvent.cc}::FrEvent, anonymous_namespace{FrSimEvent.cc}::FrSimEvent, 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_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< 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_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::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::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::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::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrVect, and FrVect.

◆ promote() [2/3]

FrameH::promote_ret_type FrameH::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
privatevirtual

Upgrade an object.

◆ promote() [3/3]

virtual promote_ret_type FrameCPP::Version_3::FrameH::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
privatevirtual

Upgrade an object.

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

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

◆ read() [1/2]

void FrameHNPS::read ( istream_type & Stream)
inlineprotectedinherited

◆ read() [2/2]

void FrameCPP::Version_3::FrameHNPS::read ( istream_type & Stream)
protectedinherited

◆ readSubset() [1/2]

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

◆ readSubset() [2/2]

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

◆ RefAuxData() [1/4]

◆ RefAuxData() [2/4]

◆ RefAuxData() [3/4]

◆ RefAuxData() [4/4]

◆ refDescription() [1/2]

void FrameCPP::Version_3::FrameHPST< FrDetector, FrTrigData, FrHistory, FrProcData, FrRawData, FrSimData, FrSummary, FrVect >::refDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

◆ refDescription() [2/2]

void FrameCPP::Version_3::FrameHPST< FrDetector, FrTrigData, FrHistory, FrProcData, FrRawData, FrSimData, FrSummary, FrVect >::refDescription ( Common::Description & Desc)
inlinestaticprotectedinherited

◆ RefDetectProc() [1/4]

◆ RefDetectProc() [2/4]

◆ RefDetectProc() [3/4]

◆ RefDetectProc() [4/4]

◆ RefDetectSim() [1/4]

◆ RefDetectSim() [2/4]

◆ RefDetectSim() [3/4]

◆ RefDetectSim() [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]

◆ RefStrain() [1/4]

◆ RefStrain() [2/4]

◆ RefStrain() [3/4]

◆ RefStrain() [4/4]

◆ RefSummaryData() [1/4]

◆ RefSummaryData() [2/4]

◆ RefSummaryData() [3/4]

◆ RefSummaryData() [4/4]

◆ RefTrigData() [1/4]

◆ RefTrigData() [2/4]

◆ RefTrigData() [3/4]

◆ RefTrigData() [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]

◆ SetDt() [1/2]

void FrameHNPS::SetDt ( dt_type Dt)
inlineinherited

◆ SetDt() [2/2]

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

◆ SetGTime() [1/2]

void FrameHNPS::SetGTime ( const GTime_type & Value)
inlineinherited

◆ SetGTime() [2/2]

void FrameCPP::Version_3::FrameHNPS::SetGTime ( const GTime_type & Value)
inherited

◆ SetRawData() [1/2]

◆ SetRawData() [2/2]

◆ SetRun() [1/2]

void FrameHNPS::SetRun ( run_type Run)
inlineinherited

◆ SetRun() [2/2]

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

◆ SetULeapS() [1/2]

void FrameHNPS::SetULeapS ( ULeapS_type Value)
inlineinherited

Establish leap second offset.

Set the number of leap seconds since GPS epoc.

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

◆ SetULeapS() [2/2]

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

Establish leap second offset.

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

◆ StructDescription() [1/2]

const Description * FrameH::StructDescription ( )
static

◆ StructDescription() [2/2]

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

◆ StructName() [1/2]

const char * FrameH::StructName ( )
inlinestatic

◆ StructName() [2/2]

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

◆ VerifyObject() [1/2]

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

Verify the object as being valid.

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

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

◆ VerifyObject() [2/2]

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

Verify the object as being valid.

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

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

◆ Write() [1/2]

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

Write the structure to the stream.

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

◆ Write() [2/2]

virtual void FrameCPP::Version_3::FrameH::Write ( ostream_type & Stream) const
virtual

Write the structure to the stream.

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

◆ write() [1/2]

void FrameHNPS::write ( ostream_type & Stream) const
inlineprotectedinherited

◆ write() [2/2]

void FrameCPP::Version_3::FrameHNPS::write ( ostream_type & Stream) const
protectedinherited

◆ 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

◆ dt

dt_type FrameHNPS::dt
protectedinherited

Frame length in seconds.

◆ frame

frame_type FrameHNPS::frame
protectedinherited

Frame number.

This value is monotonically increasing until the end of the run.

◆ 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 FrameHNPS::GTime
protectedinherited

Frame start time.

The GPS time since GPS standard epoch.

◆ localTime

localTime_type FrameHNPS::localTime
protectedinherited

Local seasonal time.

UTC in seconds [integer multiple of 1800 seconds].

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

◆ m_refs

◆ MAX_REF

◆ name

name_type FrameHNPS::name
protectedinherited

Name of project or other experiment description.

Name of project or other experiment description. (e.g., GEO; LIGO; VIRGO; TAMA; ...)

◆ run

run_type FrameHNPS::run
protectedinherited

Run number.

◆ s_object_id

◆ ULeapS

ULeapS_type FrameHNPS::ULeapS
protectedinherited

The number of leap seconds.

The integer number of leap seconds between GPS\/TAI and UTC in the epoch when the frame is written: ULeapS = Int[TAI - UTC].


The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version3/FrameH.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrameH.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrameH.cc