ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T > Class Template Reference

#include <FrAdcDataClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >:
Collaboration diagram for FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >:

Public Types

typedef FR_ADC_DATA_NAME_TYPE name_type
 
typedef FR_ADC_DATA_NAME_TYPE name_type
 
typedef FR_ADC_DATA_COMMENT_TYPE comment_type
 
typedef FR_ADC_DATA_COMMENT_TYPE 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_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_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_UNITS_TYPE units_type
 
typedef FR_ADC_DATA_UNITS_TYPE units_type
 
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_DATA_VALID_TYPE dataValid_type
 
typedef FR_ADC_DATA_DATA_VALID_TYPE dataValid_type
 
typedef Common::Container< FrVectdata_type
 
typedef Common::Container< FrVectdata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< FrVectaux_type
 
typedef Common::Container< FrVectaux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef INT_4U timeOffsetS_v4_type
 
typedef INT_4U timeOffsetS_v4_type
 
typedef INT_4S timeOffsetS_v3_type
 
typedef INT_4S timeOffsetS_v3_type
 
typedef INT_4U timeOffsetN_v3_type
 
typedef INT_4U timeOffsetN_v3_type
 
typedef INT_4U crate_v3_type
 
typedef INT_4U crate_v3_type
 
typedef INT_4U channel_v3_type
 
typedef INT_4U channel_v3_type
 
typedef INT_2U overRange_v3_type
 
typedef INT_2U overRange_v3_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
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 

Public Member Functions

 ClassicIO ()
 
 ClassicIO (Previous::FrAdcData &Source, stream_base_type *Stream)
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
 ClassicIO ()
 
 ClassicIO (Previous::FrAdcData &Source, stream_base_type *Stream)
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure.
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure.
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure.
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure.
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData.
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData.
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData.
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData.
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output.
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output.
 
bias_type GetBias () const
 DC bias on channel.
 
bias_type GetBias () const
 DC bias on channel.
 
slope_type GetSlope () const
 ADC calibration units per count.
 
slope_type GetSlope () const
 ADC calibration units per count.
 
const units_typeGetUnits () const
 The units used in the ADC calibration.
 
const units_typeGetUnits () const
 The units used in the ADC calibration.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time.
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time.
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz.
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz.
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset.
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset.
 
dataValid_type GetDataValid () const
 Retrieve the overRange value.
 
dataValid_type GetDataValid () const
 Retrieve the overRange value.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const data_typeRefData () const
 Identifier for vector of sampled data.
 
data_typeRefData ()
 Identifier for vector of sampled data.
 
const data_typeRefData () const
 Identifier for vector of sampled data.
 
data_typeRefData ()
 Identifier for vector of sampled data.
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure.
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure.
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field.
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field.
 
void SetBias (bias_type bias)
 Establish the value of the bias field.
 
void SetBias (bias_type bias)
 Establish the value of the bias field.
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field.
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field.
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field.
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field.
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
 
void SetSlope (slope_type slope)
 Establish the value of the slope field.
 
void SetSlope (slope_type slope)
 Establish the value of the slope field.
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field.
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field.
 
bool operator== (Data const &RHS) const
 
bool operator== (Data const &RHS) const
 
bool operator== (FrAdcData const &RHS) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const units_typeDEFAULT_UNITS ()
 
static const units_typeDEFAULT_UNITS ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
template<class T>
static int DataType (const T *Data)
 
template<class T>
static int DataType (const T &Data)
 
template<class T>
static int DataType (const T *Data)
 
template<class T>
static int DataType (const T &Data)
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 

Static Public Attributes

static constexpr slope_type DEFAULT_SLOPE { 1.0 }
 
static constexpr bias_type DEFAULT_BIAS { 0 }
 
static constexpr fShift_type DEFAULT_FSHIFT { 0 }
 
static constexpr timeOffset_type DEFAULT_TIME_OFFSET { 0 }
 
static constexpr dataValid_type DEFAULT_DATA_VALID { 0 }
 
static constexpr phase_type DEFAULT_PHASE { 0 }
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
void incrementTimeOffset (timeOffset_type Value)
 
void incrementTimeOffset (timeOffset_type Value)
 
void setName (const name_type &Value)
 
void setName (const name_type &Value)
 

Protected Attributes

name_type name
 Channel name – must be unique with the frame.
 
comment_type comment
 Comment.
 
channelGroup_type channelGroup
 Channel grouping number containing ADC.
 
channelNumber_type channelNumber
 Channel nubmer.
 
nBits_type nBits
 Number of bits in A/D output.
 
bias_type bias { DEFAULT_BIAS }
 DC bias on channel (Units @ ADC counts = 0)
 
slope_type slope { DEFAULT_SLOPE }
 ADC calibration: input units/ct.
 
units_type units { DEFAULT_UNITS( ) }
 ADC calibration: input units for slope.
 
sampleRate_type sampleRate
 Data acquisition rate, samples/s.
 
timeOffset_type timeOffset { DEFAULT_TIME_OFFSET }
 Offset of 1st sample relative to the frame start time.
 
fShift_type fShift { DEFAULT_FSHIFT }
 
phase_type phase { DEFAULT_PHASE }
 
dataValid_type dataValid { DEFAULT_DATA_VALID }
 Data valid flag.
 
data_type data
 Identifier for vector of sampled data.
 
aux_type aux
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 2 }
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_units_type
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_units_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum.
 

Member Typedef Documentation

◆ aux_iterator [1/2]

◆ aux_iterator [2/2]

◆ aux_type [1/2]

◆ aux_type [2/2]

◆ bias_type [1/2]

◆ bias_type [2/2]

◆ channel_v3_type [1/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::channel_v3_type
inherited

◆ channel_v3_type [2/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::channel_v3_type
inherited

◆ channelGroup_type [1/2]

◆ channelGroup_type [2/2]

◆ channelNumber_type [1/2]

◆ channelNumber_type [2/2]

◆ comment_type [1/2]

◆ comment_type [2/2]

◆ const_aux_iterator [1/2]

◆ const_aux_iterator [2/2]

◆ const_iterator [1/2]

◆ const_iterator [2/2]

◆ crate_v3_type [1/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::crate_v3_type
inherited

◆ crate_v3_type [2/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::crate_v3_type
inherited

◆ data_type [1/2]

◆ data_type [2/2]

◆ dataValid_type [1/2]

◆ dataValid_type [2/2]

◆ fShift_type [1/2]

◆ fShift_type [2/2]

◆ io_comment_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::io_comment_type
private

◆ io_comment_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::io_comment_type
private

◆ io_name_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::io_name_type
private

◆ io_name_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::io_name_type
private

◆ io_units_type [1/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::io_units_type
private

◆ io_units_type [2/2]

template<typename T>
typedef STRING FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::io_units_type
private

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ iterator [1/2]

◆ iterator [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nBits_type [1/2]

◆ nBits_type [2/2]

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ overRange_v3_type [1/2]

typedef INT_2U FrameCPP::v5::FrAdcData< FrVect, FrVect >::overRange_v3_type
inherited

◆ overRange_v3_type [2/2]

typedef INT_2U FrameCPP::v5::FrAdcData< FrVect, FrVect >::overRange_v3_type
inherited

◆ phase_type [1/2]

◆ phase_type [2/2]

◆ sampleRate_type [1/2]

◆ sampleRate_type [2/2]

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ slope_type [1/2]

◆ slope_type [2/2]

◆ string_2_type [1/2]

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

◆ string_2_type [2/2]

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

◆ struct_desc_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/2]

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/2]

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ timeOffset_type [1/2]

◆ timeOffset_type [2/2]

◆ timeOffsetN_v3_type [1/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::timeOffsetN_v3_type
inherited

◆ timeOffsetN_v3_type [2/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::timeOffsetN_v3_type
inherited

◆ timeOffsetS_v3_type [1/2]

typedef INT_4S FrameCPP::v5::FrAdcData< FrVect, FrVect >::timeOffsetS_v3_type
inherited

◆ timeOffsetS_v3_type [2/2]

typedef INT_4S FrameCPP::v5::FrAdcData< FrVect, FrVect >::timeOffsetS_v3_type
inherited

◆ timeOffsetS_v4_type [1/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::timeOffsetS_v4_type
inherited

◆ timeOffsetS_v4_type [2/2]

typedef INT_4U FrameCPP::v5::FrAdcData< FrVect, FrVect >::timeOffsetS_v4_type
inherited

◆ units_type [1/2]

◆ units_type [2/2]

Member Enumeration Documentation

◆ 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 

Constructor & Destructor Documentation

◆ ClassicIO() [1/4]

template<typename T>
FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [2/4]

template<typename T>
FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::ClassicIO ( Previous::FrAdcData & Source,
stream_base_type * Stream )
inline

◆ ClassicIO() [3/4]

template<typename T>
FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [4/4]

template<typename T>
FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::ClassicIO ( Previous::FrAdcData & Source,
stream_base_type * Stream )
inline

Member Function Documentation

◆ AppendComment() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment ( const std::string & comment)
inlineinherited

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment ( const std::string & comment)
inherited

Extend the comment associated with the FrAdcData structure.

◆ Bytes() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ DataType() [1/4]

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

◆ DataType() [2/4]

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

◆ DataType() [3/4]

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

◆ DataType() [4/4]

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

◆ DEFAULT_UNITS() [1/2]

const Data::units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_UNITS ( )
inlinestaticinherited

◆ DEFAULT_UNITS() [2/2]

static const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_UNITS ( )
staticinherited

◆ demote() [1/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ FrameSpecDescription() [1/2]

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetBias() [1/2]

Data::bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias ( ) const
inlineinherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/2]

bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias ( ) const
inherited

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup() [1/2]

Data::channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup ( ) const
inlineinherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelGroup() [2/2]

channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup ( ) const
inherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber() [1/2]

Data::channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber ( ) const
inlineinherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannelNumber() [2/2]

channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber ( ) const
inherited

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment() [1/2]

const Data::comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment ( ) const
inlineinherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/2]

const comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment ( ) const
inherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid() [1/2]

Data::dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid ( ) const
inlineinherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDataValid() [2/2]

dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid ( ) const
inherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetFShift() [1/2]

Data::fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

const Data::name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName ( ) const
inlineinherited

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [2/2]

const name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName ( ) const
inherited

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNBits() [1/2]

Data::nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits ( ) const
inlineinherited

Tne number of bits in the A/D output.

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

◆ GetNBits() [2/2]

nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits ( ) const
inherited

Tne number of bits in the A/D output.

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

◆ GetPhase() [1/2]

Data::phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

Data::sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate ( ) const
inlineinherited

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/2]

sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate ( ) const
inherited

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/2]

Data::slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope ( ) const
inlineinherited

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/2]

slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope ( ) const
inherited

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffset() [1/2]

Data::timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

const Data::units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits ( ) const
inlineinherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/2]

const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits ( ) const
inherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ incrementTimeOffset() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::incrementTimeOffset ( timeOffset_type Value)
inlineprotectedinherited

◆ incrementTimeOffset() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::incrementTimeOffset ( timeOffset_type Value)
protectedinherited

◆ ObjectStructName() [1/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/3]

bool FrameCPP::v5::FrAdcData< FrVect, FrVect >::operator== ( FrAdcData< FrVect, FrVect > const & RHS) const
inlineinherited

◆ operator==() [2/3]

bool FrameCPP::Version_8::FrAdcDataImpl::Data::operator== ( Data const & RHS) const
inlineinherited

◆ operator==() [3/3]

bool FrameCPP::Version_8::FrAdcDataImpl::Data::operator== ( Data const & RHS) const
inherited

◆ pBytes() [1/2]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

template<typename T>
cmn_streamsize_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
The newly allocated object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
The newly allocated object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ Promote() [1/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrAdcData based on Obj

◆ Promote() [2/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrAdcData based on Obj

◆ promote() [1/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ promote() [2/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ pWrite() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ RefAux() [1/4]

Data::aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( )
inlineinherited

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [2/4]

aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( )
inherited

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [3/4]

const Data::aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( ) const
inlineinherited

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [4/4]

const aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( ) const
inherited

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefData() [1/4]

Data::data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( )
inlineinherited

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [2/4]

data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( )
inherited

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [3/4]

const Data::data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( ) const
inlineinherited

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ RefData() [4/4]

const data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( ) const
inherited

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ SetBias() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias ( bias_type bias)
inlineinherited

Establish the value of the bias field.

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

◆ SetBias() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias ( bias_type bias)
inherited

Establish the value of the bias field.

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

◆ SetChannelGroup() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type Value)
inlineinherited

Establish the value of the channelGroup field.

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

◆ SetChannelGroup() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type Value)
inherited

Establish the value of the channelGroup field.

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

◆ SetChannelNumber() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type Value)
inlineinherited

Establish the value of the channelNumber field.

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

◆ SetChannelNumber() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type Value)
inherited

Establish the value of the channelNumber field.

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

◆ SetComment() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid ( dataValid_type flag)
inlineinherited

Establish the value of the dataValid field.

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

◆ SetDataValid() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid ( dataValid_type flag)
inherited

Establish the value of the dataValid field.

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

◆ setName() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::setName ( const name_type & Value)
inlineprotectedinherited

◆ setName() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::setName ( const name_type & Value)
protectedinherited

◆ SetNBits() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::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/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type Value)
inlineinherited

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type Value)
inherited

Establish the value of the sampleRate field.

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

◆ SetSlope() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope ( slope_type slope)
inlineinherited

Establish the value of the slope field.

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

◆ SetSlope() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope ( slope_type slope)
inherited

Establish the value of the slope field.

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

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type Value)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type Value)
inherited

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ StructDescription() [1/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ vTOCQuery() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ aux

aux_type FrameCPP::Version_8::FrAdcDataImpl::Data::aux
protectedinherited

Identifier for vector for user-provided information; use is generic

◆ bias

bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::bias { DEFAULT_BIAS }
protectedinherited

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

◆ channelGroup

channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::channelGroup
protectedinherited

Channel grouping number containing ADC.

◆ channelNumber

channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::channelNumber
protectedinherited

Channel nubmer.

◆ comment

comment_type FrameCPP::Version_8::FrAdcDataImpl::Data::comment
protectedinherited

Comment.

◆ data

data_type FrameCPP::Version_8::FrAdcDataImpl::Data::data
protectedinherited

Identifier for vector of sampled data.

◆ dataValid

dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::dataValid { DEFAULT_DATA_VALID }
protectedinherited

Data valid flag.

◆ DEFAULT_BIAS

static constexpr bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_BIAS { 0 }
staticconstexprinherited

◆ DEFAULT_DATA_VALID

static constexpr dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_DATA_VALID { 0 }
staticconstexprinherited

◆ DEFAULT_FSHIFT

static constexpr fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_FSHIFT { 0 }
staticconstexprinherited

◆ DEFAULT_PHASE

static constexpr phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_PHASE { 0 }
staticconstexprinherited

◆ DEFAULT_SLOPE

static constexpr slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_SLOPE { 1.0 }
staticconstexprinherited

◆ DEFAULT_TIME_OFFSET

static constexpr timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_TIME_OFFSET { 0 }
staticconstexprinherited

◆ fShift

fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::fShift { DEFAULT_FSHIFT }
protectedinherited

fShift is the frequency (in Hz) in the original data that corresponds to 0 Hz in the heterodyned series.

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_8::FrAdcDataImpl::Data::MAX_REF { 2 }
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_8::FrAdcDataImpl::Data::name
protectedinherited

Channel name – must be unique with the frame.

◆ nBits

nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::nBits
protectedinherited

Number of bits in A/D output.

◆ phase

phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::phase { DEFAULT_PHASE }
protectedinherited

Phase (in radian) of hetrodyning signal at start of dataset

◆ sampleRate

sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::sampleRate
protectedinherited

Data acquisition rate, samples/s.

◆ slope

slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::slope { DEFAULT_SLOPE }
protectedinherited

ADC calibration: input units/ct.

◆ struct_desc

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ timeOffset

timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::timeOffset { DEFAULT_TIME_OFFSET }
protectedinherited

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

◆ units

units_type FrameCPP::Version_8::FrAdcDataImpl::Data::units { DEFAULT_UNITS( ) }
protectedinherited

ADC calibration: input units for slope.


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