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

#include <FrAdcData.hh>

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

Public Types

typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef std::unique_ptr< FrAdcDatasubfradcdata_type
 
typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef std::unique_ptr< FrAdcDatasubfradcdata_type
 
typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef std::unique_ptr< FrAdcDatasubfradcdata_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_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_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_TIMEOFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_TIMEOFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_TIMEOFFSET_TYPE timeOffset_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_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_type
 
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_type
 
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_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
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrAdcData ()
 Default constructor. More...
 
 FrAdcData (const FrAdcData &Source)
 Copy constructor. More...
 
 FrAdcData (const std::string &name, channelGroup_type group, channelNumber_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=DEFAULT_BIAS, slope_type slope=DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=DEFAULT_FSHIFT, timeOffset_type timeOffset=DEFAULT_TIME_OFFSET, dataValid_type dataValid=DEFAULT_DATA_VALID, phase_type phase=DEFAULT_PHASE)
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 
 ~FrAdcData ()
 
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...
 
const std::string & GetName () const
 
FrAdcDataMerge (const FrAdcData &RHS)
 
subfradcdata_type SubFrAdcData (REAL_8 Offset, REAL_8 Dt) const
 
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)
 Copy constructor. More...
 
 FrAdcData (const std::string &name, channelGroup_type group, channelNumber_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=DEFAULT_BIAS, slope_type slope=DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=DEFAULT_FSHIFT, timeOffset_type timeOffset=DEFAULT_TIME_OFFSET, dataValid_type dataValid=DEFAULT_DATA_VALID, phase_type phase=DEFAULT_PHASE)
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 
 ~FrAdcData ()
 
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...
 
const std::string & GetName () const
 
FrAdcDataMerge (const FrAdcData &RHS)
 
subfradcdata_type SubFrAdcData (REAL_8 Offset, REAL_8 Dt) const
 
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)
 Copy constructor. More...
 
 FrAdcData (const std::string &name, channelGroup_type group, channelNumber_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=DEFAULT_BIAS, slope_type slope=DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=DEFAULT_FSHIFT, timeOffset_type timeOffset=DEFAULT_TIME_OFFSET, dataValid_type dataValid=DEFAULT_DATA_VALID, phase_type phase=DEFAULT_PHASE)
 
 FrAdcData (Previous::FrAdcData &Source, istream_type *Stream)
 
 ~FrAdcData ()
 
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...
 
const std::string & GetName () const
 
FrAdcDataMerge (const FrAdcData &RHS)
 
subfradcdata_type SubFrAdcData (REAL_8 Offset, REAL_8 Dt) const
 
virtual FrAdcDataCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
const std::string & GetComment () const
 A brief description of the FrAdcData structure. More...
 
const std::string & GetComment () const
 A brief description of the FrAdcData structure. More...
 
const std::string & GetComment () const
 A brief description of the FrAdcData structure. More...
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData. More...
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData. More...
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData. More...
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData. More...
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData. More...
 
channelNumber_type GetChannelNumber () const
 The channel 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...
 
const units_typeGetUnits () const
 The units used in the ADC calibration. More...
 
const units_typeGetUnits () const
 The units used in the ADC calibration. More...
 
const units_typeGetUnits () 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...
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time. More...
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time. More...
 
timeOffset_type GetTimeOffset () 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...
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset. More...
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset. More...
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset. More...
 
dataValid_type GetDataValid () const
 Retrieve the overRange value. More...
 
dataValid_type GetDataValid () const
 Retrieve the overRange value. More...
 
dataValid_type GetDataValid () const
 Retrieve the overRange value. More...
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure. More...
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure. More...
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure. More...
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field. More...
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field. More...
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid 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 SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field. More...
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field. More...
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field. More...
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field. More...
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field. More...
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field. More...
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure. More...
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure. More...
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure. More...
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output. More...
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output. More...
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output. More...
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field. More...
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field. More...
 
void SetSampleRate (sampleRate_type Value)
 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 (timeOffset_type Value)
 Establish the value of the timeOffset field. More...
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field. More...
 
void SetTimeOffset (timeOffset_type Value)
 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...
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

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 units_type DEFAULT_UNITS ()
 
static units_type DEFAULT_UNITS ()
 
static units_type DEFAULT_UNITS ()
 
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...
 
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)
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 

Static Public Attributes

static const bias_type DEFAULT_BIAS
 
static const slope_type DEFAULT_SLOPE
 
static const fShift_type DEFAULT_FSHIFT
 
static const timeOffset_type DEFAULT_TIME_OFFSET
 
static const phase_type DEFAULT_PHASE
 
static const dataValid_type DEFAULT_DATA_VALID
 

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 void vTOCQuery (int InfoClass, va_list vl) const
 
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 void vTOCQuery (int InfoClass, va_list vl) const
 
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 void vTOCQuery (int InfoClass, va_list vl) const
 
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 copyCore (const FrAdcDataNPS &Source)
 
void copyCore (const FrAdcDataNPS &Source)
 
void copyCore (const FrAdcDataNPS &Source)
 
void incrementTimeOffset (timeOffset_type Value)
 Increment the time offset by the specified value. More...
 
void incrementTimeOffset (timeOffset_type Value)
 Increment the time offset by the specified value. More...
 
void incrementTimeOffset (timeOffset_type Value)
 Increment the time offset by the specified value. 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...
 
void setName (const std::string &Name)
 
void setName (const std::string &Name)
 
void setName (const std::string &Name)
 
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...
 

Static Protected Member Functions

template<typename DescriptionType , typename FrSEType >
static void structDescription (DescriptionType &Desc)
 
template<typename DescriptionType , typename FrSEType >
static void structDescription (DescriptionType &Desc)
 
template<typename DescriptionType , typename FrSEType >
static void structDescription (DescriptionType &Desc)
 

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

name_type name
 
comment_type comment
 
channelGroup_type channelGroup
 
channelNumber_type channelNumber
 
nBits_type nBits
 
bias_type bias
 
slope_type slope
 
units_type units
 
sampleRate_type sampleRate
 
timeOffset_type timeOffset
 
fShift_type fShift
 
phase_type phase
 
dataValid_type dataValid
 
const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Member Typedef Documentation

◆ bias_type [1/3]

◆ bias_type [2/3]

◆ bias_type [3/3]

◆ channelGroup_type [1/3]

◆ channelGroup_type [2/3]

◆ channelGroup_type [3/3]

◆ channelNumber_type [1/3]

◆ channelNumber_type [2/3]

◆ channelNumber_type [3/3]

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ dataValid_type [1/3]

◆ dataValid_type [2/3]

◆ dataValid_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_6::FrAdcData::nps_type

◆ nps_type [2/3]

typedef FrAdcDataNPS FrameCPP::Version_6::FrAdcData::nps_type

◆ nps_type [3/3]

typedef FrAdcDataNPS FrameCPP::Version_6::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

◆ phase_type [1/3]

◆ phase_type [2/3]

◆ phase_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_6::FrAdcData::ps_type

◆ ps_type [2/3]

typedef FrAdcDataPS FrameCPP::Version_6::FrAdcData::ps_type

◆ ps_type [3/3]

typedef FrAdcDataPS FrameCPP::Version_6::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]

◆ string_2_type [1/3]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/3]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [3/3]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ subfradcdata_type [1/3]

typedef std::unique_ptr< FrAdcData > FrameCPP::Version_6::FrAdcData::subfradcdata_type

◆ subfradcdata_type [2/3]

typedef std::unique_ptr< FrAdcData > FrameCPP::Version_6::FrAdcData::subfradcdata_type

◆ subfradcdata_type [3/3]

typedef std::unique_ptr< FrAdcData > FrameCPP::Version_6::FrAdcData::subfradcdata_type

◆ timeOffset_type [1/3]

◆ timeOffset_type [2/3]

◆ timeOffset_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]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

Constructor & Destructor Documentation

◆ FrAdcData() [1/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [2/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( const FrAdcData Source)

Copy constructor.

◆ FrAdcData() [3/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( const std::string &  name,
channelGroup_type  group,
channelNumber_type  channel,
nBits_type  nBits,
sampleRate_type  sampleRate,
bias_type  bias = DEFAULT_BIAS,
slope_type  slope = DEFAULT_SLOPE,
const std::string &  units = FR_ADC_DATA_DEFAULT_UNITS( ),
fShift_type  fShift = DEFAULT_FSHIFT,
timeOffset_type  timeOffset = DEFAULT_TIME_OFFSET,
dataValid_type  dataValid = DEFAULT_DATA_VALID,
phase_type  phase = DEFAULT_PHASE 
)

◆ FrAdcData() [4/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( Previous::FrAdcData Source,
istream_type Stream 
)

◆ ~FrAdcData() [1/3]

FrameCPP::Version_6::FrAdcData::~FrAdcData ( )

◆ FrAdcData() [5/15]

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

◆ FrAdcData() [6/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [7/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( const FrAdcData Source)

Copy constructor.

◆ FrAdcData() [8/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( const std::string &  name,
channelGroup_type  group,
channelNumber_type  channel,
nBits_type  nBits,
sampleRate_type  sampleRate,
bias_type  bias = DEFAULT_BIAS,
slope_type  slope = DEFAULT_SLOPE,
const std::string &  units = FR_ADC_DATA_DEFAULT_UNITS(),
fShift_type  fShift = DEFAULT_FSHIFT,
timeOffset_type  timeOffset = DEFAULT_TIME_OFFSET,
dataValid_type  dataValid = DEFAULT_DATA_VALID,
phase_type  phase = DEFAULT_PHASE 
)

◆ FrAdcData() [9/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( Previous::FrAdcData Source,
istream_type Stream 
)

◆ ~FrAdcData() [2/3]

FrameCPP::Version_6::FrAdcData::~FrAdcData ( )

◆ FrAdcData() [10/15]

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

◆ FrAdcData() [11/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [12/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( const FrAdcData Source)

Copy constructor.

◆ FrAdcData() [13/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( const std::string &  name,
channelGroup_type  group,
channelNumber_type  channel,
nBits_type  nBits,
sampleRate_type  sampleRate,
bias_type  bias = DEFAULT_BIAS,
slope_type  slope = DEFAULT_SLOPE,
const std::string &  units = FR_ADC_DATA_DEFAULT_UNITS(),
fShift_type  fShift = DEFAULT_FSHIFT,
timeOffset_type  timeOffset = DEFAULT_TIME_OFFSET,
dataValid_type  dataValid = DEFAULT_DATA_VALID,
phase_type  phase = DEFAULT_PHASE 
)

◆ FrAdcData() [14/15]

FrameCPP::Version_6::FrAdcData::FrAdcData ( Previous::FrAdcData Source,
istream_type Stream 
)

◆ ~FrAdcData() [3/3]

FrameCPP::Version_6::FrAdcData::~FrAdcData ( )

◆ FrAdcData() [15/15]

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

Member Function Documentation

◆ AppendComment() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::AppendComment ( const std::string &  comment)
inlineinherited

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::AppendComment ( const std::string &  comment)
inherited

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::AppendComment ( const std::string &  comment)
inherited

Extend the comment associated with the FrAdcData structure.

◆ Bytes() [1/3]

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::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_6::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_6::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_6::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_6::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_6::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_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.

◆ Clone() [2/3]

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

constructor - virtual copy constructor

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

◆ Clone() [3/3]

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

constructor - virtual copy constructor

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

◆ copy_core() [1/3]

void FrameCPP::Version_6::FrAdcData::copy_core ( const FrAdcData Source)
inlineprivate

◆ copy_core() [2/3]

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

◆ copy_core() [3/3]

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

◆ copyCore() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::copyCore ( const FrAdcDataNPS Source)
inlineprotectedinherited

◆ copyCore() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::copyCore ( const FrAdcDataNPS Source)
protectedinherited

◆ copyCore() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::copyCore ( const FrAdcDataNPS Source)
protectedinherited

◆ Create() [1/5]

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

◆ Create() [2/5]

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

constructor - virtual

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

◆ Create() [3/5]

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

constructor - virtual

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

◆ Create() [4/5]

virtual FrAdcData* FrameCPP::Version_6::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

◆ DataType() [1/6]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [2/6]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [3/6]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [4/6]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DataType() [5/6]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DataType() [6/6]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DEFAULT_UNITS() [1/3]

FrAdcDataNPS::units_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_UNITS ( )
inlinestaticinherited

◆ DEFAULT_UNITS() [2/3]

static units_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_UNITS ( )
staticinherited

◆ DEFAULT_UNITS() [3/3]

static units_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_UNITS ( )
staticinherited

◆ demote() [1/3]

FrAdcData::demote_ret_type FrameCPP::Version_6::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_6::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_6::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_6::FrAdcDataNPS::GetBias ( ) const
inlineinherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/3]

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

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [3/3]

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

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup() [1/3]

INT_4U FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup ( ) const
inlineinherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelGroup() [2/3]

channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup ( ) const
inherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelGroup() [3/3]

channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup ( ) const
inherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber() [1/3]

FrAdcDataNPS::channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber ( ) const
inlineinherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannelNumber() [2/3]

channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber ( ) const
inherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannelNumber() [3/3]

channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber ( ) 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 std::string & FrameCPP::Version_6::FrAdcDataNPS::GetComment ( ) const
inlineinherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/3]

const std::string& FrameCPP::Version_6::FrAdcDataNPS::GetComment ( ) const
inherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [3/3]

const std::string& FrameCPP::Version_6::FrAdcDataNPS::GetComment ( ) const
inherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid() [1/3]

FrAdcDataNPS::dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid ( ) const
inlineinherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDataValid() [2/3]

dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid ( ) const
inherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDataValid() [3/3]

dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid ( ) const
inherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ 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_6::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_6::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_6::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 std::string & FrameCPP::Version_6::FrAdcData::GetName ( ) const

◆ GetName() [2/3]

const std::string& FrameCPP::Version_6::FrAdcData::GetName ( ) const

◆ GetName() [3/3]

const std::string& FrameCPP::Version_6::FrAdcData::GetName ( ) const

◆ GetNBits() [1/3]

FrAdcDataNPS::nBits_type FrameCPP::Version_6::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_6::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_6::FrAdcDataNPS::GetNBits ( ) const
inherited

Tne number of bits in the A/D output.

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

◆ GetPhase() [1/3]

FrAdcDataNPS::phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase ( ) const
inlineinherited

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetPhase() [2/3]

phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase ( ) const
inherited

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetPhase() [3/3]

phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase ( ) const
inherited

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetSampleRate() [1/3]

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/3]

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [3/3]

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/3]

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/3]

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [3/3]

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffset() [1/3]

FrAdcDataNPS::timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::GetTimeOffset ( ) 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.

◆ GetTimeOffset() [2/3]

timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::GetTimeOffset ( ) 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.

◆ GetTimeOffset() [3/3]

timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::GetTimeOffset ( ) 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]

const FrAdcDataNPS::units_type & FrameCPP::Version_6::FrAdcDataNPS::GetUnits ( ) const
inlineinherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/3]

const units_type& FrameCPP::Version_6::FrAdcDataNPS::GetUnits ( ) const
inherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [3/3]

const units_type& FrameCPP::Version_6::FrAdcDataNPS::GetUnits ( ) const
inherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ incrementTimeOffset() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::incrementTimeOffset ( timeOffset_type  Value)
inlineprotectedinherited

Increment the time offset by the specified value.

Parameters
[in]ValueThe amount of time by which to adjust the timeOffset value.

◆ incrementTimeOffset() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::incrementTimeOffset ( timeOffset_type  Value)
protectedinherited

Increment the time offset by the specified value.

Parameters
[in]ValueThe amount of time by which to adjust the timeOffset value.

◆ incrementTimeOffset() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::incrementTimeOffset ( timeOffset_type  Value)
protectedinherited

Increment the time offset by the specified value.

Parameters
[in]ValueThe amount of time by which to adjust the timeOffset value.

◆ Merge() [1/3]

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

◆ Merge() [2/3]

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

◆ Merge() [3/3]

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

◆ ObjectStructName() [1/3]

const char * FrameCPP::Version_6::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_6::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_6::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_6::FrAdcData::operator!= ( const FrAdcData RHS) const
inline

◆ operator!=() [2/3]

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

◆ operator!=() [3/3]

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

◆ operator==() [1/7]

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

comparison operator

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

◆ operator==() [2/7]

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

comparison operator

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

◆ operator==() [3/7]

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

comparison operator

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

◆ operator==() [4/7]

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

◆ operator==() [5/7]

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

◆ operator==() [6/7]

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

◆ operator==() [7/7]

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

Comparison operator.

◆ Promote() [1/3]

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

◆ Promote() [2/3]

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

◆ Promote() [3/3]

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

◆ promote() [1/3]

FrAdcData::promote_ret_type FrameCPP::Version_6::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_6::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_6::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_6::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_6::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_6::FrAdcDataNPS::SetBias ( bias_type  bias)
inherited

Establish the value of the bias field.

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

◆ SetChannelGroup() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelGroup ( channelGroup_type  Value)
inlineinherited

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelGroup() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelGroup ( channelGroup_type  Value)
inherited

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelGroup() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelGroup ( channelGroup_type  Value)
inherited

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelNumber() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelNumber ( channelNumber_type  Value)
inlineinherited

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetChannelNumber() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelNumber ( channelNumber_type  Value)
inherited

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetChannelNumber() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelNumber ( channelNumber_type  Value)
inherited

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetComment() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetComment ( const comment_type Value)
inlineinherited

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetComment() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetComment ( const comment_type Value)
inherited

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetComment() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetComment ( const comment_type Value)
inherited

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetDataValid() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetDataValid ( dataValid_type  flag)
inlineinherited

Establish the value of the dataValid field.

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

◆ SetDataValid() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetDataValid ( dataValid_type  flag)
inherited

Establish the value of the dataValid field.

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

◆ SetDataValid() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetDataValid ( dataValid_type  flag)
inherited

Establish the value of the dataValid field.

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

◆ setName() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::setName ( const std::string &  Name)
inlineprotectedinherited

◆ setName() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::setName ( const std::string &  Name)
inlineprotectedinherited

◆ setName() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::setName ( const std::string &  Name)
inlineprotectedinherited

◆ SetNBits() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetNBits ( nBits_type  Value)
inlineinherited

Tne number of bits in the A/D output.

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

◆ SetNBits() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetNBits ( nBits_type  Value)
inherited

Tne number of bits in the A/D output.

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

◆ SetNBits() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetNBits ( nBits_type  Value)
inherited

Tne number of bits in the A/D output.

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

◆ SetSampleRate() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetSampleRate ( sampleRate_type  Value)
inlineinherited

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetSampleRate ( sampleRate_type  Value)
inherited

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetSampleRate ( sampleRate_type  Value)
inherited

Establish the value of the sampleRate field.

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

◆ SetSlope() [1/3]

void FrameCPP::Version_6::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_6::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_6::FrAdcDataNPS::SetSlope ( slope_type  slope)
inherited

Establish the value of the slope field.

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

◆ SetTimeOffset() [1/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetTimeOffset ( timeOffset_type  Value)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffset() [2/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetTimeOffset ( timeOffset_type  Value)
inherited

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffset() [3/3]

void FrameCPP::Version_6::FrAdcDataNPS::SetTimeOffset ( timeOffset_type  Value)
inherited

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ StructDescription() [1/3]

const Description * FrameCPP::Version_6::FrAdcData::StructDescription ( )
static

◆ StructDescription() [2/3]

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

◆ StructDescription() [3/3]

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

◆ structDescription() [1/3]

template<typename DescriptionType , typename FrSEType >
void FrameCPP::Version_6::FrAdcDataNPS::structDescription ( DescriptionType &  Desc)
inlinestaticprotectedinherited

◆ structDescription() [2/3]

template<typename DescriptionType , typename FrSEType >
static void FrameCPP::Version_6::FrAdcDataNPS::structDescription ( DescriptionType &  Desc)
staticprotectedinherited

◆ structDescription() [3/3]

template<typename DescriptionType , typename FrSEType >
static void FrameCPP::Version_6::FrAdcDataNPS::structDescription ( DescriptionType &  Desc)
staticprotectedinherited

◆ StructName() [1/3]

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

◆ StructName() [2/3]

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

◆ StructName() [3/3]

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

◆ SubFrAdcData() [1/3]

FrAdcData::subfradcdata_type FrameCPP::Version_6::FrAdcData::SubFrAdcData ( REAL_8  Offset,
REAL_8  Dt 
) const

◆ SubFrAdcData() [2/3]

subfradcdata_type FrameCPP::Version_6::FrAdcData::SubFrAdcData ( REAL_8  Offset,
REAL_8  Dt 
) const

◆ SubFrAdcData() [3/3]

subfradcdata_type FrameCPP::Version_6::FrAdcData::SubFrAdcData ( REAL_8  Offset,
REAL_8  Dt 
) const

◆ TOCQuery() [1/3]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited

◆ TOCQuery() [2/3]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inherited

◆ TOCQuery() [3/3]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inherited

◆ VerifyObject() [1/3]

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

◆ VerifyObject() [2/3]

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

◆ VerifyObject() [3/3]

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

◆ vTOCQuery() [1/3]

virtual void FrameCPP::Version_6::FrAdcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ vTOCQuery() [2/3]

virtual void FrameCPP::Version_6::FrAdcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ vTOCQuery() [3/3]

virtual void FrameCPP::Version_6::FrAdcData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ write() [1/3]

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

Write contents to the stream.

◆ write() [2/3]

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

Write contents to the stream.

◆ write() [3/3]

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

Write contents to the stream.

◆ Write() [1/3]

void FrameCPP::Version_6::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_6::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_6::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_6::FrAdcDataNPS::bias
privateinherited

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

◆ channelGroup

channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::channelGroup
privateinherited

Channel grouping number containing ADC.

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

◆ channelNumber

channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::channelNumber
privateinherited

Channel number

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

◆ comment

comment_type FrameCPP::Version_6::FrAdcDataNPS::comment
privateinherited

Comment for the ADC.

◆ dataValid

dataValid_type FrameCPP::Version_6::FrAdcDataNPS::dataValid
privateinherited

Data valid flag

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

◆ DEFAULT_BIAS

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

◆ DEFAULT_DATA_VALID

static const dataValid_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_DATA_VALID
staticinherited
Initial value:
=
const FR_ADC_DATA_DATAVALID_TYPE FR_ADC_DATA_DEFAULT_DATA_VALID
Definition: FrAdcDataNPS.hh:96

◆ DEFAULT_FSHIFT

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

◆ DEFAULT_PHASE

static const phase_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_PHASE
staticinherited
Initial value:
=
const FR_ADC_DATA_PHASE_TYPE FR_ADC_DATA_DEFAULT_PHASE
Definition: FrAdcDataNPS.hh:95

◆ DEFAULT_SLOPE

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

◆ DEFAULT_TIME_OFFSET

static const timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_TIME_OFFSET
staticinherited
Initial value:
=
const FR_ADC_DATA_TIMEOFFSET_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET
Definition: FrAdcDataNPS.hh:94

◆ fShift

fShift_type FrameCPP::Version_6::FrAdcDataNPS::fShift
privateinherited

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_6::FrAdcDataNPS::name
privateinherited

Channel name – must be unique with the frame

◆ nBits

nBits_type FrameCPP::Version_6::FrAdcDataNPS::nBits
privateinherited

Number of bits in A/D output.

◆ phase

phase_type FrameCPP::Version_6::FrAdcDataNPS::phase
privateinherited

Phase (in radian) of heterodyning signal at start of dataset.

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.

◆ sampleRate

sampleRate_type FrameCPP::Version_6::FrAdcDataNPS::sampleRate
privateinherited

Data acquisition rate, samples per second.

◆ slope

slope_type FrameCPP::Version_6::FrAdcDataNPS::slope
privateinherited

ADC calibration: input units/count.

◆ timeOffset

timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::timeOffset
privateinherited

Offfset of 1st sample relative to the frame start time.

◆ units

units_type FrameCPP::Version_6::FrAdcDataNPS::units
privateinherited

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: