ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrAdcData Class Reference

ADC Data. More...

#include <FrAdcData.hh>

Inheritance diagram for FrameCPP::Version_8::FrAdcData:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrAdcData:
Collaboration graph
[legend]

Public Types

typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef boost::shared_ptr< FrAdcDatasubset_ret_type
 
typedef FrAdcDataPS references_type
 
typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef boost::shared_ptr< FrAdcDatasubset_ret_type
 
typedef FrAdcDataPS references_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrAdcData ()
 Default constructor.
 
 FrAdcData (const FrAdcData &Source)
 Copy Constructor.
 
 FrAdcData (const name_type &Name, channelGroup_type Group, channelNumber_type Channel, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias=DEFAULT_BIAS, slope_type Slope=DEFAULT_SLOPE, const units_type &Units=DEFAULT_UNITS(), fShift_type FShift=DEFAULT_FSHIFT, timeOffset_type TimeOffset=DEFAULT_TIME_OFFSET, dataValid_type DataValid=DEFAULT_DATA_VALID, phase_type Phase=DEFAULT_PHASE)
 Constructor.
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 Promotion Constructor.
 
 ~FrAdcData ()
 Destructor.
 
const std::string & GetNameSlow () const
 Retrieve the name of the FrAdcData struture.
 
bool operator== (const FrAdcData &RHS) const
 equality operator
 
bool operator!= (const FrAdcData &RHS) const
 inequality operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
FrAdcDataMerge (const FrAdcData &RHS)
 Merge with another FrAdcData.
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data.
 
 FrAdcData ()
 Default constructor.
 
 FrAdcData (const FrAdcData &Source)
 Copy Constructor.
 
 FrAdcData (const name_type &Name, channelGroup_type Group, channelNumber_type Channel, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias=DEFAULT_BIAS, slope_type Slope=DEFAULT_SLOPE, const units_type &Units=DEFAULT_UNITS(), fShift_type FShift=DEFAULT_FSHIFT, timeOffset_type TimeOffset=DEFAULT_TIME_OFFSET, dataValid_type DataValid=DEFAULT_DATA_VALID, phase_type Phase=DEFAULT_PHASE)
 Constructor.
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 Promotion Constructor.
 
 ~FrAdcData ()
 Destructor.
 
const std::string & GetNameSlow () const
 Retrieve the name of the FrAdcData struture.
 
bool operator== (const FrAdcData &RHS) const
 equality operator
 
bool operator!= (const FrAdcData &RHS) const
 inequality operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
FrAdcDataMerge (const FrAdcData &RHS)
 Merge with another FrAdcData.
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data.
 
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.
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version.
 
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.
 
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)
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrAdcDatapCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrAdcDatapCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

 FrAdcData (istream_type &Stream)
 Stream Constructor.
 
void copy_core (const FrAdcData &Source)
 
 FrAdcData (istream_type &Stream)
 Stream Constructor.
 
void copy_core (const FrAdcData &Source)
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

ADC Data.

Member Typedef Documentation

◆ istream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ nps_type [1/2]

typedef FrAdcDataNPS FrameCPP::Version_8::FrAdcData::nps_type

◆ nps_type [2/2]

typedef FrAdcDataNPS FrameCPP::Version_8::FrAdcData::nps_type

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrAdcData::object_type
private

Object with checksum data.

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrAdcData::object_type
private

Object with checksum data.

◆ ostream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ps_type [1/2]

typedef FrAdcDataPS FrameCPP::Version_8::FrAdcData::ps_type

◆ ps_type [2/2]

typedef FrAdcDataPS FrameCPP::Version_8::FrAdcData::ps_type

◆ references_type [1/2]

typedef FrAdcDataPS FrameCPP::Version_8::FrAdcData::references_type

◆ references_type [2/2]

typedef FrAdcDataPS FrameCPP::Version_8::FrAdcData::references_type

◆ self_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ 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

◆ subset_ret_type [1/2]

typedef boost::shared_ptr< FrAdcData > FrameCPP::Version_8::FrAdcData::subset_ret_type

◆ subset_ret_type [2/2]

typedef boost::shared_ptr< FrAdcData > FrameCPP::Version_8::FrAdcData::subset_ret_type

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 

Constructor & Destructor Documentation

◆ FrAdcData() [1/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrAdcData() [2/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( const FrAdcData & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrAdcData() [3/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( const name_type & Name,
channelGroup_type Group,
channelNumber_type Channel,
nBits_type NBits,
sampleRate_type SampleRate,
bias_type Bias = DEFAULT_BIAS,
slope_type Slope = DEFAULT_SLOPE,
const units_type & Units = DEFAULT_UNITS( ),
fShift_type FShift = DEFAULT_FSHIFT,
timeOffset_type TimeOffset = DEFAULT_TIME_OFFSET,
dataValid_type DataValid = DEFAULT_DATA_VALID,
phase_type Phase = DEFAULT_PHASE )

Constructor.

Parameters
[in]NameThe Channel name – must be unique within the frame
[in]GroupChannel grouping number containing ADC.
[in]ChannelChannel number.
[in]NBitsNumber of bits in A/D output.
[in]BiasDC bias on channel (Units ADC counts = 0)
[in]SlopeADC calibration: input units/count.
[in]UnitsADC calibration: input units for slope.
[in]SampleRateData acquistion rate, samples/s.
[in]FShiftThe frequency (in Hz) in the origional data that oorresponds to 0 Hz in the heterodyned series.
[in]TimeOffsetOffset of the first sample relative to the frame start time (seconds). Must be positive and smaller than the frame length.
[in]DataValidData valid flag.
[in]PhasePhase of heterodyning signal at start of dataset.
Returns
A new instance of the object.

◆ FrAdcData() [4/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( Previous::FrAdcData & Source,
istream_type * Stream )

Promotion Constructor.

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

◆ ~FrAdcData() [1/2]

FrameCPP::Version_8::FrAdcData::~FrAdcData ( )

Destructor.

◆ FrAdcData() [5/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( istream_type & Stream)
private

Stream Constructor.

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

◆ FrAdcData() [6/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrAdcData() [7/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( const FrAdcData & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrAdcData() [8/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( const name_type & Name,
channelGroup_type Group,
channelNumber_type Channel,
nBits_type NBits,
sampleRate_type SampleRate,
bias_type Bias = DEFAULT_BIAS,
slope_type Slope = DEFAULT_SLOPE,
const units_type & Units = DEFAULT_UNITS(),
fShift_type FShift = DEFAULT_FSHIFT,
timeOffset_type TimeOffset = DEFAULT_TIME_OFFSET,
dataValid_type DataValid = DEFAULT_DATA_VALID,
phase_type Phase = DEFAULT_PHASE )

Constructor.

Parameters
[in]NameThe Channel name – must be unique within the frame
[in]GroupChannel grouping number containing ADC.
[in]ChannelChannel number.
[in]NBitsNumber of bits in A/D output.
[in]BiasDC bias on channel (Units ADC counts = 0)
[in]SlopeADC calibration: input units/count.
[in]UnitsADC calibration: input units for slope.
[in]SampleRateData acquistion rate, samples/s.
[in]FShiftThe frequency (in Hz) in the origional data that oorresponds to 0 Hz in the heterodyned series.
[in]TimeOffsetOffset of the first sample relative to the frame start time (seconds). Must be positive and smaller than the frame length.
[in]DataValidData valid flag.
[in]PhasePhase of heterodyning signal at start of dataset.
Returns
A new instance of the object.

◆ FrAdcData() [9/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( Previous::FrAdcData & Source,
istream_type * Stream )

Promotion Constructor.

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

◆ ~FrAdcData() [2/2]

FrameCPP::Version_8::FrAdcData::~FrAdcData ( )

Destructor.

◆ FrAdcData() [10/10]

FrameCPP::Version_8::FrAdcData::FrAdcData ( istream_type & Stream)
private

Stream Constructor.

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

Member Function Documentation

◆ Bytes() [1/2]

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

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

◆ CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ copy_core() [1/2]

void FrameCPP::Version_8::FrAdcData::copy_core ( const FrAdcData & Source)
inlineprivate

◆ copy_core() [2/2]

void FrameCPP::Version_8::FrAdcData::copy_core ( const FrAdcData & Source)
private

◆ Create() [1/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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() [4/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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() [5/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

FrAdcData::demote_ret_type FrameCPP::Version_8::FrAdcData::demote ( INT_2U Target,
demote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

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.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrAdcData::demote ( INT_2U Target,
demote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

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.

◆ GetNameSlow() [1/2]

const std::string & FrameCPP::Version_8::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ GetNameSlow() [2/2]

const std::string & FrameCPP::Version_8::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ Merge() [1/2]

FrAdcData & FrameCPP::Version_8::FrAdcData::Merge ( const FrAdcData & RHS)

Merge with another FrAdcData.

Parameters
[in]RHSThe source of the information to append to this FrAdcData structure.
Returns
A reference to this object
Todo
Need to implement Merge routine

◆ Merge() [2/2]

FrAdcData & FrameCPP::Version_8::FrAdcData::Merge ( const FrAdcData & RHS)

Merge with another FrAdcData.

Parameters
[in]RHSThe source of the information to append to this FrAdcData structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrAdcData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrAdcData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ operator!=() [1/2]

bool FrameCPP::Version_8::FrAdcData::operator!= ( const FrAdcData & RHS) const
inline

inequality operator

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

◆ operator!=() [2/2]

bool FrameCPP::Version_8::FrAdcData::operator!= ( const FrAdcData & RHS) const

inequality operator

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

◆ operator==() [1/4]

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

equality operator for abstract data type

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

◆ operator==() [2/4]

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

equality operator for abstract data type

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

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrAdcData::operator== ( const FrAdcData & RHS) const
inline

equality operator

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

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrAdcData::operator== ( const FrAdcData & RHS) const

equality operator

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

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrAdcData::pBytes ( const Common::StreamBase & Stream) const
protectedvirtual

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< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrAdcData::pBytes ( const Common::StreamBase & Stream) const
protectedvirtual

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< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

FrAdcData * FrameCPP::Version_8::FrAdcData::pCreate ( istream_type & Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
The newly allocated object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/2]

virtual FrAdcData * FrameCPP::Version_8::FrAdcData::pCreate ( istream_type & Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
The newly allocated object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ Promote() [1/2]

FrAdcData::promote_ret_type FrameCPP::Version_8::FrAdcData::Promote ( INT_2U Source,
promote_arg_type Obj,
istream_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]

static promote_ret_type FrameCPP::Version_8::FrAdcData::Promote ( INT_2U Source,
promote_arg_type Obj,
istream_type * Stream )
static

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]

FrAdcData::promote_ret_type FrameCPP::Version_8::FrAdcData::promote ( INT_2U Target,
promote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrAdcData::promote ( INT_2U Target,
promote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

Upgrade an object.

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

◆ pWrite() [1/2]

void FrameCPP::Version_8::FrAdcData::pWrite ( ostream_type & Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrAdcData::pWrite ( ostream_type & Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_8::FrAdcData::StructDescription ( )
static

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrAdcData::StructDescription ( )
static

The description of structure.

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

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrAdcData::StructName ( )
inlinestatic

The name structure name of this object.

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

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrAdcData::StructName ( )
static

The name structure name of this object.

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

◆ Subset() [1/2]

FrAdcData::subset_ret_type FrameCPP::Version_8::FrAdcData::Subset ( REAL_8 Offset,
REAL_8 Dt ) const

Request a subset of the data.

Parameters
[in]OffsetThe number of seconds from the start of the FrAdcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrAdcData strucutre.
Returns
A FrAdcData structure which contains Dt seconds of data starting at Offset of this FrAdcData structure.
Todo
Ensure the dimension of the FrVect is 1
Todo
Ensure the requested range is valid
Todo
Get the slice of FrVect

◆ Subset() [2/2]

subset_ret_type FrameCPP::Version_8::FrAdcData::Subset ( REAL_8 Offset,
REAL_8 Dt ) const

Request a subset of the data.

Parameters
[in]OffsetThe number of seconds from the start of the FrAdcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrAdcData strucutre.
Returns
A FrAdcData structure which contains Dt seconds of data starting at Offset of this FrAdcData structure.

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_8::FrAdcData::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]

virtual void FrameCPP::Version_8::FrAdcData::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/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

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


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