StreamReaderBuilderPtr Class Reference

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

Inherits ObjectPtr< IStreamReaderBuilder >.

Detailed Description

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

Public Member Functions
daq::StreamReaderPtr	build () const
	Builds and returns a Stream reader object using the currently set values of the Builder. More...
StreamReaderBuilderPtr	setSignal (const daq::SignalPtr &signal) const
	Sets the signal to stream reader. More...
daq::SignalPtr	getSignal () const
	Gets the signal. More...
StreamReaderBuilderPtr	setInputPort (const daq::InputPortPtr &port) const
	Sets the input port to stream reader. More...
daq::InputPortPtr	getInputPort () const
	Gets the input port. More...
StreamReaderBuilderPtr	setValueReadType (daq::SampleType type) const
	Sets the value signal read type. More...
daq::SampleType	getValueReadType () const
	Gets the value signal read type. More...
StreamReaderBuilderPtr	setDomainReadType (daq::SampleType type) const
	Sets the domain signal read type. More...
daq::SampleType	getDomainReadType () const
	Gets the domain signal read type. More...
StreamReaderBuilderPtr	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...
StreamReaderBuilderPtr	setReadTimeoutType (daq::ReadTimeoutType type) const
	Sets the read timeout mode. More...
daq::ReadTimeoutType	getReadTimeoutType () const
	Gets the read timeout mode. More...
StreamReaderBuilderPtr	setSkipEvents (daq::Bool skipEvents) const
	Sets the skip events. More...
daq::Bool	getSkipEvents () const
	Gets the skip events. More...

Member Function Documentation

build()

daq::StreamReaderPtr build ( ) const

inline

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

Returns

The built Stream reader.

getDomainReadType()

daq::SampleType getDomainReadType ( ) const

inline

Gets the domain signal read type.

Returns

The domain signal read type

getInputPort()

daq::InputPortPtr getInputPort ( ) const

inline

Gets the input port.

Returns

The input port which will be handled in stream reader

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.

Parameters

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

getSignal()

daq::SignalPtr getSignal ( ) const

inline

Gets the signal.

Returns

The signal which will be handled in stream reader

getSkipEvents()

daq::Bool getSkipEvents ( ) const

inline

Gets the skip events.

Returns

The skip events

getValueReadType()

daq::SampleType getValueReadType ( ) const

inline

Gets the value signal read type.

Returns

The value signal read type

setDomainReadType()

StreamReaderBuilderPtr setDomainReadType ( daq::SampleType  type ) const

inline

Sets the domain signal read type.

Parameters

type	The domain signal read type

setInputPort()

StreamReaderBuilderPtr setInputPort ( const daq::InputPortPtr &  port ) const

inline

Sets the input port to stream reader.

Parameters

port	The input port which will be handled in stream reader

setReadMode()

StreamReaderBuilderPtr setReadMode ( daq::ReadMode  mode ) const

inline

Sets the read mode (Unscaled, Scaled, RawValue)

Parameters

mode	The read mode

setReadTimeoutType()

StreamReaderBuilderPtr setReadTimeoutType ( daq::ReadTimeoutType  type ) const

inline

Sets the read timeout mode.

Parameters

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

setSignal()

StreamReaderBuilderPtr setSignal ( const daq::SignalPtr &  signal ) const

inline

Sets the signal to stream reader.

Parameters

signal

The signal which will be handled in stream reader

setSkipEvents()

StreamReaderBuilderPtr setSkipEvents ( daq::Bool  skipEvents ) const

inline

Sets the skip events.

Parameters

skipEvents

The skip events

setValueReadType()

StreamReaderBuilderPtr setValueReadType ( daq::SampleType  type ) const

inline

Sets the value signal read type.

Parameters

type	The value signal read type