ScalingBuilderPtr Class Reference

Configuration component of Scaling objects. Contains setter methods that allow for Scaling parameter configuration, and a build method that builds the Scaling object. More...

Inherits ObjectPtr< IScalingBuilder >.

Detailed Description

Configuration component of Scaling objects. Contains setter methods that allow for Scaling parameter configuration, and a build method that builds the Scaling object.

Public Member Functions
daq::ScalingPtr	build () const
	Builds and returns a Scaling object using the currently set values of the Builder. More...
ScalingBuilderPtr	setInputDataType (daq::SampleType type) const
	Sets the scaling's input data type. More...
daq::SampleType	getInputDataType () const
	Gets the scaling's input data type. More...
ScalingBuilderPtr	setOutputDataType (daq::ScaledSampleType type) const
	Sets the scaling's output data type. More...
daq::ScaledSampleType	getOutputDataType () const
	Gets the scaling's output data type. More...
ScalingBuilderPtr	setScalingType (daq::ScalingType type) const
	Sets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated. More...
daq::ScalingType	getScalingType () const
	Gets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated. More...
ScalingBuilderPtr	setParameters (const daq::DictPtr< daq::IString, daq::IBaseObject > &parameters) const
	Gets the list of parameters that are used to calculate the scaling in conjunction with the input data. More...
daq::DictPtr< daq::IString, daq::IBaseObject >	getParameters () const
	Gets the list of parameters that are used to calculate the scaling in conjunction with the input data. More...
ScalingBuilderPtr	addParameter (const daq::StringPtr &name, const daq::BaseObjectPtr &parameter) const
	Adds a string-object pair parameter to the Dictionary of Scaling parameters. More...
ScalingBuilderPtr	removeParameter (const daq::StringPtr &name) const
	Removes the parameter with the given name from the Dictionary of Scaling parameters.

Member Function Documentation

addParameter()

ScalingBuilderPtr addParameter ( const daq::StringPtr &  name, const daq::BaseObjectPtr &  parameter  ) const

inline

Adds a string-object pair parameter to the Dictionary of Scaling parameters.

Parameters

name	The string-type name of the parameter.
parameter	The object-type parameter.

build()

daq::ScalingPtr build ( ) const

inline

Builds and returns a Scaling object using the currently set values of the Builder.

Returns

The built Scaling object.

getInputDataType()

daq::SampleType getInputDataType ( ) const

inline

Gets the scaling's input data type.

Returns

The input data type.

getOutputDataType()

daq::ScaledSampleType getOutputDataType ( ) const

inline

Gets the scaling's output data type.

Returns

The output data type

getParameters()

daq::DictPtr<daq::IString, daq::IBaseObject> getParameters ( ) const

inline

Gets the list of parameters that are used to calculate the scaling in conjunction with the input data.

Returns

The list of parameters. All elements are Number types.

getScalingType()

daq::ScalingType getScalingType ( ) const

inline

Gets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated.

Returns

The type of the scaling.

setInputDataType()

ScalingBuilderPtr setInputDataType ( daq::SampleType  type ) const

inline

Sets the scaling's input data type.

Parameters

type	The input data type.

The input data type corresponds to the raw data passed through the signal path in data packets.

setOutputDataType()

ScalingBuilderPtr setOutputDataType ( daq::ScaledSampleType  type ) const

inline

Sets the scaling's output data type.

Parameters

type	The output data type

The output data type corresponds to the type specified in the value descriptor of a signal, and is the type in which said signal's data should be read in after having the scaling applied to it.

setParameters()

ScalingBuilderPtr setParameters ( const daq::DictPtr< daq::IString, daq::IBaseObject > &  parameters ) const

inline

Gets the list of parameters that are used to calculate the scaling in conjunction with the input data.

Parameters

parameters

The list of parameters. All elements are Number types.

Exceptions

FrozenException

if the object is frozen.

setScalingType()

ScalingBuilderPtr setScalingType ( daq::ScalingType  type ) const

inline

Sets the type of the scaling that determines how the scaling parameters should be interpreted and how the scaling should be calculated.

Parameters

type	The type of the scaling.