ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrameH Class Reference

Event data. More...

#include <FrameH.hh>

Public Member Functions

 FrameH ()
 Default constructor.
 
 FrameH (const name_type &name, run_type run, frame_type frame, const GTime_type &time, ULeapS_type uLeapS, const dt_type dt, dataQuality_type dqual=0)
 Explicate construction.
 
 FrameH (const FrameH &frame)
 Copy Constructor.
 
 FrameH (const Previous::FrameH &Source, stream_base_type *Stream)
 Upconvert constructor.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator
 
 FrameH ()
 Default constructor.
 
 FrameH (const name_type &name, run_type run, frame_type frame, const GTime_type &time, ULeapS_type uLeapS, const dt_type dt, dataQuality_type dqual=0)
 Explicate construction.
 
 FrameH (const FrameH &frame)
 Copy Constructor.
 
 FrameH (const Previous::FrameH &Source, stream_base_type *Stream)
 Upconvert constructor.
 
virtual FrameHClone () const
 Virtual constructor.
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const char * ObjectStructName () const
 The name structure name of 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 void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
const name_type & GetName () const
 Retrieve name of project.
 
run_type GetRun () const
 Run number.
 
frame_type GetFrame () const
 Frame number.
 
dataQuality_type GetDataQuality () const
 Data quality flag.
 
const GTime_type & GetGTime () const
 Start Time.
 
ULeapS_type GetULeapS () const
 Leap seconds.
 
dt_type GetDt () const
 Frame length.
 
void SetName (const name_type &Name)
 Establish the name.
 
void SetRun (run_type Run)
 Establish the run number.
 
void SetDataQuality (dataQuality_type DataQuality)
 Establish the data quality flag.
 
void SetDt (dt_type Dt)
 Establish the frame duration.
 
void SetGTime (const GTime_type &Value)
 Establish the start time.
 
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.
 

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 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::Description * StructDescription ()
 The description of structure.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
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 struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 

Protected Member Functions

virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance.
 
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 delta_t_normalized_type normalizedDeltaT () const
 Frame start time in seconds.
 
virtual start_time_normalized_type normalizedStartTime () const
 Duration of the frame.
 
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.
 
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 self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
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 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 vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 

Detailed Description

Event data.

Constructor & Destructor Documentation

◆ FrameH() [1/6]

FrameCPP::Version_8::FrameH::FrameH ( const name_type & name,
run_type run,
frame_type frame,
const GTime_type & time,
ULeapS_type uLeapS,
const dt_type dt,
dataQuality_type dqual = 0 )

Explicate construction.

Parameters
[in]nameName of project or other experiment description
[in]runRun number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]frameFrame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]timeFrame start time in GPS units.
[in]uLeapSThe integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written.
[in]dtFrame length in seconds
[in]dqualData quality flag
Returns
A new instance of this object.

◆ FrameH() [2/6]

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

Copy Constructor.

Parameters
[in]frameFrame to use as the base
Returns
A new instance of the object.

◆ FrameH() [3/6]

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

Upconvert constructor.

Parameters
[in]SourceAn instance of a similiar object from a previous version of the frame specification.
[in]StreamThe stream from which the origional object was read.
Returns
A new instance of the object.

◆ FrameH() [4/6]

FrameCPP::Version_8::FrameH::FrameH ( const name_type & name,
run_type run,
frame_type frame,
const GTime_type & time,
ULeapS_type uLeapS,
const dt_type dt,
dataQuality_type dqual = 0 )

Explicate construction.

Parameters
[in]nameName of project or other experiment description
[in]runRun number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]frameFrame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]timeFrame start time in GPS units.
[in]uLeapSThe integer number of leap seconds between GPS/TAI and UTC in the epoch when the frame is written.
[in]dtFrame length in seconds
[in]dqualData quality flag
Returns
A new instance of this object.

◆ FrameH() [5/6]

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

Copy Constructor.

Parameters
[in]frameFrame to use as the base
Returns
A new instance of the object.

◆ FrameH() [6/6]

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

Upconvert constructor.

Parameters
[in]SourceAn instance of a similiar object from a previous version of the frame specification.
[in]StreamThe stream from which the origional object was read.
Returns
A new instance of the object.

Member Function Documentation

◆ assign() [1/2]

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

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

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

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]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, 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

◆ Bytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, 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

◆ Create() [1/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

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

◆ Create() [2/2]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

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

◆ GetDataQuality()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
dataQuality_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetDataQuality ( ) const
inlineinherited

Data quality flag.

Retrieve the data quality flag associated with the frame

Returns
The data quality flag for the frame

◆ GetDt()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
dt_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetDt ( ) const
inlineinherited

Frame length.

Retrieve the duration of the frame in seconds.

Returns
Length of frame in seconds.

◆ GetFrame()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
frame_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetFrame ( ) const
inlineinherited

Frame number.

Retrieve the frame number associated with the frame

Returns
The frame number of the frame

◆ GetGTime()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
const GTime_type & FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetGTime ( ) const
inlineinherited

Start Time.

Retrieve the start time of the frame.

Returns
The start time of the frame

◆ GetName()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
const name_type & FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetName ( ) const
inlineinherited

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns
Name of project

◆ GetRawData() [1/2]

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
rawData_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetRawData ( )
inlineinherited

Retrieve the raw data reference.

Returns
A pointer to the raw data structure.

◆ GetRawData() [2/2]

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
rawData_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetRawData ( ) const
inlineinherited

Retrieve the raw data reference.

Set the number of leap seconds since GPS epoc.

Returns
A pointer to the raw data structure.

◆ GetRun()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
run_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetRun ( ) const
inlineinherited

Run number.

Retrieve the run number associated with the frame.

Returns
The run number of the frame

◆ GetULeapS()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
ULeapS_type FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::GetULeapS ( ) const
inlineinherited

Leap seconds.

Retrieve the number of leap seconds associated with the frame.

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

◆ ObjectStructName() [1/2]

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

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

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

The name structure name of this object.

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

◆ operator==() [1/2]

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

equality operator

Parameters
[in]RHSThe FrameH object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/2]

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

equality operator

Parameters
[in]RHSThe FrameH object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

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

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.

◆ pBytes() [2/2]

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

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.

◆ pCreate() [1/2]

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

Virtual constructor.

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

◆ pCreate() [2/2]

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

Virtual constructor.

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

◆ 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 )
inlinestaticinherited

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

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

◆ pWrite() [1/2]

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

Write the structure to the stream.

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

◆ pWrite() [2/2]

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

Write the structure to the stream.

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

◆ readSubset() [1/2]

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

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

◆ readSubset() [2/2]

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

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

◆ SetDataQuality()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetDataQuality ( dataQuality_type DataQuality)
inlineinherited

Establish the data quality flag.

Set the data quality flag of the frame.

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

◆ SetDt()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetDt ( dt_type Dt)
inlineinherited

Establish the frame duration.

Set the length of the frame in seconds.

Parameters
[in]DtThe length of the frame in seconds

◆ SetGTime()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetGTime ( const GTime_type & Value)
inlineinherited

Establish the start time.

Set the start time of the frame.

Parameters
[in]ValueThe start time of the frame.

◆ SetName()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetName ( const name_type & Name)
inlineinherited

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

◆ SetRun()

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetRun ( run_type Run)
inlineinherited

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

template<typename TYPE_T , typename USER_T , typename DETECT_SIM_T , typename DETECT_PROC_T , typename HISTORY_T , typename RAW_DATA_T , typename PROC_DATA_T , typename SIM_DATA_T , typename EVENT_T , typename SIM_EVENT_T , typename SUMMARY_DATA_T , typename AUX_DATA_T , typename AUX_TABLE_T >
void FrameCPP::v5::FrameH< TYPE_T, USER_T, DETECT_SIM_T, DETECT_PROC_T, HISTORY_T, RAW_DATA_T, PROC_DATA_T, SIM_DATA_T, EVENT_T, SIM_EVENT_T, SUMMARY_DATA_T, AUX_DATA_T, AUX_TABLE_T >::SetULeapS ( ULeapS_type Value)
inlineinherited

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

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

The description of structure.

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

◆ vTOCQuery() [1/2]

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

Answer requests for information as needed by TOC.

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

◆ vTOCQuery() [2/2]

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

Answer requests for information as needed by TOC.

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

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