ldas-tools-framecpp 3.0.4
|
ADC Data Structure Definition. More...
#include <FrAdcData.hh>
Public Member Functions | |
FrAdcData () | |
Default constructor. | |
FrAdcData (const FrAdcData &Source) | |
Copy constructor. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
cmn_streamsize_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
FrAdcData & | Merge (const FrAdcData &RHS) |
virtual FrAdcData * | Create (istream_type &Stream) const |
constructor - virtual | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
FrAdcData () | |
Default constructor. | |
FrAdcData (const FrAdcData &Source) | |
Copy constructor. | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
cmn_streamsize_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
virtual FrAdcData * | Create (istream_type &Stream) const |
constructor - virtual | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
const std::string & | GetComment () const |
A brief description of the FrAdcData structure. | |
const std::string & | GetComment () const |
A brief description of the FrAdcData structure. | |
channelGroup_type | GetChannelGroup () const |
The channel group for the FrAdcData. | |
channelGroup_type | GetChannelGroup () const |
The channel group for the FrAdcData. | |
channelNumber_type | GetChannelNumber () const |
The channel number 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. | |
nBits_type | GetNBits () const |
Tne number of bits in the A/D output. | |
bias_type | GetBias () const |
DC bias on channel. | |
bias_type | GetBias () const |
DC bias on channel. | |
slope_type | GetSlope () const |
ADC calibration units per count. | |
slope_type | GetSlope () const |
ADC calibration units per count. | |
STRING | GetUnits () const |
The units used in the ADC calibration. | |
STRING | GetUnits () const |
The units used in the ADC calibration. | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. | |
timeOffsetS_type | GetTimeOffsetS () const |
The offset of the first sample relative to the frame start time. | |
timeOffsetS_type | GetTimeOffsetS () const |
The offset of the first sample relative to the frame start time. | |
timeOffsetN_type | GetTimeOffsetN () const |
The offset of the first sample relative to the frame start time. | |
timeOffsetN_type | GetTimeOffsetN () 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. | |
fShift_type | GetFShift () const |
The frequency in the original data corresponding to 0 Hz. | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. | |
void | SetDataValid (INT_2U flag) |
Establish the value of the dataValid field. | |
void | SetDataValid (INT_2U flag) |
Establish the value of the dataValid field. | |
void | SetBias (REAL_4 Value) |
Establish the value of the bias field. | |
void | SetBias (REAL_4 Value) |
Establish the value of the bias field. | |
void | SetSlope (REAL_4 Value) |
Establish the value of the slope field. | |
void | SetSlope (REAL_4 Value) |
Establish the value of the slope field. | |
void | SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds) |
Establish the value of the timeOffset field. | |
void | SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds) |
Establish the value of the timeOffset field. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
virtual const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
virtual const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
virtual Object * | Create () const |
constructor - virtual | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Clone () const |
constructor - virtual copy constructor | |
virtual Object * | Clone () const |
constructor - virtual copy constructor | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
Static Public Member Functions | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream) |
Down grade an object. | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream) |
Down grade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream) |
Upgrade an object. | |
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 promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Upgrade 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. | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
Protected Attributes | |
name_type | name |
comment_type | comment |
channelGroup_type | channelGroup |
channelNumber_type | channelNumber |
nBits_type | nBits |
bias_type | bias |
slope_type | slope |
units_type | units |
sampleRate_type | sampleRate |
timeOffsetS_type | timeOffsetS |
timeOffsetN_type | timeOffsetN |
fShift_type | fShift |
dataValid_type | dataValid |
ADC Data Structure Definition.
|
virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
protectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inlineinherited |
DC bias on channel.
|
inherited |
DC bias on channel.
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
inlineinherited |
Retrieve the class identifier.
|
inherited |
Retrieve the class identifier.
|
inlineinherited |
|
inherited |
|
inlineinherited |
Retrieve the overRange value.
|
inherited |
Retrieve the overRange value.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineinherited |
The frequency in the original data corresponding to 0 Hz.
|
inherited |
The frequency in the original data corresponding to 0 Hz.
|
inlineinherited |
Tne number of bits in the A/D output.
|
inherited |
Tne number of bits in the A/D output.
|
inlineinherited |
The data acquisition rate.
|
inherited |
The data acquisition rate.
|
inlineinherited |
ADC calibration units per count.
|
inherited |
ADC calibration units per count.
|
inlineinherited |
The offset of the first sample relative to the frame start time.
|
inherited |
The offset of the first sample relative to the frame start time.
|
inlineinherited |
The offset of the first sample relative to the frame start time.
|
inherited |
The offset of the first sample relative to the frame start time.
|
inlineinherited |
The units used in the ADC calibration.
|
inherited |
The units used in the ADC calibration.
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
inlineinherited |
Establish the value of the bias field.
[in] | Value | The desired value of the bias field. |
|
inherited |
Establish the value of the bias field.
[in] | Value | The desired value of the bias field. |
|
inlineinherited |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
|
inherited |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
|
inlineinherited |
Establish the value of the slope field.
[in] | Value | The desired value of the slope field. |
|
inherited |
Establish the value of the slope field.
[in] | Value | The desired value of the slope field. |
|
inlineinherited |
Establish the value of the timeOffset field.
[in] | Seconds | The value for the timeOffsetS field. |
[in] | Nanoseconds | The value for the timeOffsetN field. |
|
inherited |
Establish the value of the timeOffset field.
[in] | Seconds | The value for the timeOffsetS field. |
[in] | Nanoseconds | The value for the timeOffsetN field. |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.
|
virtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
protectedinherited |
DC bias on channel (Units @ ADC counts = 0)
|
protectedinherited |
Channel grouping number containing ADC.
|
protectedinherited |
Channel number
|
protectedinherited |
Comment for the ADC.
|
protectedinherited |
Data valid flag
|
protectedinherited |
The frequency (in HZ) in the original data that corresponds to zero Hz in the heterodyned series.
|
protectedinherited |
Channel name – must be unique with the frame
|
protectedinherited |
Number of bits in A/D output.
|
protectedinherited |
Data acquisition rate, samples per second.
|
protectedinherited |
ADC calibration: input units/count.
|
protectedinherited |
For Triggered data lasting less than one frame, integer residual nanoseconds start time relative to frame start
|
protectedinherited |
For Triggered data lasting less than one frame, integer seconds start time relative to frame start
|
protectedinherited |
ADC calibration: input units for slope If dimensionless, then units == <NONE>, in CAPITALS (without <...>).