ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrAdcData Class Referenceabstract

ADC Data. More...

#include <FrAdcData.hh>

Inherits FrAdcDataNPS, FrAdcDataPS, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.

Public Member Functions

 FrAdcData ()
 Default constructor. More...
 
 FrAdcData (const FrAdcData &Source)
 Copy Constructor. More...
 
 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. More...
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
 ~FrAdcData ()
 Destructor.
 
const std::string & GetNameSlow () const
 Retrieve the name of the FrAdcData struture.
 
bool operator== (const FrAdcData &RHS) const
 equality operator More...
 
bool operator!= (const FrAdcData &RHS) const
 inequality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
FrAdcDataMerge (const FrAdcData &RHS)
 Merge with another FrAdcData. More...
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data. More...
 
 FrAdcData ()
 Default constructor. More...
 
 FrAdcData (const FrAdcData &Source)
 Copy Constructor. More...
 
 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. More...
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
 ~FrAdcData ()
 Destructor.
 
const std::string & GetNameSlow () const
 Retrieve the name of the FrAdcData struture.
 
bool operator== (const FrAdcData &RHS) const
 equality operator More...
 
bool operator!= (const FrAdcData &RHS) const
 inequality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
FrAdcDataMerge (const FrAdcData &RHS)
 Merge with another FrAdcData. More...
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

ADC Data.

Constructor & Destructor Documentation

◆ FrAdcData() [1/8]

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

Default constructor.

Returns
A new instance of this object.

◆ FrAdcData() [2/8]

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

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

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

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

Default constructor.

Returns
A new instance of this object.

◆ FrAdcData() [6/8]

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

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

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.

Member Function Documentation

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

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

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

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

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

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

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

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.

◆ pWrite() [2/3]

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.

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type &  Stream) const
protectedpure virtualinherited

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

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

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

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