ldas-tools-framecpp
2.7.0
|
ADC Data Structure Definition. More...
#include <FrAdcData.hh>
Public Member Functions | |
FrAdcData () | |
Default constructor. More... | |
FrAdcData (const FrAdcData &Source) | |
FrAdcData (const std::string &name, crate_type crate, channel_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=FR_ADC_DATA_DEFAULT_BIAS, slope_type slope=FR_ADC_DATA_DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=FR_ADC_DATA_DEFAULT_FSHIFT, timeOffsetS_type timeOffsetS=FR_ADC_DATA_DEFAULT_TIME_OFFSET_S, timeOffsetN_type timeOffsetN=FR_ADC_DATA_DEFAULT_TIME_OFFSET_N, overRange_type overRange=FR_ADC_DATA_DEFAULT_OVER_RANGE) | |
~FrAdcData () | |
const std::string & | GetNameSlow () const |
Retrieve the name of the FrAdcData struture. More... | |
bool | operator== (const FrAdcData &RHS) const |
bool | operator!= (const FrAdcData &RHS) const |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
cmn_streamsize_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. More... | |
FrAdcData & | Merge (const FrAdcData &RHS) |
void | SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds) |
virtual FrAdcData * | Create (istream_type &Stream) const |
constructor - virtual More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
FrAdcData () | |
Default constructor. More... | |
FrAdcData (const FrAdcData &Source) | |
FrAdcData (const std::string &name, crate_type crate, channel_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=FR_ADC_DATA_DEFAULT_BIAS, slope_type slope=FR_ADC_DATA_DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=FR_ADC_DATA_DEFAULT_FSHIFT, timeOffsetS_type timeOffsetS=FR_ADC_DATA_DEFAULT_TIME_OFFSET_S, timeOffsetN_type timeOffsetN=FR_ADC_DATA_DEFAULT_TIME_OFFSET_N, overRange_type overRange=FR_ADC_DATA_DEFAULT_OVER_RANGE) | |
~FrAdcData () | |
const std::string & | GetNameSlow () const |
Retrieve the name of the FrAdcData struture. More... | |
bool | operator== (const FrAdcData &RHS) const |
bool | operator!= (const FrAdcData &RHS) const |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
cmn_streamsize_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. More... | |
FrAdcData & | Merge (const FrAdcData &RHS) |
void | SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds) |
virtual FrAdcData * | Create (istream_type &Stream) const |
constructor - virtual More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
void | AppendComment (const comment_type &Comment) |
Extend the comment associated with the FrAdcData structure. More... | |
void | AppendComment (const comment_type &Comment) |
Extend the comment associated with the FrAdcData structure. More... | |
const name_type & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const name_type & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const comment_type & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
const comment_type & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
channel_type | GetChannel () const |
The channel number for the FrAdcData. More... | |
channel_type | GetChannel () const |
The channel number for the FrAdcData. More... | |
crate_type | GetCrate () const |
The crate number for the FrAdcData. More... | |
crate_type | GetCrate () const |
The crate number for the FrAdcData. More... | |
nBits_type | GetNBits () const |
Tne number of bits in the A/D output. More... | |
nBits_type | GetNBits () const |
Tne number of bits in the A/D output. More... | |
bias_type | GetBias () const |
DC bias on channel. More... | |
bias_type | GetBias () const |
DC bias on channel. More... | |
slope_type | GetSlope () const |
ADC calibration units per count. More... | |
slope_type | GetSlope () const |
ADC calibration units per count. More... | |
STRING | GetUnits () const |
The units used in the ADC calibration. More... | |
STRING | GetUnits () const |
The units used in the ADC calibration. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
timeOffsetS_type | GetTimeOffsetS () const |
The offset of the first sample relative to the frame start time. More... | |
timeOffsetS_type | GetTimeOffsetS () const |
The offset of the first sample relative to the frame start time. More... | |
timeOffsetN_type | GetTimeOffsetN () const |
The offset of the first sample relative to the frame start time. More... | |
timeOffsetN_type | GetTimeOffsetN () const |
The offset of the first sample relative to the frame start time. More... | |
fShift_type | GetFShift () const |
The frequency in the original data corresponding to 0 Hz. More... | |
fShift_type | GetFShift () const |
The frequency in the original data corresponding to 0 Hz. More... | |
overRange_type | GetOverRange () const |
Retrieve the overRange value. More... | |
overRange_type | GetOverRange () const |
Retrieve the overRange value. More... | |
void | SetCrate (crate_type Value) |
Set the numeric crate id for the channel. More... | |
void | SetCrate (crate_type Value) |
Set the numeric crate id for the channel. More... | |
void | SetChannel (channel_type Value) |
Set the numeric id for the channel. More... | |
void | SetChannel (channel_type Value) |
Set the numeric id for the channel. More... | |
void | SetComment (const comment_type &comment) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetComment (const comment_type &comment) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetOverRange (overRange_type flag) |
Establish the value of the overRange field. More... | |
void | SetOverRange (overRange_type flag) |
Establish the value of the overRange field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetNBits (nBits_type NBits) |
The number of bits in the A/D output. More... | |
void | SetNBits (nBits_type NBits) |
The number of bits in the A/D output. More... | |
void | SetSampleRate (sampleRate_type SampleRate) |
Establish the value of the sampleRate field. More... | |
void | SetSampleRate (sampleRate_type SampleRate) |
Establish the value of the sampleRate field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetTimeOffset (timeOffsetS_type Seconds, timeOffsetN_type Nanoseconds) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetS (timeOffsetS_type time) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetS (timeOffsetS_type time) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetN (timeOffsetN_type time) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetN (timeOffsetN_type time) |
Establish the value of the timeOffset field. More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Create () const |
constructor - virtual More... | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
template<typename PreviousType , typename CurrentType > | |
FrameSpec::ObjectInterface::promote_ret_type | PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
Static Public Attributes | |
static const bias_type | DEFAULT_BIAS |
static const slope_type | DEFAULT_SLOPE |
static const fShift_type | DEFAULT_FSHIFT |
static const timeOffsetS_type | DEFAULT_TIME_OFFSET_S |
static const timeOffsetN_type | DEFAULT_TIME_OFFSET_N |
static const overRange_type | DEFAULT_OVER_RANGE |
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... | |
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 | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
Private Member Functions | |
FrAdcData (istream_type &Stream) | |
void | copy_core (const FrAdcData &Source) |
FrAdcData (istream_type &Stream) | |
void | copy_core (const FrAdcData &Source) |
ADC Data Structure Definition.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type |
typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type |
typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrAdcData::FrAdcData | ( | ) |
Default constructor.
FrameCPP::Version_3::FrAdcData::FrAdcData | ( | const FrAdcData & | Source | ) |
FrameCPP::Version_3::FrAdcData::FrAdcData | ( | const std::string & | name, |
crate_type | crate, | ||
channel_type | channel, | ||
nBits_type | nBits, | ||
sampleRate_type | sampleRate, | ||
bias_type | bias = FR_ADC_DATA_DEFAULT_BIAS , |
||
slope_type | slope = FR_ADC_DATA_DEFAULT_SLOPE , |
||
const std::string & | units = FR_ADC_DATA_DEFAULT_UNITS() , |
||
fShift_type | fShift = FR_ADC_DATA_DEFAULT_FSHIFT , |
||
timeOffsetS_type | timeOffsetS = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S , |
||
timeOffsetN_type | timeOffsetN = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N , |
||
overRange_type | overRange = FR_ADC_DATA_DEFAULT_OVER_RANGE |
||
) |
FrameCPP::Version_3::FrAdcData::~FrAdcData | ( | ) |
|
private |
FrameCPP::Version_3::FrAdcData::FrAdcData | ( | ) |
Default constructor.
FrameCPP::Version_3::FrAdcData::FrAdcData | ( | const FrAdcData & | Source | ) |
FrameCPP::Version_3::FrAdcData::FrAdcData | ( | const std::string & | name, |
crate_type | crate, | ||
channel_type | channel, | ||
nBits_type | nBits, | ||
sampleRate_type | sampleRate, | ||
bias_type | bias = FR_ADC_DATA_DEFAULT_BIAS , |
||
slope_type | slope = FR_ADC_DATA_DEFAULT_SLOPE , |
||
const std::string & | units = FR_ADC_DATA_DEFAULT_UNITS() , |
||
fShift_type | fShift = FR_ADC_DATA_DEFAULT_FSHIFT , |
||
timeOffsetS_type | timeOffsetS = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S , |
||
timeOffsetN_type | timeOffsetN = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N , |
||
overRange_type | overRange = FR_ADC_DATA_DEFAULT_OVER_RANGE |
||
) |
FrameCPP::Version_3::FrAdcData::~FrAdcData | ( | ) |
|
private |
|
inlineinherited |
Extend the comment associated with the FrAdcData structure.
|
inherited |
Extend the comment associated with the FrAdcData structure.
|
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. |
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.
|
private |
|
private |
|
virtual |
constructor - virtual
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
constructor - virtual
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, and FrameCPP::Version_4::FrTOC.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.
|
protectedvirtual |
Down grade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Down grade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
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 |
Retrieve the class identifier.
|
inherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inherited |
|
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 |
|
inherited |
const std::string& FrameCPP::Version_3::FrAdcData::GetNameSlow | ( | ) | const |
Retrieve the name of the FrAdcData struture.
const std::string& FrameCPP::Version_3::FrAdcData::GetNameSlow | ( | ) | const |
Retrieve the name of the FrAdcData struture.
|
inlineinherited |
Tne number of bits in the A/D output.
|
inherited |
Tne number of bits in the A/D output.
|
inlineinherited |
Retrieve the overRange value.
|
inherited |
Retrieve the overRange value.
|
inlineinherited |
The data acquisition rate.
|
inherited |
The data acquisition rate.
|
inherited |
ADC calibration units per count.
|
inlineinherited |
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.
|
inline |
bool FrameCPP::Version_3::FrAdcData::operator!= | ( | const FrAdcData & | RHS | ) | const |
|
inline |
bool FrameCPP::Version_3::FrAdcData::operator== | ( | const FrAdcData & | RHS | ) | const |
|
virtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprotectedinherited |
Comparison operator.
|
inlinestatic |
|
static |
|
protectedvirtual |
Upgrade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Upgrade an 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. |
|
inherited |
|
inlineinherited |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
|
inherited |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
|
inherited |
Set the numeric id for the channel.
|
inlineinherited |
Set the numeric id for the channel.
|
inlineinherited |
Set the comment associated with the FrAdcData structure.
|
inherited |
Set the comment associated with the FrAdcData structure.
|
inlineinherited |
Set the numeric crate id for the channel.
|
inherited |
Set the numeric crate id for the channel.
|
inherited |
The number of bits in the A/D output.
[in] | NBits | Tne number of bits in the A/D output. |
|
inlineinherited |
The number of bits in the A/D output.
[in] | NBits | Tne number of bits in the A/D output. |
|
inherited |
Establish the value of the overRange field.
[in] | flag | The desired value of the overRange field. |
|
inlineinherited |
Establish the value of the overRange field.
[in] | flag | The desired value of the overRange field. |
|
inherited |
Establish the value of the sampleRate field.
[in] | SampleRate | The desired value of the sampleRate field. |
|
inlineinherited |
Establish the value of the sampleRate field.
[in] | SampleRate | The desired value of the sampleRate field. |
|
inherited |
Establish the value of the slope field.
[in] | slope | The desired value of the slope field. |
|
inlineinherited |
Establish the value of the slope field.
[in] | slope | The desired value of the slope field. |
void FrameCPP::Version_3::FrAdcData::SetTimeOffset | ( | INT_4U | Seconds, |
INT_4U | Nanoseconds | ||
) |
void FrameCPP::Version_3::FrAdcData::SetTimeOffset | ( | INT_4U | Seconds, |
INT_4U | Nanoseconds | ||
) |
|
inlineinherited |
Establish the value of the timeOffset field.
|
inherited |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
inlineinherited |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
inlineinherited |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
inherited |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
static |
|
static |
|
static |
|
inlinestatic |
|
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_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
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_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
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.
|
protectedinherited |
Write contents to the stream.
|
protectedinherited |
Write contents to the stream.
|
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 number
|
protectedinherited |
Comment for the ADC.
|
protectedinherited |
Channel grouping number containing ADC.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
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 valid flag
|
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 <...>).