Event data. More...

#include <FrAdcData.hh>

Inheritance diagram for FrameCPP::Version_9::FrAdcData:

Collaboration diagram for FrameCPP::Version_9::FrAdcData:

Public Types
typedef boost::shared_ptr< FrAdcData >	subset_ret_type

typedef boost::shared_ptr< FrAdcData >	subset_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 }

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

typedef FR_ADC_DATA_NAME_TYPE	name_type

typedef FR_ADC_DATA_COMMENT_TYPE	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 FR_ADC_DATA_UNITS_TYPE	units_type

typedef FR_ADC_DATA_SAMPLE_RATE_TYPE	sampleRate_type

typedef FR_ADC_DATA_TIME_OFFSET_TYPE	timeOffset_type

typedef FR_ADC_DATA_F_SHIFT_TYPE	fShift_type

typedef FR_ADC_DATA_PHASE_TYPE	phase_type

typedef FR_ADC_DATA_DATA_VALID_TYPE	dataValid_type

typedef Common::Container< FrVect >	data_type

typedef data_type::const_iterator	const_iterator

typedef data_type::iterator	iterator

typedef Common::Container< FrVect >	aux_type

typedef aux_type::const_iterator	const_aux_iterator

typedef aux_type::iterator	aux_iterator

typedef const char *const	struct_name_type

typedef const char *const	struct_desc_type

typedef INT_2U const	struct_id_type

typedef INT_4U	timeOffsetS_v4_type

typedef INT_4S	timeOffsetS_v3_type

typedef INT_4U	timeOffsetN_v3_type

typedef INT_4U	crate_v3_type

typedef INT_4U	channel_v3_type

typedef INT_2U	overRange_v3_type

Public Member Functions
	FrAdcData ()
	Default constructor.

	FrAdcData (const name_type &Name, channelGroup_type ChannelGroup, channelNumber_type ChannelNumber, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias=Data::DEFAULT_BIAS, slope_type Slope=Data::DEFAULT_SLOPE, const units_type &Units=Data::DEFAULT_UNITS(), fShift_type FShift=Data::DEFAULT_FSHIFT, timeOffset_type TimeOffset=Data::DEFAULT_TIME_OFFSET, dataValid_type DataValid=Data::DEFAULT_DATA_VALID, phase_type Phase=Data::DEFAULT_PHASE)
	Constructor.

	FrAdcData (Previous::FrAdcData &Source, stream_base_type *Stream)
	Promotion Constructor.

const name_type &	GetNameSlow () const
	Retrieve the name of the FrAdcData struture.

FrAdcData &	Merge (const FrAdcData &RHS)
	Merge with another FrAdcData.

subset_ret_type	Subset (REAL_8 Offset, REAL_8 Dt) const
	Request a subset of the data.

bool	operator== (const FrAdcData &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	equality operator for abstract data type

	FrAdcData ()
	Default constructor.

	FrAdcData (const name_type &Name, channelGroup_type ChannelGroup, channelNumber_type ChannelNumber, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias=Data::DEFAULT_BIAS, slope_type Slope=Data::DEFAULT_SLOPE, const units_type &Units=Data::DEFAULT_UNITS(), fShift_type FShift=Data::DEFAULT_FSHIFT, timeOffset_type TimeOffset=Data::DEFAULT_TIME_OFFSET, dataValid_type DataValid=Data::DEFAULT_DATA_VALID, phase_type Phase=Data::DEFAULT_PHASE)
	Constructor.

	FrAdcData (Previous::FrAdcData &Source, stream_base_type *Stream)
	Promotion Constructor.

const name_type &	GetNameSlow () const
	Retrieve the name of the FrAdcData struture.

FrAdcData &	Merge (const FrAdcData &RHS)
	Merge with another FrAdcData.

subset_ret_type	Subset (REAL_8 Offset, REAL_8 Dt) const
	Request a subset of the data.

bool	operator== (const FrAdcData &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	equality operator for abstract data type

virtual const char *	ObjectStructName () const
	The name structure name of this object.

virtual const char *	ObjectStructName () const
	The name structure name of this object.

virtual const Common::Description *	GetDescription (ostream_type &Stream) const
	The data structure description.

virtual const Common::Description *	GetDescription (ostream_type &Stream) const
	The data structure description.

void	TOCQuery (int InfoClass,...) const

void	TOCQuery (int InfoClass,...) const

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

const name_type &	GetName () const
	Return the name associate with the FrAdcData structure.

const comment_type &	GetComment () const
	A brief description of the FrAdcData structure.

channelGroup_type	GetChannelGroup () const
	The channel group for the FrAdcData.

channelNumber_type	GetChannelNumber () const
	The channel number for the FrAdcData.

nBits_type	GetNBits () const
	Tne number of bits in the A/D output.

bias_type	GetBias () const
	DC bias on channel.

slope_type	GetSlope () const
	ADC calibration units per count.

const units_type &	GetUnits () const
	The units used in the ADC calibration.

sampleRate_type	GetSampleRate () const
	The data acquisition rate.

timeOffset_type	GetTimeOffset () const
	The offset of the first sample relative to the frame start time.

fShift_type	GetFShift () const
	The frequency in the original data corresponding to 0 Hz.

phase_type	GetPhase () const
	Phase of hetrodyning signal at start of dataset.

dataValid_type	GetDataValid () const
	Retrieve the overRange value.

const aux_type &	RefAux () const
	Identifier for vector for user-provided information.

aux_type &	RefAux ()
	Identifier for vector for user-provided information.

const data_type &	RefData () const
	Identifier for vector of sampled data.

data_type &	RefData ()
	Identifier for vector of sampled data.

void	AppendComment (const std::string &comment)
	Extend the comment associated with the FrAdcData structure.

void	SetDataValid (dataValid_type flag)
	Establish the value of the dataValid field.

void	SetBias (bias_type bias)
	Establish the value of the bias field.

void	SetChannelGroup (channelGroup_type Value)
	Establish the value of the channelGroup field.

void	SetChannelNumber (channelNumber_type Value)
	Establish the value of the channelNumber field.

void	SetComment (const comment_type &Value)
	Set the comment associated with the FrAdcData structure.

void	SetNBits (nBits_type Value)
	Tne number of bits in the A/D output.

void	SetSampleRate (sampleRate_type Value)
	Establish the value of the sampleRate field.

void	SetSlope (slope_type slope)
	Establish the value of the slope field.

void	SetTimeOffset (timeOffset_type Value)
	Establish the value of the timeOffset field.

bool	operator== (Data const &RHS) const

bool	operator== (FrAdcData const &RHS) const

Static Public Member Functions
static const Common::Description *	StructDescription ()
	The description of structure.

static const Common::Description *	StructDescription ()
	The description of structure.

static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
	Promote previous version of object to this version.

static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
	Promote previous version of object to this version.

template<class T>
static int	DataType (const T *Data)

template<class T>
static int	DataType (const T &Data)

template<class T>
static int	DataType (const T *Data)

template<class T>
static int	DataType (const T &Data)

static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.

static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.

static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

static const units_type &	DEFAULT_UNITS ()

static struct_name_type	FrameSpecName ()

static struct_name_type	StructName ()

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 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 demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Down grade an object.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

virtual self_type *	pCreate (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	pCreate (istream_type &Stream) const
	Virtual constructor.

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream.

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream.

virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.

virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.

void	incrementTimeOffset (timeOffset_type Value)

void	setName (const name_type &Value)

Protected Attributes
name_type	name
	Channel name – must be unique with the frame.

comment_type	comment
	Comment.

channelGroup_type	channelGroup
	Channel grouping number containing ADC.

channelNumber_type	channelNumber
	Channel nubmer.

nBits_type	nBits
	Number of bits in A/D output.

bias_type	bias { DEFAULT_BIAS }
	DC bias on channel (Units @ ADC counts = 0)

slope_type	slope { DEFAULT_SLOPE }
	ADC calibration: input units/ct.

units_type	units { DEFAULT_UNITS( ) }
	ADC calibration: input units for slope.

sampleRate_type	sampleRate
	Data acquisition rate, samples/s.

timeOffset_type	timeOffset { DEFAULT_TIME_OFFSET }
	Offset of 1st sample relative to the frame start time.

fShift_type	fShift { DEFAULT_FSHIFT }

phase_type	phase { DEFAULT_PHASE }

dataValid_type	dataValid { DEFAULT_DATA_VALID }
	Data valid flag.

data_type	data
	Identifier for vector of sampled data.

aux_type	aux

Static Protected Attributes
static constexpr unsigned int	MAX_REF { 2 }

Private Types
typedef STRING	io_name_type

typedef STRING	io_name_type

typedef STRING	io_comment_type

typedef STRING	io_comment_type

typedef STRING	io_units_type

typedef STRING	io_units_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >	object_base_type

Private Member Functions
virtual Object *	Create () const

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

virtual Object *	Create () const

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

Private Attributes
ChecksumType	m_chkSum
	Structure checksum.

Detailed Description

Event data.

Member Typedef Documentation

◆ aux_iterator

typedef aux_type::iterator FrameCPP::Version_9::FrAdcDataImpl::Data::aux_iterator

inherited

◆ aux_type

typedef Common::Container< FrVect > FrameCPP::Version_9::FrAdcDataImpl::Data::aux_type

inherited

◆ bias_type

typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::bias_type

inherited

◆ channel_v3_type

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

inherited

◆ channelGroup_type

typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::channelGroup_type

inherited

◆ channelNumber_type

typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::channelNumber_type

inherited

◆ comment_type

typedef FR_ADC_DATA_COMMENT_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::comment_type

inherited

◆ const_aux_iterator

typedef aux_type::const_iterator FrameCPP::Version_9::FrAdcDataImpl::Data::const_aux_iterator

inherited

◆ const_iterator

typedef data_type::const_iterator FrameCPP::Version_9::FrAdcDataImpl::Data::const_iterator

inherited

◆ crate_v3_type

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

inherited

◆ data_type

typedef Common::Container< FrVect > FrameCPP::Version_9::FrAdcDataImpl::Data::data_type

inherited

◆ dataValid_type

typedef FR_ADC_DATA_DATA_VALID_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::dataValid_type

inherited

◆ fShift_type

typedef FR_ADC_DATA_F_SHIFT_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::fShift_type

inherited

◆ io_comment_type [1/2]

typedef STRING FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::io_comment_type

privateinherited

◆ io_comment_type [2/2]

typedef STRING FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::io_comment_type

privateinherited

◆ io_name_type [1/2]

typedef STRING FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::io_name_type

privateinherited

◆ io_name_type [2/2]

typedef STRING FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::io_name_type

privateinherited

◆ io_units_type [1/2]

typedef STRING FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::io_units_type

privateinherited

◆ io_units_type [2/2]

typedef STRING FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::io_units_type

privateinherited

◆ 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

typedef data_type::iterator FrameCPP::Version_9::FrAdcDataImpl::Data::iterator

inherited

◆ name_type

typedef FR_ADC_DATA_NAME_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::name_type

inherited

◆ nBits_type

typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::nBits_type

inherited

◆ object_base_type [1/3]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ object_base_type [2/3]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ object_base_type [3/3]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ 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

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

inherited

◆ phase_type

typedef FR_ADC_DATA_PHASE_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::phase_type

inherited

◆ sampleRate_type

typedef FR_ADC_DATA_SAMPLE_RATE_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::sampleRate_type

inherited

◆ 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

typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::slope_type

inherited

◆ 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

template<typename Object_T>

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

inherited

◆ struct_id_type

template<typename Object_T>

typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type

inherited

◆ struct_name_type

template<typename Object_T>

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

inherited

◆ subset_ret_type [1/2]

typedef boost::shared_ptr< FrAdcData > FrameCPP::Version_9::FrAdcData::subset_ret_type

◆ subset_ret_type [2/2]

typedef boost::shared_ptr< FrAdcData > FrameCPP::Version_9::FrAdcData::subset_ret_type

◆ timeOffset_type

typedef FR_ADC_DATA_TIME_OFFSET_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::timeOffset_type

inherited

◆ timeOffsetN_v3_type

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

inherited

◆ timeOffsetS_v3_type

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

inherited

◆ timeOffsetS_v4_type

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

inherited

◆ units_type

typedef FR_ADC_DATA_UNITS_TYPE FrameCPP::Version_9::FrAdcDataImpl::Data::units_type

inherited

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

◆ FrAdcData() [1/6]

FrameCPP::Version_9::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [2/6]

FrameCPP::Version_9::FrAdcData::FrAdcData	(	const name_type &	Name,
		channelGroup_type	ChannelGroup,
		channelNumber_type	ChannelNumber,
		nBits_type	NBits,
		sampleRate_type	SampleRate,
		bias_type	Bias = Data::DEFAULT_BIAS,
		slope_type	Slope = Data::DEFAULT_SLOPE,
		const units_type &	Units = Data::DEFAULT_UNITS(),
		fShift_type	FShift = Data::DEFAULT_FSHIFT,
		timeOffset_type	TimeOffset = Data::DEFAULT_TIME_OFFSET,
		dataValid_type	DataValid = Data::DEFAULT_DATA_VALID,
		phase_type	Phase = Data::DEFAULT_PHASE )

Constructor.

Parameters

[in]	Name	The Channel name – must be unique within the frame
[in]	ChannelGroup	Channel grouping number containing ADC.
[in]	ChannelNumber	Channel number.
[in]	NBits	Number of bits in A/D output.
[in]	Bias	DC bias on channel (Units ADC counts = 0)
[in]	Slope	ADC calibration: input units/count.
[in]	Units	ADC calibration: input units for slope.
[in]	SampleRate	Data acquistion rate, samples/s.
[in]	FShift	The frequency (in Hz) in the origional data that oorresponds to 0 Hz in the heterodyned series.
[in]	TimeOffset	Offset of the first sample relative to the frame start time (seconds). Must be positive and smaller than the frame length.
[in]	DataValid	Data valid flag.
[in]	Phase	Phase of heterodyning signal at start of dataset.

Returns: A new instance of the object.

◆ FrAdcData() [3/6]

FrameCPP::Version_9::FrAdcData::FrAdcData	(	Previous::FrAdcData &	Source,
		stream_base_type *	Stream )

Promotion Constructor.

Parameters

[in]	Source	An FrAdcData structure from a previous frame specification.
[in]	Stream	The stream from which the earliest version of the FrAdcData structure was read.

Returns: A new instance of the object.

◆ FrAdcData() [4/6]

FrameCPP::Version_9::FrAdcData::FrAdcData ( )

Default constructor.

◆ FrAdcData() [5/6]

FrameCPP::Version_9::FrAdcData::FrAdcData	(	const name_type &	Name,
		channelGroup_type	ChannelGroup,
		channelNumber_type	ChannelNumber,
		nBits_type	NBits,
		sampleRate_type	SampleRate,
		bias_type	Bias = Data::DEFAULT_BIAS,
		slope_type	Slope = Data::DEFAULT_SLOPE,
		const units_type &	Units = Data::DEFAULT_UNITS(),
		fShift_type	FShift = Data::DEFAULT_FSHIFT,
		timeOffset_type	TimeOffset = Data::DEFAULT_TIME_OFFSET,
		dataValid_type	DataValid = Data::DEFAULT_DATA_VALID,
		phase_type	Phase = Data::DEFAULT_PHASE )

Constructor.

Parameters

[in]	Name	The Channel name – must be unique within the frame
[in]	ChannelGroup	Channel grouping number containing ADC.
[in]	ChannelNumber	Channel number.
[in]	NBits	Number of bits in A/D output.
[in]	Bias	DC bias on channel (Units ADC counts = 0)
[in]	Slope	ADC calibration: input units/count.
[in]	Units	ADC calibration: input units for slope.
[in]	SampleRate	Data acquistion rate, samples/s.
[in]	FShift	The frequency (in Hz) in the origional data that oorresponds to 0 Hz in the heterodyned series.
[in]	TimeOffset	Offset of the first sample relative to the frame start time (seconds). Must be positive and smaller than the frame length.
[in]	DataValid	Data valid flag.
[in]	Phase	Phase of heterodyning signal at start of dataset.

Returns: A new instance of the object.

◆ FrAdcData() [6/6]

FrameCPP::Version_9::FrAdcData::FrAdcData	(	Previous::FrAdcData &	Source,
		stream_base_type *	Stream )

Promotion Constructor.

Parameters

[in]	Source	An FrAdcData structure from a previous frame specification.
[in]	Stream	The stream from which the earliest version of the FrAdcData structure was read.

Returns: A new instance of the object.

Member Function Documentation

◆ AppendComment()

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

inlineinherited

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] Stream Stream 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] Stream Stream 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

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>

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

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ 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] Stream The 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] Stream The 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()

const Data::units_type & FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_UNITS ( )

inlinestaticinherited

◆ demote() [1/2]

virtual demote_ret_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		demote_stream_type *	Stream ) const

inlineprotectedvirtualinherited

Down grade an object.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		demote_stream_type *	Stream ) const

inlineprotectedvirtualinherited

Down grade an object.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

◆ FrameSpecDescription()

template<typename Object_T>

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

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T>

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

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T>

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

inlinestaticinherited

◆ GetBias()

Data::bias_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetBias ( ) const

inlineinherited

DC bias on channel.

Returns: DC bias on channel.

◆ GetChannelGroup()

Data::channelGroup_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetChannelGroup ( ) const

inlineinherited

The channel group for the FrAdcData.

Returns: The crate number for the FrAdcData

◆ GetChannelNumber()

Data::channelNumber_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetChannelNumber ( ) const

inlineinherited

The channel number for the FrAdcData.

Returns: The channel number for the FrAdcData

◆ GetComment()

const Data::comment_type & FrameCPP::Version_9::FrAdcDataImpl::Data::GetComment ( ) const

inlineinherited

A brief description of the FrAdcData structure.

Returns: A brief description of the FrAdcData structure

◆ GetDataValid()

Data::dataValid_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetDataValid ( ) const

inlineinherited

Retrieve the overRange value.

Returns: The value of the overRange field.

◆ GetDescription() [1/2]

virtual const Common::Description * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::GetDescription ( ostream_type & Stream ) const

inlinevirtualinherited

The data structure description.

Returns: The description of the data structure used to represent this object when written to a GWF stream

◆ GetDescription() [2/2]

virtual const Common::Description * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::GetDescription ( ostream_type & Stream ) const

inlinevirtualinherited

The data structure description.

Returns: The description of the data structure used to represent this object when written to a GWF stream

◆ GetFShift()

Data::fShift_type FrameCPP::Version_9::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.

◆ GetName()

const Data::name_type & FrameCPP::Version_9::FrAdcDataImpl::Data::GetName ( ) const

inlineinherited

Return the name associate with the FrAdcData structure.

Returns: The name associated with the FrAdcData structure

◆ GetNameSlow() [1/2]

const name_type & FrameCPP::Version_9::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_9::FrAdcData::GetNameSlow ( ) const

Retrieve the name of the FrAdcData struture.

◆ GetNBits()

Data::nBits_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetNBits ( ) const

inlineinherited

Tne number of bits in the A/D output.

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

◆ GetPhase()

Data::phase_type FrameCPP::Version_9::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.

◆ GetSampleRate()

Data::sampleRate_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetSampleRate ( ) const

inlineinherited

The data acquisition rate.

Returns: The data acquisition rate.

◆ GetSlope()

Data::slope_type FrameCPP::Version_9::FrAdcDataImpl::Data::GetSlope ( ) const

inlineinherited

ADC calibration units per count.

Returns: ADC calibration units per count.

◆ GetTimeOffset()

Data::timeOffset_type FrameCPP::Version_9::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.

◆ GetUnits()

const Data::units_type & FrameCPP::Version_9::FrAdcDataImpl::Data::GetUnits ( ) const

inlineinherited

The units used in the ADC calibration.

Returns: The units used in the ADC calibration

◆ incrementTimeOffset()

void FrameCPP::Version_9::FrAdcDataImpl::Data::incrementTimeOffset ( timeOffset_type Value )

inlineprotectedinherited

◆ Merge() [1/2]

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

Merge with another FrAdcData.

Parameters

[in] RHS The source of the information to append to this FrAdcData structure.

Returns: A reference to this object

◆ Merge() [2/2]

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

Merge with another FrAdcData.

Parameters

[in] RHS The source of the information to append to this FrAdcData structure.

Returns: A reference to this object

◆ ObjectStructName() [1/2]

virtual const char * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::ObjectStructName ( ) const

inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::ObjectStructName ( ) const

inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/6]

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

inlineinherited

◆ operator==() [2/6]

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

virtual

equality operator for abstract data type

Parameters

[in] Obj The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/6]

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

virtual

equality operator for abstract data type

Parameters

[in] Obj The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/6]

bool FrameCPP::Version_9::FrAdcData::operator== ( const FrAdcData & RHS ) const

inline

equality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [5/6]

bool FrameCPP::Version_9::FrAdcData::operator== ( const FrAdcData & RHS ) const

equality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [6/6]

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

inlineinherited

◆ pBytes() [1/2]

cmn_streamsize_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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]

cmn_streamsize_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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]

virtual self_type * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: The newly allocated object.

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

◆ pCreate() [2/2]

virtual self_type * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: The newly allocated object.

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

◆ Promote() [1/2]

static promote_ret_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

inlinestaticinherited

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrAdcData based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

inlinestaticinherited

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns: A new instance of FrAdcData based on Obj

◆ promote() [1/2]

virtual promote_ret_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		promote_stream_type *	Stream ) const

inlineprotectedvirtualinherited

Upgrade an object.

Parameters

[in]	Target	The version of the frame specification to promote too.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of this class.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		promote_stream_type *	Stream ) const

inlineprotectedvirtualinherited

Upgrade an object.

Parameters

[in]	Target	The version of the frame specification to promote too.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of this class.

◆ pWrite() [1/2]

virtual void FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ RefAux() [1/2]

Data::aux_type & FrameCPP::Version_9::FrAdcDataImpl::Data::RefAux ( )

inlineinherited

Identifier for vector for user-provided information.

Returns: A reference to the user-provided information.

◆ RefAux() [2/2]

const Data::aux_type & FrameCPP::Version_9::FrAdcDataImpl::Data::RefAux ( ) const

inlineinherited

Identifier for vector for user-provided information.

Returns: A constant reference to the user-provided information.

◆ RefData() [1/2]

Data::data_type & FrameCPP::Version_9::FrAdcDataImpl::Data::RefData ( )

inlineinherited

Identifier for vector of sampled data.

Returns: A reference to the sampled data.

◆ RefData() [2/2]

const Data::data_type & FrameCPP::Version_9::FrAdcDataImpl::Data::RefData ( ) const

inlineinherited

Identifier for vector of sampled data.

Returns: A constant reference to the sampled data.

◆ SetBias()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetBias ( bias_type bias )

inlineinherited

Establish the value of the bias field.

Parameters

[in] bias The desired value of the bias field.

◆ SetChannelGroup()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type Value )

inlineinherited

Establish the value of the channelGroup field.

Parameters

[in] Value The desired value of the channelGroup field.

◆ SetChannelNumber()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type Value )

inlineinherited

Establish the value of the channelNumber field.

Parameters

[in] Value The desired value of the channelNumber field.

◆ SetComment()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetComment ( const comment_type & Value )

inlineinherited

Set the comment associated with the FrAdcData structure.

Parameters

[in] Value The desired value for the comment field.

◆ SetDataValid()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetDataValid ( dataValid_type flag )

inlineinherited

Establish the value of the dataValid field.

Parameters

[in] flag The desired value of the overRange field.

◆ setName()

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

inlineprotectedinherited

◆ SetNBits()

void FrameCPP::Version_9::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.

◆ SetSampleRate()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type Value )

inlineinherited

Establish the value of the sampleRate field.

Parameters

[in] Value The desired value of the sampleRate field.

◆ SetSlope()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetSlope ( slope_type slope )

inlineinherited

Establish the value of the slope field.

Parameters

[in] slope The desired value of the slope field.

◆ SetTimeOffset()

void FrameCPP::Version_9::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type Value )

inlineinherited

Establish the value of the timeOffset field.

Parameters

[in] Value The value for the timeOffset field.

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::StructDescription ( )

inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::StructDescription ( )

inlinestaticinherited

The description of structure.

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

◆ StructName()

template<typename Object_T>

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

inlinestaticinherited

◆ Subset() [1/2]

subset_ret_type FrameCPP::Version_9::FrAdcData::Subset	(	REAL_8	Offset,
		REAL_8	Dt ) const

Request a subset of the data.

Parameters

[in]	Offset	The number of seconds from the start of the FrAdcData object from which to start extracting data.
[in]	Dt	The number of seconds of data in the resulting FrAdcData strucutre.

Returns: A FrAdcData structure which contains Dt seconds of data starting at Offset of this FrAdcData structure.

◆ Subset() [2/2]

subset_ret_type FrameCPP::Version_9::FrAdcData::Subset	(	REAL_8	Offset,
		REAL_8	Dt ) const

Request a subset of the data.

Parameters

[in]	Offset	The number of seconds from the start of the FrAdcData object from which to start extracting data.
[in]	Dt	The number of seconds of data in the resulting FrAdcData strucutre.

Returns: A FrAdcData structure which contains Dt seconds of data starting at Offset of this FrAdcData structure.

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

virtual void FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::vTOCQuery	(	int	InfoClass,
		va_list	vl ) const

protectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >::vTOCQuery	(	int	InfoClass,
		va_list	vl ) const

protectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable 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_9::FrAdcDataImpl::Data::aux

protectedinherited

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

◆ bias

bias_type FrameCPP::Version_9::FrAdcDataImpl::Data::bias { DEFAULT_BIAS }

protectedinherited

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

◆ channelGroup

channelGroup_type FrameCPP::Version_9::FrAdcDataImpl::Data::channelGroup

protectedinherited

Channel grouping number containing ADC.

◆ channelNumber

channelNumber_type FrameCPP::Version_9::FrAdcDataImpl::Data::channelNumber

protectedinherited

Channel nubmer.

◆ comment

comment_type FrameCPP::Version_9::FrAdcDataImpl::Data::comment

protectedinherited

Comment.

◆ data

data_type FrameCPP::Version_9::FrAdcDataImpl::Data::data

protectedinherited

Identifier for vector of sampled data.

◆ dataValid

dataValid_type FrameCPP::Version_9::FrAdcDataImpl::Data::dataValid { DEFAULT_DATA_VALID }

protectedinherited

Data valid flag.

◆ DEFAULT_BIAS

static constexpr bias_type FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_BIAS { 0 }

staticconstexprinherited

◆ DEFAULT_DATA_VALID

static constexpr dataValid_type FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_DATA_VALID { 0 }

staticconstexprinherited

◆ DEFAULT_FSHIFT

static constexpr fShift_type FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_FSHIFT { 0 }

staticconstexprinherited

◆ DEFAULT_PHASE

static constexpr phase_type FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_PHASE { 0 }

staticconstexprinherited

◆ DEFAULT_SLOPE

static constexpr slope_type FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_SLOPE { 1.0 }

staticconstexprinherited

◆ DEFAULT_TIME_OFFSET

static constexpr timeOffset_type FrameCPP::Version_9::FrAdcDataImpl::Data::DEFAULT_TIME_OFFSET { 0 }

staticconstexprinherited

◆ fShift

fShift_type FrameCPP::Version_9::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_9::FrAdcDataImpl::Data::MAX_REF { 2 }

staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_9::FrAdcDataImpl::Data::name

protectedinherited

Channel name – must be unique with the frame.

◆ nBits

nBits_type FrameCPP::Version_9::FrAdcDataImpl::Data::nBits

protectedinherited

Number of bits in A/D output.

◆ phase

phase_type FrameCPP::Version_9::FrAdcDataImpl::Data::phase { DEFAULT_PHASE }

protectedinherited

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

◆ sampleRate

sampleRate_type FrameCPP::Version_9::FrAdcDataImpl::Data::sampleRate

protectedinherited

Data acquisition rate, samples/s.

◆ slope

slope_type FrameCPP::Version_9::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_9::FrAdcDataImpl::Data::timeOffset { DEFAULT_TIME_OFFSET }

protectedinherited

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

◆ units

units_type FrameCPP::Version_9::FrAdcDataImpl::Data::units { DEFAULT_UNITS( ) }

protectedinherited

ADC calibration: input units for slope.

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/FrAdcData.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrAdcData.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ aux_iterator

◆ aux_type

◆ bias_type

◆ channel_v3_type

◆ channelGroup_type

◆ channelNumber_type

◆ comment_type

◆ const_aux_iterator

◆ const_iterator

◆ crate_v3_type

◆ data_type

◆ dataValid_type

◆ fShift_type

◆ io_comment_type [1/2]

◆ io_comment_type [2/2]

◆ io_name_type [1/2]

◆ io_name_type [2/2]

◆ io_units_type [1/2]

◆ io_units_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ iterator

◆ name_type

◆ nBits_type

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ ostream_type [1/2]

◆ ostream_type [2/2]

◆ overRange_v3_type

◆ phase_type

◆ sampleRate_type

◆ self_type [1/2]

◆ self_type [2/2]

◆ slope_type

◆ string_2_type [1/2]

◆ string_2_type [2/2]

◆ struct_desc_type

◆ struct_id_type

◆ struct_name_type

◆ subset_ret_type [1/2]

◆ subset_ret_type [2/2]

◆ timeOffset_type

◆ timeOffsetN_v3_type

◆ timeOffsetS_v3_type

◆ timeOffsetS_v4_type

◆ units_type

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FrAdcData() [1/6]

◆ FrAdcData() [2/6]

◆ FrAdcData() [3/6]

◆ FrAdcData() [4/6]

◆ FrAdcData() [5/6]

◆ FrAdcData() [6/6]

Member Function Documentation

◆ AppendComment()

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ CheckSumDataClass() [1/2]

◆ CheckSumDataClass() [2/2]

◆ CheckSumDataComment() [1/2]

◆ CheckSumDataComment() [2/2]

◆ Create() [1/6]