ldas-tools-framecpp 2.7.0
|
ADC Data. More...
#include <FrAdcData.hh>
Inherits FrAdcDataNPS, FrAdcDataPS, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrAdcDataNPS, FrAdcDataPS, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.
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. | |
FrAdcData & | Merge (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. | |
FrAdcData & | Merge (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_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (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. | |
Static Public Member Functions | |
static const char * | StructName () |
The name structure name of this object. | |
static const Common::Description * | StructDescription () |
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::Description * | StructDescription () |
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. | |
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 FrAdcData * | pCreate (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 FrAdcData * | pCreate (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 void | pWrite (ostream_type &Stream) const=0 |
Write the structure to the stream. | |
ADC Data.
FrameCPP::Version_8::FrAdcData::FrAdcData | ( | ) |
Default constructor.
FrameCPP::Version_8::FrAdcData::FrAdcData | ( | const FrAdcData & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
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.
[in] | Name | The Channel name – must be unique within the frame |
[in] | Group | Channel grouping number containing ADC. |
[in] | Channel | Channel number. |
[in] | NBits | Number of bits in A/D output. |
[in] | Bias | DC bias on channel (Units ADC counts = 0) |
[in] | Slope | ADC calibration: input units/count. |
[in] | Units | ADC calibration: input units for slope. |
[in] | SampleRate | Data acquistion rate, samples/s. |
[in] | FShift | The frequency (in Hz) in the origional data that oorresponds to 0 Hz in the heterodyned series. |
[in] | TimeOffset | Offset of the first sample relative to the frame start time (seconds). Must be positive and smaller than the frame length. |
[in] | DataValid | Data valid flag. |
[in] | Phase | Phase of heterodyning signal at start of dataset. |
FrameCPP::Version_8::FrAdcData::FrAdcData | ( | Previous::FrAdcData & | Source, |
istream_type * | Stream ) |
FrameCPP::Version_8::FrAdcData::FrAdcData | ( | ) |
Default constructor.
FrameCPP::Version_8::FrAdcData::FrAdcData | ( | const FrAdcData & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
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.
[in] | Name | The Channel name – must be unique within the frame |
[in] | Group | Channel grouping number containing ADC. |
[in] | Channel | Channel number. |
[in] | NBits | Number of bits in A/D output. |
[in] | Bias | DC bias on channel (Units ADC counts = 0) |
[in] | Slope | ADC calibration: input units/count. |
[in] | Units | ADC calibration: input units for slope. |
[in] | SampleRate | Data acquistion rate, samples/s. |
[in] | FShift | The frequency (in Hz) in the origional data that oorresponds to 0 Hz in the heterodyned series. |
[in] | TimeOffset | Offset of the first sample relative to the frame start time (seconds). Must be positive and smaller than the frame length. |
[in] | DataValid | Data valid flag. |
[in] | Phase | Phase of heterodyning signal at start of dataset. |
FrameCPP::Version_8::FrAdcData::FrAdcData | ( | Previous::FrAdcData & | Source, |
istream_type * | Stream ) |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
protectedvirtual |
Down grade an object.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Down grade an object.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
inline |
inequality operator
[in] | RHS | The FrAdcData object to be compared. |
bool FrameCPP::Version_8::FrAdcData::operator!= | ( | const FrAdcData & | RHS | ) | const |
inequality operator
[in] | RHS | The FrAdcData object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
bool FrameCPP::Version_8::FrAdcData::operator== | ( | const FrAdcData & | RHS | ) | const |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
inlinestatic |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
static |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
protectedvirtual |
Upgrade an object.
[in] | Target | The version of the frame specification to promote too. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Upgrade an object.
[in] | Target | The version of the frame specification to promote too. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedpure virtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrVect.
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
FrAdcData::subset_ret_type FrameCPP::Version_8::FrAdcData::Subset | ( | REAL_8 | Offset, |
REAL_8 | Dt ) const |
Request a subset of the data.
[in] | Offset | The number of seconds from the start of the FrAdcData object from which to start extracting data. |
[in] | Dt | The number of seconds of data in the resulting FrAdcData strucutre. |
subset_ret_type FrameCPP::Version_8::FrAdcData::Subset | ( | REAL_8 | Offset, |
REAL_8 | Dt ) const |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |