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

ADC Data Structure Definition. More...

#include <FrAdcData.hh>

Inheritance diagram for FrameCPP::Version_4::FrAdcData:
FrameCPP::Version_4::FrAdcDataNPS FrameCPP::Common::FrameSpec::Object FrameCPP::Common::TOCInfo FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef FrAdcDataNPS nps_type
 
typedef FrAdcDataPS ps_type
 
typedef STRING name_type
 
typedef STRING comment_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef STRING units_type
 
typedef FR_ADC_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIMEOFFSETS_TYPE timeOffsetS_type
 
typedef FR_ADC_DATA_TIMEOFFSETN_TYPE timeOffsetN_type
 
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_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
}
 
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=FR_ADC_DATA_DEFAULT_BIAS, slope_type Slope=FR_ADC_DATA_DEFAULT_SLOPE, const std::string &Units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type FShift=FR_ADC_DATA_DEFAULT_FSHIFT, timeOffsetS_type TimeOffsetS=FR_ADC_DATA_DEFAULT_TIME_OFFSET_S, timeOffsetN_type TimeOffsetN=FR_ADC_DATA_DEFAULT_TIME_OFFSET_N, dataValid_type DataValid=FR_ADC_DATA_DEFAULT_DATA_VALID)
 
 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)
 
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...
 
channelGroup_type GetChannelGroup () const
 The channel group 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...
 
bias_type GetBias () const
 DC bias on channel. More...
 
slope_type GetSlope () const
 ADC calibration units per count. More...
 
STRING GetUnits () const
 The units used in the ADC calibration. More...
 
sampleRate_type GetSampleRate () const
 The data acquisition rate. More...
 
timeOffsetS_type GetTimeOffsetS () const
 The offset of the first sample relative to the frame start time. More...
 
timeOffsetN_type GetTimeOffsetN () const
 The offset of the first sample relative to the frame start time. More...
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz. More...
 
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 SetDataValid (INT_2U flag)
 Establish the value of the dataValid field. More...
 
void SetBias (REAL_4 Value)
 Establish the value of the bias field. More...
 
void SetSlope (REAL_4 Value)
 Establish the value of the slope field. More...
 
void SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
 Establish the value of the timeOffset field. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () 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...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual 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...
 
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 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...
 
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 timeOffsetS_type DEFAULT_TIME_OFFSET_S
 
static const timeOffsetN_type DEFAULT_TIME_OFFSET_N
 
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
 
cmn_streamsize_type bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
void write (Common::OStream &Stream) const
 Write contents to the stream. More...
 
bool operator== (const FrAdcDataNPS &RHS) const
 Comparison operator. 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)
 

Protected 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
 
timeOffsetS_type timeOffsetS
 
timeOffsetN_type timeOffsetN
 
fShift_type fShift
 
dataValid_type dataValid
 

Detailed Description

ADC Data Structure Definition.

Member Typedef Documentation

◆ bias_type

◆ channelGroup_type

◆ channelNumber_type

◆ comment_type

◆ dataValid_type

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ fShift_type

◆ name_type

◆ nBits_type

◆ nps_type

◆ object_type

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

◆ promote_arg_type

◆ promote_ret_type

◆ ps_type

◆ sampleRate_type

◆ slope_type

◆ string_2_type

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

◆ timeOffsetN_type

◆ timeOffsetS_type

◆ unique_object_type

◆ units_type

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 

Constructor & Destructor Documentation

◆ FrAdcData() [1/4]

FrameCPP::Version_4::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [2/4]

FrameCPP::Version_4::FrAdcData::FrAdcData ( const FrAdcData Source)

Copy constructor.

◆ FrAdcData() [3/4]

FrameCPP::Version_4::FrAdcData::FrAdcData ( const std::string &  Name,
channelGroup_type  Group,
channelNumber_type  Channel,
nBits_type  NBits,
sampleRate_type  SampleRate,
bias_type  Bias = FR_ADC_DATA_DEFAULT_BIAS,
slope_type  Slope = FR_ADC_DATA_DEFAULT_SLOPE,
const std::string &  Units = FR_ADC_DATA_DEFAULT_UNITS( ),
fShift_type  FShift = FR_ADC_DATA_DEFAULT_FSHIFT,
timeOffsetS_type  TimeOffsetS = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S,
timeOffsetN_type  TimeOffsetN = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N,
dataValid_type  DataValid = FR_ADC_DATA_DEFAULT_DATA_VALID 
)

◆ FrAdcData() [4/4]

FrameCPP::Version_4::FrAdcData::FrAdcData ( Previous::FrAdcData &  Source,
istream_type Stream 
)

◆ ~FrAdcData()

FrameCPP::Version_4::FrAdcData::~FrAdcData ( )

Member Function Documentation

◆ AppendComment()

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

Extend the comment associated with the FrAdcData structure.

◆ Bytes()

FrameCPP::cmn_streamsize_type FrameCPP::Version_4::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()

cmn_streamsize_type 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.

◆ Clone()

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

◆ Create() [1/3]

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

constructor - virtual

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

◆ Create() [2/3]

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

◆ Create() [3/3]

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

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ DataType() [1/2]

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

◆ DataType() [2/2]

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

◆ demote()

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

Down grade an object.

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

◆ DemoteObject()

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.

◆ GetBias()

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

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup()

FrAdcDataNPS::channelGroup_type FrAdcDataNPS::GetChannelGroup ( ) const
inlineinherited

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber()

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

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetComment()

const std::string & FrAdcDataNPS::GetComment ( ) const
inlineinherited

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid()

INT_2U FrAdcDataNPS::GetDataValid ( ) const
inlineinherited

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDescription()

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.

◆ GetFShift()

FrAdcDataNPS::fShift_type 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.

◆ GetName()

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

◆ GetNBits()

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

Tne number of bits in the A/D output.

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

◆ GetSampleRate()

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope()

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffsetN()

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

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

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

◆ GetTimeOffsetS()

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

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

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

◆ GetUnits()

STRING FrAdcDataNPS::GetUnits ( ) const
inlineinherited

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ Merge()

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

◆ ObjectStructName()

const char * FrameCPP::Version_4::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!=()

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

◆ operator==() [1/3]

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

◆ operator==() [2/3]

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

comparison operator

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

◆ operator==() [3/3]

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

Comparison operator.

◆ Promote()

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

◆ promote()

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

Upgrade an object.

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

◆ PromoteObject() [1/3]

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/3]

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/3]

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()

void FrAdcDataNPS::SetBias ( REAL_4  Value)
inlineinherited

Establish the value of the bias field.

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

◆ SetDataValid()

void FrAdcDataNPS::SetDataValid ( INT_2U  flag)
inlineinherited

Establish the value of the dataValid field.

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

◆ SetSlope()

void FrAdcDataNPS::SetSlope ( REAL_4  Value)
inlineinherited

Establish the value of the slope field.

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

◆ SetTimeOffset()

void FrAdcDataNPS::SetTimeOffset ( INT_4U  Seconds,
INT_4U  Nanoseconds 
)
inlineinherited

Establish the value of the timeOffset field.

Parameters
[in]SecondsThe value for the timeOffsetS field.
[in]NanosecondsThe value for the timeOffsetN field.

◆ StructDescription()

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

◆ structDescription()

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

◆ StructName()

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

◆ TOCQuery()

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

◆ VerifyObject()

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

◆ vTOCQuery()

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

◆ Write()

void FrameCPP::Version_4::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()

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

Write contents to the stream.

◆ WriteNext()

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_4::FrAdcDataNPS::bias
protectedinherited

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

◆ channelGroup

channelGroup_type FrameCPP::Version_4::FrAdcDataNPS::channelGroup
protectedinherited

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_4::FrAdcDataNPS::channelNumber
protectedinherited

Channel number

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

◆ comment

comment_type FrameCPP::Version_4::FrAdcDataNPS::comment
protectedinherited

Comment for the ADC.

◆ dataValid

dataValid_type FrameCPP::Version_4::FrAdcDataNPS::dataValid
protectedinherited

Data valid flag

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

◆ DEFAULT_BIAS

const FrAdcDataNPS::bias_type FrAdcDataNPS::DEFAULT_BIAS
staticinherited
Initial value:

◆ DEFAULT_DATA_VALID

const FrAdcDataNPS::dataValid_type FrAdcDataNPS::DEFAULT_DATA_VALID
staticinherited

◆ DEFAULT_FSHIFT

const FrAdcDataNPS::fShift_type FrAdcDataNPS::DEFAULT_FSHIFT
staticinherited
Initial value:

◆ DEFAULT_SLOPE

const FrAdcDataNPS::slope_type FrAdcDataNPS::DEFAULT_SLOPE
staticinherited
Initial value:

◆ DEFAULT_TIME_OFFSET_N

const FrAdcDataNPS::timeOffsetN_type FrAdcDataNPS::DEFAULT_TIME_OFFSET_N
staticinherited

◆ DEFAULT_TIME_OFFSET_S

const FrAdcDataNPS::timeOffsetS_type FrAdcDataNPS::DEFAULT_TIME_OFFSET_S
staticinherited

◆ fShift

fShift_type FrameCPP::Version_4::FrAdcDataNPS::fShift
protectedinherited

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

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

◆ name

name_type FrameCPP::Version_4::FrAdcDataNPS::name
protectedinherited

Channel name – must be unique with the frame

◆ nBits

nBits_type FrameCPP::Version_4::FrAdcDataNPS::nBits
protectedinherited

Number of bits in A/D output.

◆ sampleRate

sampleRate_type FrameCPP::Version_4::FrAdcDataNPS::sampleRate
protectedinherited

Data acquisition rate, samples per second.

◆ slope

slope_type FrameCPP::Version_4::FrAdcDataNPS::slope
protectedinherited

ADC calibration: input units/count.

◆ timeOffsetN

timeOffsetN_type FrameCPP::Version_4::FrAdcDataNPS::timeOffsetN
protectedinherited

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

◆ timeOffsetS

timeOffsetS_type FrameCPP::Version_4::FrAdcDataNPS::timeOffsetS
protectedinherited

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

◆ units

units_type FrameCPP::Version_4::FrAdcDataNPS::units
protectedinherited

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


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