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

Event data. More...

#include <FrAdcData.hh>

Public Member Functions

 FrAdcData ()
 Default constructor.
 
 FrAdcData (const name_type &Name, channelGroup_type ChannelGroup, channelNumber_type ChannelNumber, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias=Data::DEFAULT_BIAS, slope_type Slope=Data::DEFAULT_SLOPE, const units_type &Units=Data::DEFAULT_UNITS(), fShift_type FShift=Data::DEFAULT_FSHIFT, timeOffset_type TimeOffset=Data::DEFAULT_TIME_OFFSET, dataValid_type DataValid=Data::DEFAULT_DATA_VALID, phase_type Phase=Data::DEFAULT_PHASE)
 Constructor.
 
 FrAdcData (Previous::FrAdcData &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const name_type & GetNameSlow () const
 Retrieve the name of the FrAdcData struture.
 
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.
 
bool operator== (const FrAdcData &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
 FrAdcData ()
 Default constructor.
 
 FrAdcData (const name_type &Name, channelGroup_type ChannelGroup, channelNumber_type ChannelNumber, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias=Data::DEFAULT_BIAS, slope_type Slope=Data::DEFAULT_SLOPE, const units_type &Units=Data::DEFAULT_UNITS(), fShift_type FShift=Data::DEFAULT_FSHIFT, timeOffset_type TimeOffset=Data::DEFAULT_TIME_OFFSET, dataValid_type DataValid=Data::DEFAULT_DATA_VALID, phase_type Phase=Data::DEFAULT_PHASE)
 Constructor.
 
 FrAdcData (Previous::FrAdcData &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const name_type & GetNameSlow () const
 Retrieve the name of the FrAdcData struture.
 
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.
 
bool operator== (const FrAdcData &RHS) const
 equality 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.
 
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 streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void 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
 Return the name associate with the FrAdcData structure.
 
const comment_type & GetComment () const
 A brief description of the FrAdcData structure.
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData.
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData.
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output.
 
bias_type GetBias () const
 DC bias on channel.
 
slope_type GetSlope () const
 ADC calibration units per count.
 
const units_type & GetUnits () const
 The units used in the ADC calibration.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time.
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz.
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset.
 
dataValid_type GetDataValid () const
 Retrieve the overRange value.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const data_typeRefData () const
 Identifier for vector of sampled data.
 
data_typeRefData ()
 Identifier for vector of sampled data.
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure.
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field.
 
void SetBias (bias_type bias)
 Establish the value of the bias field.
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field.
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field.
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
 
void SetSlope (slope_type slope)
 Establish the value of the slope field.
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field.
 

Static Public Member Functions

static const Common::Description * StructDescription ()
 The description of structure.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static 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 char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static 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 demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
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 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.
 

Protected Attributes

name_type name
 Channel name – must be unique with the frame.
 
comment_type comment
 Comment.
 
channelGroup_type channelGroup
 Channel grouping number containing ADC.
 
channelNumber_type channelNumber
 Channel nubmer.
 
nBits_type nBits
 Number of bits in A/D output.
 
bias_type bias { DEFAULT_BIAS }
 DC bias on channel (Units @ ADC counts = 0)
 
slope_type slope { DEFAULT_SLOPE }
 ADC calibration: input units/ct.
 
units_type units { DEFAULT_UNITS( ) }
 ADC calibration: input units for slope.
 
sampleRate_type sampleRate
 Data acquisition rate, samples/s.
 
timeOffset_type timeOffset { DEFAULT_TIME_OFFSET }
 Offset of 1st sample relative to the frame start time.
 
fShift_type fShift { DEFAULT_FSHIFT }
 
phase_type phase { DEFAULT_PHASE }
 
dataValid_type dataValid { DEFAULT_DATA_VALID }
 Data valid flag.
 
data_type data
 Identifier for vector of sampled data.
 
aux_type aux
 

Detailed Description

Event data.

Constructor & Destructor Documentation

◆ FrAdcData() [1/4]

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

Constructor.

Parameters
[in]NameThe Channel name – must be unique within the frame
[in]ChannelGroupChannel grouping number containing ADC.
[in]ChannelNumberChannel 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() [2/4]

FrameCPP::Version_8::FrAdcData::FrAdcData ( Previous::FrAdcData & Source,
stream_base_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() [3/4]

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

Constructor.

Parameters
[in]NameThe Channel name – must be unique within the frame
[in]ChannelGroupChannel grouping number containing ADC.
[in]ChannelNumberChannel 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/4]

FrameCPP::Version_8::FrAdcData::FrAdcData ( Previous::FrAdcData & Source,
stream_base_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.

Member Function Documentation

◆ Bytes() [1/12]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

◆ demote() [1/2]

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

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]

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

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.

◆ GetBias()

Data::bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias ( ) const
inlineinherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup()

Data::channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup ( ) const
inlineinherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber()

Data::channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber ( ) const
inlineinherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment()

const Data::comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment ( ) const
inlineinherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid()

Data::dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid ( ) const
inlineinherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetFShift()

Data::fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetFShift ( ) const
inlineinherited

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetName()

const Data::name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName ( ) const
inlineinherited

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNBits()

Data::nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits ( ) const
inlineinherited

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetPhase()

Data::phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetPhase ( ) const
inlineinherited

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetSampleRate()

Data::sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate ( ) const
inlineinherited

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope()

Data::slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope ( ) const
inlineinherited

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffset()

Data::timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetTimeOffset ( ) const
inlineinherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetUnits()

const Data::units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits ( ) const
inlineinherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ 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

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

template<typename T>
virtual const char * FrameCPP::Version_8::FrAdcDataImpl::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::FrAdcDataImpl::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/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==() [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]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrAdcDataImpl::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::FrAdcDataImpl::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::FrAdcDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ pCreate() [2/2]

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

Virtual constructor.

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

◆ Promote() [1/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrAdcDataImpl::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 FrAdcData based on Obj

◆ Promote() [2/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrAdcDataImpl::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 FrAdcData based on Obj

◆ promote() [1/2]

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

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]

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

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]

template<typename T>
virtual void FrameCPP::Version_8::FrAdcDataImpl::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::FrAdcDataImpl::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.

◆ RefAux() [1/2]

Data::aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( )
inlineinherited

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [2/2]

const Data::aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( ) const
inlineinherited

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefData() [1/2]

Data::data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( )
inlineinherited

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [2/2]

const Data::data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( ) const
inlineinherited

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ SetBias()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias ( bias_type bias)
inlineinherited

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetChannelGroup()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type Value)
inlineinherited

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelNumber()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type Value)
inlineinherited

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetComment()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetComment ( const comment_type & Value)
inlineinherited

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetDataValid()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid ( dataValid_type flag)
inlineinherited

Establish the value of the dataValid field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetNBits()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetNBits ( nBits_type Value)
inlineinherited

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ SetSampleRate()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type Value)
inlineinherited

Establish the value of the sampleRate field.

Parameters
[in]ValueThe desired value of the sampleRate field.

◆ SetSlope()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope ( slope_type slope)
inlineinherited

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetTimeOffset()

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type Value)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ StructDescription() [1/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrAdcDataImpl::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::FrAdcDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ Subset() [1/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.

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

◆ vTOCQuery() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrAdcDataImpl::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::FrAdcDataImpl::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.

Member Data Documentation

◆ aux

aux_type FrameCPP::Version_8::FrAdcDataImpl::Data::aux
protectedinherited

Identifier for vector for user-provided information; use is generic

◆ fShift

fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::fShift { DEFAULT_FSHIFT }
protectedinherited

fShift is the frequency (in Hz) in the original data that corresponds to 0 Hz in the heterodyned series.

◆ phase

phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::phase { DEFAULT_PHASE }
protectedinherited

Phase (in radian) of hetrodyning signal at start of dataset


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