ldas-tools-framecpp 2.8.1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_3::FrAdcData Class Reference

ADC Data Structure Definition. More...

#include <FrAdcData.hh>

Inheritance diagram for FrameCPP::Version_3::FrAdcData:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_3::FrAdcData:
Collaboration graph
[legend]

Public Types

typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef STRING name_type
 
typedef STRING name_type
 
typedef STRING name_type
 
typedef STRING comment_type
 
typedef STRING comment_type
 
typedef STRING comment_type
 
typedef FR_ADC_DATA_CRATE_TYPE crate_type
 
typedef FR_ADC_DATA_CRATE_TYPE crate_type
 
typedef FR_ADC_DATA_CRATE_TYPE crate_type
 
typedef FR_ADC_DATA_CHANNEL_TYPE channel_type
 
typedef FR_ADC_DATA_CHANNEL_TYPE channel_type
 
typedef FR_ADC_DATA_CHANNEL_TYPE channel_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef STRING units_type
 
typedef STRING units_type
 
typedef STRING units_type
 
typedef FR_ADC_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIMEOFFSETS_TYPE timeOffsetS_type
 
typedef FR_ADC_DATA_TIMEOFFSETS_TYPE timeOffsetS_type
 
typedef FR_ADC_DATA_TIMEOFFSETS_TYPE timeOffsetS_type
 
typedef FR_ADC_DATA_TIMEOFFSETN_TYPE timeOffsetN_type
 
typedef FR_ADC_DATA_TIMEOFFSETN_TYPE timeOffsetN_type
 
typedef FR_ADC_DATA_TIMEOFFSETN_TYPE timeOffsetN_type
 
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_OVERRANGE_TYPE overRange_type
 
typedef FR_ADC_DATA_OVERRANGE_TYPE overRange_type
 
typedef FR_ADC_DATA_OVERRANGE_TYPE overRange_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 

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...
 
FrAdcDataMerge (const FrAdcData &RHS)
 
void SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
 
virtual FrAdcDataCreate (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...
 
FrAdcDataMerge (const FrAdcData &RHS)
 
void SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
 
virtual FrAdcDataCreate (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...
 
FrAdcDataMerge (const FrAdcData &RHS)
 
void SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
 
virtual FrAdcDataCreate (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...
 
void AppendComment (const comment_type &Comment)
 Extend the comment associated with the FrAdcData structure. More...
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure. More...
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure. More...
 
const comment_typeGetComment () 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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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...
 
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 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 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 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 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 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 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 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 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 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...
 
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...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual ObjectClone () 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...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 

Static Public Member Functions

static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade 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...
 
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...
 
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...
 
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...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

name_type name
 
comment_type comment
 
crate_type crate
 
channel_type channel
 
nBits_type nBits
 
bias_type bias
 
slope_type slope
 
units_type units
 
sampleRate_type sampleRate
 
timeOffsetS_type timeOffsetS
 
timeOffsetN_type timeOffsetN
 
fShift_type fShift
 
overRange_type overRange
 

Private Member Functions

 FrAdcData (istream_type &Stream)
 
void copy_core (const FrAdcData &Source)
 
 FrAdcData (istream_type &Stream)
 
void copy_core (const FrAdcData &Source)
 
 FrAdcData (istream_type &Stream)
 
void copy_core (const FrAdcData &Source)
 

Private Attributes

const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Detailed Description

ADC Data Structure Definition.

Member Typedef Documentation

◆ bias_type [1/3]

◆ bias_type [2/3]

◆ bias_type [3/3]

◆ channel_type [1/3]

◆ channel_type [2/3]

◆ channel_type [3/3]

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ crate_type [1/3]

◆ crate_type [2/3]

◆ crate_type [3/3]

◆ demote_arg_type [1/3]

◆ demote_arg_type [2/3]

◆ demote_arg_type [3/3]

◆ demote_ret_type [1/3]

◆ demote_ret_type [2/3]

◆ demote_ret_type [3/3]

◆ frame_spec_version_type [1/3]

◆ frame_spec_version_type [2/3]

◆ frame_spec_version_type [3/3]

◆ fShift_type [1/3]

◆ fShift_type [2/3]

◆ fShift_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nBits_type [1/3]

◆ nBits_type [2/3]

◆ nBits_type [3/3]

◆ nps_type [1/3]

typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type

◆ nps_type [2/3]

typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type

◆ nps_type [3/3]

typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type

◆ object_type [1/3]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/3]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [3/3]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ overRange_type [1/3]

◆ overRange_type [2/3]

◆ overRange_type [3/3]

◆ promote_arg_type [1/3]

◆ promote_arg_type [2/3]

◆ promote_arg_type [3/3]

◆ promote_ret_type [1/3]

◆ promote_ret_type [2/3]

◆ promote_ret_type [3/3]

◆ ps_type [1/3]

typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type

◆ ps_type [2/3]

typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type

◆ ps_type [3/3]

typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type

◆ sampleRate_type [1/3]

◆ sampleRate_type [2/3]

◆ sampleRate_type [3/3]

◆ slope_type [1/3]

◆ slope_type [2/3]

◆ slope_type [3/3]

◆ timeOffsetN_type [1/3]

◆ timeOffsetN_type [2/3]

◆ timeOffsetN_type [3/3]

◆ timeOffsetS_type [1/3]

◆ timeOffsetS_type [2/3]

◆ timeOffsetS_type [3/3]

◆ unique_object_type [1/3]

◆ unique_object_type [2/3]

◆ unique_object_type [3/3]

◆ units_type [1/3]

◆ units_type [2/3]

◆ units_type [3/3]

Constructor & Destructor Documentation

◆ FrAdcData() [1/12]

FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [2/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( const FrAdcData Source)

◆ FrAdcData() [3/12]

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 
)

◆ ~FrAdcData() [1/3]

FrameCPP::Version_3::FrAdcData::~FrAdcData ( )

◆ FrAdcData() [4/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( istream_type Stream)
private

◆ FrAdcData() [5/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [6/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( const FrAdcData Source)

◆ FrAdcData() [7/12]

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 
)

◆ ~FrAdcData() [2/3]

FrameCPP::Version_3::FrAdcData::~FrAdcData ( )

◆ FrAdcData() [8/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( istream_type Stream)
private

◆ FrAdcData() [9/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [10/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( const FrAdcData Source)

◆ FrAdcData() [11/12]

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 
)

◆ ~FrAdcData() [3/3]

FrameCPP::Version_3::FrAdcData::~FrAdcData ( )

◆ FrAdcData() [12/12]

FrameCPP::Version_3::FrAdcData::FrAdcData ( istream_type Stream)
private

Member Function Documentation

◆ AppendComment() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::AppendComment ( const comment_type Comment)
inlineinherited

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::AppendComment ( const comment_type Comment)
inherited

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::AppendComment ( const comment_type Comment)
inherited

Extend the comment associated with the FrAdcData structure.

◆ Bytes() [1/3]

cmn_streamsize_type FrameCPP::Version_3::FrAdcData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ bytes() [1/3]

cmn_streamsize_type FrameCPP::Version_3::FrAdcDataNPS::bytes ( const Common::StreamBase Stream) const
inlineprotectedinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [2/3]

cmn_streamsize_type FrameCPP::Version_3::FrAdcData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ bytes() [2/3]

cmn_streamsize_type FrameCPP::Version_3::FrAdcDataNPS::bytes ( const Common::StreamBase Stream) const
protectedinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [3/3]

cmn_streamsize_type FrameCPP::Version_3::FrAdcData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ bytes() [3/3]

cmn_streamsize_type FrameCPP::Version_3::FrAdcDataNPS::bytes ( const Common::StreamBase Stream) const
protectedinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Clone() [1/3]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, and FrameCPP::Common::PTR_STRUCT_BASE.

◆ Clone() [2/3]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, and FrameCPP::Common::PTR_STRUCT_BASE.

◆ Clone() [3/3]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, and FrameCPP::Common::PTR_STRUCT_BASE.

◆ copy_core() [1/3]

void FrameCPP::Version_3::FrAdcData::copy_core ( const FrAdcData Source)
private

◆ copy_core() [2/3]

void FrameCPP::Version_3::FrAdcData::copy_core ( const FrAdcData Source)
private

◆ copy_core() [3/3]

void FrameCPP::Version_3::FrAdcData::copy_core ( const FrAdcData Source)
private

◆ Create() [1/5]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, and FrameCPP::Version_8::FrTOC.

◆ Create() [2/5]

virtual FrAdcData * FrameCPP::Version_3::FrAdcData::Create ( istream_type Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [3/5]

virtual FrAdcData * FrameCPP::Version_3::FrAdcData::Create ( istream_type Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [4/5]

virtual FrAdcData * FrameCPP::Version_3::FrAdcData::Create ( istream_type Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [5/5]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

◆ demote() [1/3]

virtual demote_ret_type FrameCPP::Version_3::FrAdcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [2/3]

virtual demote_ret_type FrameCPP::Version_3::FrAdcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [3/3]

virtual demote_ret_type FrameCPP::Version_3::FrAdcData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/3]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [3/3]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetBias() [1/3]

FrAdcDataNPS::bias_type FrameCPP::Version_3::FrAdcDataNPS::GetBias ( ) const
inlineinherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/3]

bias_type FrameCPP::Version_3::FrAdcDataNPS::GetBias ( ) const
inherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [3/3]

bias_type FrameCPP::Version_3::FrAdcDataNPS::GetBias ( ) const
inherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannel() [1/3]

FrAdcDataNPS::channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel ( ) const
inlineinherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannel() [2/3]

channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel ( ) const
inherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannel() [3/3]

channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel ( ) const
inherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetClass() [1/3]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/3]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetClass() [2/3]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [2/3]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetClass() [3/3]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [3/3]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetComment() [1/3]

const FrAdcDataNPS::comment_type & FrameCPP::Version_3::FrAdcDataNPS::GetComment ( ) const
inlineinherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/3]

const comment_type & FrameCPP::Version_3::FrAdcDataNPS::GetComment ( ) const
inherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [3/3]

const comment_type & FrameCPP::Version_3::FrAdcDataNPS::GetComment ( ) const
inherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetCrate() [1/3]

FrAdcDataNPS::crate_type FrameCPP::Version_3::FrAdcDataNPS::GetCrate ( ) const
inlineinherited

The crate number for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetCrate() [2/3]

crate_type FrameCPP::Version_3::FrAdcDataNPS::GetCrate ( ) const
inherited

The crate number for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetCrate() [3/3]

crate_type FrameCPP::Version_3::FrAdcDataNPS::GetCrate ( ) const
inherited

The crate number for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetDescription() [1/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [3/3]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetFShift() [1/3]

FrAdcDataNPS::fShift_type FrameCPP::Version_3::FrAdcDataNPS::GetFShift ( ) const
inlineinherited

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetFShift() [2/3]

fShift_type FrameCPP::Version_3::FrAdcDataNPS::GetFShift ( ) const
inherited

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetFShift() [3/3]

fShift_type FrameCPP::Version_3::FrAdcDataNPS::GetFShift ( ) const
inherited

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetName() [1/3]

const FrAdcDataNPS::name_type & FrameCPP::Version_3::FrAdcDataNPS::GetName ( ) const
inlineinherited

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [2/3]

const name_type & FrameCPP::Version_3::FrAdcDataNPS::GetName ( ) const
inherited

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [3/3]

const name_type & FrameCPP::Version_3::FrAdcDataNPS::GetName ( ) const
inherited

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNameSlow() [1/3]

const std::string & FrameCPP::Version_3::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ GetNameSlow() [2/3]

const std::string & FrameCPP::Version_3::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ GetNameSlow() [3/3]

const std::string & FrameCPP::Version_3::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ GetNBits() [1/3]

FrAdcDataNPS::nBits_type FrameCPP::Version_3::FrAdcDataNPS::GetNBits ( ) const
inlineinherited

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetNBits() [2/3]

nBits_type FrameCPP::Version_3::FrAdcDataNPS::GetNBits ( ) const
inherited

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetNBits() [3/3]

nBits_type FrameCPP::Version_3::FrAdcDataNPS::GetNBits ( ) const
inherited

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetOverRange() [1/3]

FrAdcDataNPS::overRange_type FrameCPP::Version_3::FrAdcDataNPS::GetOverRange ( ) const
inlineinherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetOverRange() [2/3]

overRange_type FrameCPP::Version_3::FrAdcDataNPS::GetOverRange ( ) const
inherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetOverRange() [3/3]

overRange_type FrameCPP::Version_3::FrAdcDataNPS::GetOverRange ( ) const
inherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetSampleRate() [1/3]

FrAdcDataNPS::sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::GetSampleRate ( ) const
inlineinherited

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/3]

sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::GetSampleRate ( ) const
inherited

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [3/3]

sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::GetSampleRate ( ) const
inherited

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/3]

FrAdcDataNPS::slope_type FrameCPP::Version_3::FrAdcDataNPS::GetSlope ( ) const
inlineinherited

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/3]

slope_type FrameCPP::Version_3::FrAdcDataNPS::GetSlope ( ) const
inherited

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [3/3]

slope_type FrameCPP::Version_3::FrAdcDataNPS::GetSlope ( ) const
inherited

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffsetN() [1/3]

FrAdcDataNPS::timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetN ( ) const
inlineinherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffsetN() [2/3]

timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetN ( ) const
inherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffsetN() [3/3]

timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetN ( ) const
inherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffsetS() [1/3]

FrAdcDataNPS::timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetS ( ) const
inlineinherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffsetS() [2/3]

timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetS ( ) const
inherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffsetS() [3/3]

timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetS ( ) const
inherited

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetUnits() [1/3]

FrAdcDataNPS::units_type FrameCPP::Version_3::FrAdcDataNPS::GetUnits ( ) const
inlineinherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/3]

STRING FrameCPP::Version_3::FrAdcDataNPS::GetUnits ( ) const
inherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [3/3]

STRING FrameCPP::Version_3::FrAdcDataNPS::GetUnits ( ) const
inherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ Merge() [1/3]

FrAdcData & FrameCPP::Version_3::FrAdcData::Merge ( const FrAdcData RHS)

◆ Merge() [2/3]

FrAdcData & FrameCPP::Version_3::FrAdcData::Merge ( const FrAdcData RHS)

◆ Merge() [3/3]

FrAdcData & FrameCPP::Version_3::FrAdcData::Merge ( const FrAdcData RHS)

◆ ObjectStructName() [1/3]

virtual const char * FrameCPP::Version_3::FrAdcData::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/3]

virtual const char * FrameCPP::Version_3::FrAdcData::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [3/3]

virtual const char * FrameCPP::Version_3::FrAdcData::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator!=() [1/3]

bool FrameCPP::Version_3::FrAdcData::operator!= ( const FrAdcData RHS) const
inline

◆ operator!=() [2/3]

bool FrameCPP::Version_3::FrAdcData::operator!= ( const FrAdcData RHS) const

◆ operator!=() [3/3]

bool FrameCPP::Version_3::FrAdcData::operator!= ( const FrAdcData RHS) const

◆ operator==() [1/7]

virtual bool FrameCPP::Version_3::FrAdcData::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [2/7]

virtual bool FrameCPP::Version_3::FrAdcData::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/7]

virtual bool FrameCPP::Version_3::FrAdcData::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [4/7]

bool FrameCPP::Version_3::FrAdcData::operator== ( const FrAdcData RHS) const
inline

◆ operator==() [5/7]

bool FrameCPP::Version_3::FrAdcData::operator== ( const FrAdcData RHS) const

◆ operator==() [6/7]

bool FrameCPP::Version_3::FrAdcData::operator== ( const FrAdcData RHS) const

◆ operator==() [7/7]

bool FrameCPP::Version_3::FrAdcDataNPS::operator== ( const FrAdcDataNPS RHS) const
inlineprotectedinherited

Comparison operator.

◆ Promote() [1/3]

FrAdcData::promote_ret_type FrameCPP::Version_3::FrAdcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

◆ Promote() [2/3]

static promote_ret_type FrameCPP::Version_3::FrAdcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
static

◆ Promote() [3/3]

static promote_ret_type FrameCPP::Version_3::FrAdcData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
static

◆ promote() [1/3]

virtual promote_ret_type FrameCPP::Version_3::FrAdcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [2/3]

virtual promote_ret_type FrameCPP::Version_3::FrAdcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [3/3]

virtual promote_ret_type FrameCPP::Version_3::FrAdcData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/7]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/7]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/7]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/7]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/7]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [6/7]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [7/7]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ SetBias() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetBias ( bias_type  bias)
inlineinherited

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetBias() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetBias ( bias_type  bias)
inherited

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetBias() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetBias ( bias_type  bias)
inherited

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetChannel() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetChannel ( channel_type  Value)
inlineinherited

Set the numeric id for the channel.

◆ SetChannel() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetChannel ( channel_type  Value)
inherited

Set the numeric id for the channel.

◆ SetChannel() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetChannel ( channel_type  Value)
inherited

Set the numeric id for the channel.

◆ SetComment() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetComment ( const comment_type comment)
inlineinherited

Set the comment associated with the FrAdcData structure.

◆ SetComment() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetComment ( const comment_type comment)
inherited

Set the comment associated with the FrAdcData structure.

◆ SetComment() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetComment ( const comment_type comment)
inherited

Set the comment associated with the FrAdcData structure.

◆ SetCrate() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetCrate ( crate_type  Value)
inlineinherited

Set the numeric crate id for the channel.

◆ SetCrate() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetCrate ( crate_type  Value)
inherited

Set the numeric crate id for the channel.

◆ SetCrate() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetCrate ( crate_type  Value)
inherited

Set the numeric crate id for the channel.

◆ SetNBits() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetNBits ( nBits_type  NBits)
inlineinherited

The number of bits in the A/D output.

Parameters
[in]NBitsTne number of bits in the A/D output.

◆ SetNBits() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetNBits ( nBits_type  NBits)
inherited

The number of bits in the A/D output.

Parameters
[in]NBitsTne number of bits in the A/D output.

◆ SetNBits() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetNBits ( nBits_type  NBits)
inherited

The number of bits in the A/D output.

Parameters
[in]NBitsTne number of bits in the A/D output.

◆ SetOverRange() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetOverRange ( overRange_type  flag)
inlineinherited

Establish the value of the overRange field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetOverRange() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetOverRange ( overRange_type  flag)
inherited

Establish the value of the overRange field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetOverRange() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetOverRange ( overRange_type  flag)
inherited

Establish the value of the overRange field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetSampleRate() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetSampleRate ( sampleRate_type  SampleRate)
inlineinherited

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSampleRate() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetSampleRate ( sampleRate_type  SampleRate)
inherited

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSampleRate() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetSampleRate ( sampleRate_type  SampleRate)
inherited

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSlope() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetSlope ( slope_type  slope)
inlineinherited

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetSlope() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetSlope ( slope_type  slope)
inherited

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetSlope() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetSlope ( slope_type  slope)
inherited

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetTimeOffset() [1/4]

void FrameCPP::Version_3::FrAdcData::SetTimeOffset ( INT_4U  Seconds,
INT_4U  Nanoseconds 
)

◆ SetTimeOffset() [2/4]

void FrameCPP::Version_3::FrAdcData::SetTimeOffset ( INT_4U  Seconds,
INT_4U  Nanoseconds 
)

◆ SetTimeOffset() [3/4]

void FrameCPP::Version_3::FrAdcData::SetTimeOffset ( INT_4U  Seconds,
INT_4U  Nanoseconds 
)

◆ SetTimeOffset() [4/4]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffset ( timeOffsetS_type  Seconds,
timeOffsetN_type  Nanoseconds 
)
inlineinherited

Establish the value of the timeOffset field.

◆ SetTimeOffsetN() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type  time)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetN() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type  time)
inherited

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetN() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type  time)
inherited

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetS() [1/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type  time)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetS() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type  time)
inherited

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetS() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type  time)
inherited

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ StructDescription() [1/3]

static const Common::Description * FrameCPP::Version_3::FrAdcData::StructDescription ( )
static

◆ StructDescription() [2/3]

static const Common::Description * FrameCPP::Version_3::FrAdcData::StructDescription ( )
static

◆ StructDescription() [3/3]

static const Common::Description * FrameCPP::Version_3::FrAdcData::StructDescription ( )
static

◆ StructName() [1/3]

const char * FrameCPP::Version_3::FrAdcData::StructName ( )
inlinestatic

◆ StructName() [2/3]

static const char * FrameCPP::Version_3::FrAdcData::StructName ( )
static

◆ StructName() [3/3]

static const char * FrameCPP::Version_3::FrAdcData::StructName ( )
static

◆ VerifyObject() [1/3]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, and FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, and FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, and FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >.

◆ write() [1/3]

void FrAdcDataNPS::write ( Common::OStream Stream) const
protectedinherited

Write contents to the stream.

◆ write() [2/3]

void FrameCPP::Version_3::FrAdcDataNPS::write ( Common::OStream Stream) const
protectedinherited

Write contents to the stream.

◆ write() [3/3]

void FrameCPP::Version_3::FrAdcDataNPS::write ( Common::OStream Stream) const
protectedinherited

Write contents to the stream.

◆ Write() [1/3]

virtual void FrameCPP::Version_3::FrAdcData::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/3]

virtual void FrameCPP::Version_3::FrAdcData::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [3/3]

virtual void FrameCPP::Version_3::FrAdcData::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/3]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [2/3]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [3/3]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ bias

bias_type FrameCPP::Version_3::FrAdcDataNPS::bias
protectedinherited

DC bias on channel (Units @ ADC counts = 0)

◆ channel

channel_type FrameCPP::Version_3::FrAdcDataNPS::channel
protectedinherited

Channel number

Note
This variable is determined by the site and must be unique over all detectors.

◆ comment

comment_type FrameCPP::Version_3::FrAdcDataNPS::comment
protectedinherited

Comment for the ADC.

◆ crate

crate_type FrameCPP::Version_3::FrAdcDataNPS::crate
protectedinherited

Channel grouping number containing ADC.

Note
This variable is determined by the site and must be unique over all detectors.

◆ DEFAULT_BIAS

static const bias_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_BIAS
staticinherited
Initial value:
=
const FR_ADC_DATA_BIAS_TYPE FR_ADC_DATA_DEFAULT_BIAS
Definition: FrAdcDataNPS.hh:84

◆ DEFAULT_FSHIFT

static const fShift_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_FSHIFT
staticinherited
Initial value:
=
const FR_ADC_DATA_FSHIFT_TYPE FR_ADC_DATA_DEFAULT_FSHIFT
Definition: FrAdcDataNPS.hh:86

◆ DEFAULT_OVER_RANGE

static const overRange_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_OVER_RANGE
staticinherited
Initial value:
=
const FR_ADC_DATA_OVERRANGE_TYPE FR_ADC_DATA_DEFAULT_OVER_RANGE
Definition: FrAdcDataNPS.hh:91

◆ DEFAULT_SLOPE

static const slope_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_SLOPE
staticinherited
Initial value:
=
const FR_ADC_DATA_SLOPE_TYPE FR_ADC_DATA_DEFAULT_SLOPE
Definition: FrAdcDataNPS.hh:85

◆ DEFAULT_TIME_OFFSET_N

static const timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_TIME_OFFSET_N
staticinherited
Initial value:
=
const FR_ADC_DATA_TIMEOFFSETN_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET_N
Definition: FrAdcDataNPS.hh:89

◆ DEFAULT_TIME_OFFSET_S

static const timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_TIME_OFFSET_S
staticinherited
Initial value:
=
const FR_ADC_DATA_TIMEOFFSETS_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET_S
Definition: FrAdcDataNPS.hh:87

◆ fShift

fShift_type FrameCPP::Version_3::FrAdcDataNPS::fShift
protectedinherited

The frequency (in HZ) in the original data that corresponds to zero Hz in the heterodyned series.

Note
In the heterodyning process the real time series in multiplied by cos[2pi fShift(t-to) + phase] to get the real part and by -sin[2pi fShift(t-t(0)) + phase] to get the imaginary part of the resulting complex time series. The time origin t(0) is the beginning of the frame.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
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.

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ name

name_type FrameCPP::Version_3::FrAdcDataNPS::name
protectedinherited

Channel name – must be unique with the frame

◆ nBits

nBits_type FrameCPP::Version_3::FrAdcDataNPS::nBits
protectedinherited

Number of bits in A/D output.

◆ overRange

overRange_type FrameCPP::Version_3::FrAdcDataNPS::overRange
protectedinherited

Data valid flag

Note
overRange = 0 -> ADC ddata valid; overRange != 0 -> ADC data suspect/not valid

◆ sampleRate

sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::sampleRate
protectedinherited

Data acquisition rate, samples per second.

◆ slope

slope_type FrameCPP::Version_3::FrAdcDataNPS::slope
protectedinherited

ADC calibration: input units/count.

◆ timeOffsetN

timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::timeOffsetN
protectedinherited

For Triggered data lasting less than one frame, integer residual nanoseconds start time relative to frame start

◆ timeOffsetS

timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::timeOffsetS
protectedinherited

For Triggered data lasting less than one frame, integer seconds start time relative to frame start

◆ units

units_type FrameCPP::Version_3::FrAdcDataNPS::units
protectedinherited

ADC calibration: input units for slope If dimensionless, then units == <NONE>, in CAPITALS (without <...>).


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