MultiReaderBuilderPtr Class Reference

Builder component of Multi reader objects. Contains setter methods to configure the Multi reader parameters and a build method that builds the Unit object. More...

Inherits ObjectPtr< IMultiReaderBuilder >.

Detailed Description

Builder component of Multi reader objects. Contains setter methods to configure the Multi reader parameters and a build method that builds the Unit object.

Public Member Functions
daq::MultiReaderPtr	build () const
	Builds and returns a Multi reader object using the currently set values of the Builder. More...
MultiReaderBuilderPtr	addSignal (const daq::SignalPtr &signal) const
	Adds the signal to list in multi reader. More...
MultiReaderBuilderPtr	addInputPort (const daq::InputPortPtr &port) const
	Adds the input port to list in multi reader. More...
daq::ListPtr< daq::IComponent >	getSourceComponents () const
	Gets the list of input ports. More...
MultiReaderBuilderPtr	setValueReadType (daq::SampleType type) const
	Sets the value signal read type. More...
daq::SampleType	getValueReadType () const
	Gets the value signal read type. More...
MultiReaderBuilderPtr	setDomainReadType (daq::SampleType type) const
	Sets the domain signal read type. More...
daq::SampleType	getDomainReadType () const
	Gets the domain signal read type. More...
MultiReaderBuilderPtr	setReadMode (daq::ReadMode mode) const
	Sets the read mode (Unscaled, Scaled, RawValue) More...
daq::ReadMode	getReadMode () const
	Gets the read mode (Unscaled, Scaled, RawValue) More...
MultiReaderBuilderPtr	setReadTimeoutType (daq::ReadTimeoutType type) const
	Sets the read timeout mode. More...
daq::ReadTimeoutType	getReadTimeoutType () const
	Gets the read timeout mode. More...
MultiReaderBuilderPtr	setRequiredCommonSampleRate (daq::Int sampleRate) const
	Sets the required common sample rate. More...
daq::Int	getRequiredCommonSampleRate () const
	Gets the required common sample rate. More...
MultiReaderBuilderPtr	setStartOnFullUnitOfDomain (daq::Bool enabled) const
	Sets the start on full unit of domain. More...
daq::Bool	getStartOnFullUnitOfDomain () const
	Gets the start on full unit of domain. More...
MultiReaderBuilderPtr	setMinReadCount (daq::SizeT minReadCount) const
	Sets the minimal number of samples to read. More...
daq::SizeT	getMinReadCount () const
	Gets the minimal number of samples to read. More...

Member Function Documentation

addInputPort()

MultiReaderBuilderPtr addInputPort ( const daq::InputPortPtr &  port ) const

inline

Adds the input port to list in multi reader.

Parameters

port	The input port which will be handled in multi reader

addSignal()

MultiReaderBuilderPtr addSignal ( const daq::SignalPtr &  signal ) const

inline

Adds the signal to list in multi reader.

Parameters

signal

The signal which will be handled in multi reader

build()

daq::MultiReaderPtr build ( ) const

inline

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

Returns

The built Multi reader.

getDomainReadType()

daq::SampleType getDomainReadType ( ) const

inline

Gets the domain signal read type.

Returns

The domain signal read type

getMinReadCount()

daq::SizeT getMinReadCount ( ) const

inline

Gets the minimal number of samples to read.

Returns

The minimal number of samples to read.

If set, the reader will return 0 for getAvailableCount if less than minReadCount samples are available. It will also never read less than minReadCount samples. The default value is 1.

getReadMode()

daq::ReadMode getReadMode ( ) const

inline

Gets the read mode (Unscaled, Scaled, RawValue)

Returns

The read mode

getReadTimeoutType()

daq::ReadTimeoutType getReadTimeoutType ( ) const

inline

Gets the read timeout mode.

Returns

The timeout mode. * if "Any" returns immediately if there is available data otherwise time-out is exceeded. * if "All" waiting until timeout and returns available data if existing. otherwise time-out is exceeded.

getRequiredCommonSampleRate()

daq::Int getRequiredCommonSampleRate ( ) const

inline

Gets the required common sample rate.

Returns

The required common sample rate

getSourceComponents()

daq::ListPtr<daq::IComponent> getSourceComponents ( ) const

inline

Gets the list of input ports.

Returns

The list of input ports

getStartOnFullUnitOfDomain()

daq::Bool getStartOnFullUnitOfDomain ( ) const

inline

Gets the start on full unit of domain.

Returns

enable/disable start on full unit of domain

getValueReadType()

daq::SampleType getValueReadType ( ) const

inline

Gets the value signal read type.

Returns

The value signal read type

setDomainReadType()

MultiReaderBuilderPtr setDomainReadType ( daq::SampleType  type ) const

inline

Sets the domain signal read type.

Parameters

type	The domain signal read type

setMinReadCount()

MultiReaderBuilderPtr setMinReadCount ( daq::SizeT  minReadCount ) const

inline

Sets the minimal number of samples to read.

Parameters

minReadCount

The minimal number of samples to read.

If set, the reader will return 0 for getAvailableCount if less than minReadCount samples are available. It will also never read less than minReadCount samples. The default value is 1.

setReadMode()

MultiReaderBuilderPtr setReadMode ( daq::ReadMode  mode ) const

inline

Sets the read mode (Unscaled, Scaled, RawValue)

Parameters

mode	The read mode

setReadTimeoutType()

MultiReaderBuilderPtr setReadTimeoutType ( daq::ReadTimeoutType  type ) const

inline

Sets the read timeout mode.

Parameters

type	The timeout mode. if "Any" returns immediately if there is available data otherwise time-out is exceeded. if "All" waiting until timeout and returns available data if existing. otherwise time-out is exceeded.

setRequiredCommonSampleRate()

MultiReaderBuilderPtr setRequiredCommonSampleRate ( daq::Int  sampleRate ) const

inline

Sets the required common sample rate.

Parameters

sampleRate

The required common sample rate

setStartOnFullUnitOfDomain()

MultiReaderBuilderPtr setStartOnFullUnitOfDomain ( daq::Bool  enabled ) const

inline

Sets the start on full unit of domain.

Parameters

enabled

enable/disable start on full unit of domain

setValueReadType()

MultiReaderBuilderPtr setValueReadType ( daq::SampleType  type ) const

inline

Sets the value signal read type.

Parameters

type	The value signal read type