ldas-tools-framecpp 3.0.4
|
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. | |
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. | |
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. | |
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. | |
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 const Common::Description * | GetDescription (ostream_type &Stream) const |
The data structure description. | |
virtual const Common::Description * | GetDescription (ostream_type &Stream) const |
The data structure description. | |
virtual const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
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. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
frame_spec_version_type | FrameSpecVersion () const |
frame_spec_version_type | FrameSpecVersion () const |
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 * | Clone () const |
constructor - virtual copy constructor | |
virtual Object * | Clone () const |
constructor - virtual copy constructor | |
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, promote_stream_type *Stream) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
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_type & | RefAux () const |
Identifier for vector for user-provided information. | |
aux_type & | RefAux () |
Identifier for vector for user-provided information. | |
const data_type & | RefData () const |
Identifier for vector of sampled data. | |
data_type & | RefData () |
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. | |
bool | operator== (Data const &RHS) const |
bool | operator== (FrAdcData const &RHS) const |
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. | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
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 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. | |
static const units_type & | DEFAULT_UNITS () |
Static Public Attributes | |
static constexpr slope_type | DEFAULT_SLOPE { 1.0 } |
static constexpr bias_type | DEFAULT_BIAS { 0 } |
static constexpr fShift_type | DEFAULT_FSHIFT { 0 } |
static constexpr timeOffset_type | DEFAULT_TIME_OFFSET { 0 } |
static constexpr dataValid_type | DEFAULT_DATA_VALID { 0 } |
static constexpr phase_type | DEFAULT_PHASE { 0 } |
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_type * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | pCreate (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. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
void | incrementTimeOffset (timeOffset_type Value) |
void | setName (const name_type &Value) |
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 |
Static Protected Attributes | |
static constexpr unsigned int | MAX_REF { 2 } |
Private Types | |
typedef STRING | io_name_type |
typedef STRING | io_comment_type |
typedef STRING | io_units_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
Private Attributes | |
checksum_type | m_chkSum |
Structure checksum. | |
const class_type | m_class |
Storage for the class identifier. | |
const Description *const | m_desc |
Description for parent class. | |
const frame_spec_version_type | frame_spec_version |
Version of the frame specification. | |
Event data.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef boost::shared_ptr< FrAdcData > FrameCPP::Version_9::FrAdcData::subset_ret_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_9::FrAdcData::FrAdcData | ( | ) |
Default constructor.
FrameCPP::Version_9::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.
[in] | Name | The Channel name – must be unique within the frame |
[in] | ChannelGroup | Channel grouping number containing ADC. |
[in] | ChannelNumber | 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_9::FrAdcData::FrAdcData | ( | Previous::FrAdcData & | Source, |
stream_base_type * | Stream ) |
FrameCPP::Version_9::FrAdcData::FrAdcData | ( | ) |
Default constructor.
FrameCPP::Version_9::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.
[in] | Name | The Channel name – must be unique within the frame |
[in] | ChannelGroup | Channel grouping number containing ADC. |
[in] | ChannelNumber | 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_9::FrAdcData::FrAdcData | ( | Previous::FrAdcData & | Source, |
stream_base_type * | Stream ) |
|
inlineinherited |
Extend the comment associated with the FrAdcData structure.
|
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.
|
inlineprivatevirtualinherited |
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprivatevirtualinherited |
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprivatevirtualinherited |
constructor - virtual
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprivatevirtualinherited |
constructor - virtual
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inlinestaticinherited |
|
inlineprotectedvirtualinherited |
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprotectedvirtualinherited |
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. |
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 |
|
inherited |
|
inlineinherited |
DC bias on channel.
|
inlineinherited |
|
inlineinherited |
|
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 |
|
inlineinherited |
Retrieve the overRange value.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
The data structure description.
Reimplemented from FrameCPP::Common::FrameSpec::Object.
|
inlinevirtualinherited |
The data structure description.
Reimplemented from FrameCPP::Common::FrameSpec::Object.
|
inlineinherited |
The frequency in the original data corresponding to 0 Hz.
|
inlineinherited |
const name_type & FrameCPP::Version_9::FrAdcData::GetNameSlow | ( | ) | const |
Retrieve the name of the FrAdcData struture.
const name_type & FrameCPP::Version_9::FrAdcData::GetNameSlow | ( | ) | const |
Retrieve the name of the FrAdcData struture.
|
inlineinherited |
Tne number of bits in the A/D output.
|
inlineinherited |
Phase of hetrodyning signal at start of dataset.
|
inlineinherited |
The data acquisition rate.
|
inlineinherited |
ADC calibration units per count.
|
inlineinherited |
The offset of the first sample relative to the frame start time.
|
inlineinherited |
The units used in the ADC calibration.
|
inlineprotectedinherited |
|
inlinevirtualinherited |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineinherited |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
bool FrameCPP::Version_9::FrAdcData::operator== | ( | const FrAdcData & | RHS | ) | const |
equality operator
[in] | RHS | The FrAdcData object to be compared. |
|
inlineinherited |
|
inlineprotectedvirtualinherited |
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< Common::FrameSpec::Object, checksum_type >.
|
inlineprotectedvirtualinherited |
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< Common::FrameSpec::Object, checksum_type >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlineprotectedvirtualinherited |
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineprotectedvirtualinherited |
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. |
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 |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlineinherited |
Identifier for vector for user-provided information.
|
inlineinherited |
Identifier for vector for user-provided information.
|
inlineinherited |
Identifier for vector of sampled data.
|
inlineinherited |
Identifier for vector of sampled data.
|
inlineinherited |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
|
inlineinherited |
Establish the value of the channelGroup field.
[in] | Value | The desired value of the channelGroup field. |
|
inlineinherited |
Establish the value of the channelNumber field.
[in] | Value | The desired value of the channelNumber field. |
|
inlineinherited |
Set the comment associated with the FrAdcData structure.
[in] | Value | The desired value for the comment field. |
|
inlineinherited |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
|
inlineprotectedinherited |
|
inlineinherited |
Tne number of bits in the A/D output.
|
inlineinherited |
Establish the value of the sampleRate field.
[in] | Value | The desired value of the sampleRate field. |
|
inlineinherited |
Establish the value of the slope field.
[in] | slope | The desired value of the slope field. |
|
inlineinherited |
Establish the value of the timeOffset field.
[in] | Value | The value for the timeOffset field. |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
subset_ret_type FrameCPP::Version_9::FrAdcData::Subset | ( | REAL_8 | Offset, |
REAL_8 | Dt ) const |
subset_ret_type FrameCPP::Version_9::FrAdcData::Subset | ( | REAL_8 | Offset, |
REAL_8 | Dt ) const |
|
inlineinherited |
|
inherited |
|
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_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.
|
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_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
protectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Write object to the stream.
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 |
Identifier for vector for user-provided information; use is generic
|
protectedinherited |
DC bias on channel (Units @ ADC counts = 0)
|
protectedinherited |
Channel grouping number containing ADC.
|
protectedinherited |
Channel nubmer.
|
protectedinherited |
Comment.
|
protectedinherited |
Identifier for vector of sampled data.
|
protectedinherited |
Data valid flag.
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
staticconstexprinherited |
|
privateinherited |
Version of the frame specification.
The version of the frame specification for which this object was created.
|
protectedinherited |
fShift is the frequency (in Hz) in the original data that corresponds to 0 Hz in the heterodyned series.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
privateinherited |
Storage for the class identifier.
The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.
|
privateinherited |
Description for parent class.
The description for the parent class composed of one FrSH and one or more FrSE elements.
|
staticconstexprprotectedinherited |
|
protectedinherited |
Channel name – must be unique with the frame.
|
protectedinherited |
Number of bits in A/D output.
|
protectedinherited |
Phase (in radian) of hetrodyning signal at start of dataset
|
protectedinherited |
Data acquisition rate, samples/s.
|
protectedinherited |
ADC calibration: input units/ct.
|
protectedinherited |
Offset of 1st sample relative to the frame start time.
|
protectedinherited |
ADC calibration: input units for slope.