openDAQ
Open data acquisition platform
TailReaderBuilderPtr Class Reference

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

Inherits ObjectPtr< ITailReaderBuilder >.

Detailed Description

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

Public Member Functions

daq::TailReaderPtr build () const
 Builds and returns a Tail reader object using the currently set values of the Builder. More...
 
TailReaderBuilderPtr setSignal (const daq::SignalPtr &signal) const
 Sets the signal to tail reader. More...
 
daq::SignalPtr getSignal () const
 Gets the signal. More...
 
TailReaderBuilderPtr setInputPort (const daq::InputPortPtr &port) const
 Sets the input port to tail reader. More...
 
daq::InputPortPtr getInputPort () const
 Gets the input port. More...
 
TailReaderBuilderPtr setValueReadType (daq::SampleType type) const
 Sets the value signal read type. More...
 
daq::SampleType getValueReadType () const
 Gets the value signal read type. More...
 
TailReaderBuilderPtr setDomainReadType (daq::SampleType type) const
 Sets the domain signal read type. More...
 
daq::SampleType getDomainReadType () const
 Gets the domain signal read type. More...
 
TailReaderBuilderPtr 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...
 
TailReaderBuilderPtr setHistorySize (daq::SizeT historySize) const
 Sets the history size. More...
 
daq::SizeT getHistorySize () const
 Gets the history size. More...
 
TailReaderBuilderPtr setSkipEvents (daq::Bool skipEvents) const
 Sets the skip events. More...
 
daq::Bool getSkipEvents () const
 Gets the skip events. More...
 

Member Function Documentation

◆ build()

daq::TailReaderPtr build ( ) const
inline

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

Returns
The built Tail reader.

◆ getDomainReadType()

daq::SampleType getDomainReadType ( ) const
inline

Gets the domain signal read type.

Returns
The domain signal read type

◆ getHistorySize()

daq::SizeT getHistorySize ( ) const
inline

Gets the history size.

Returns
The history size

◆ getInputPort()

daq::InputPortPtr getInputPort ( ) const
inline

Gets the input port.

Returns
The input port which will be handled in tail reader

◆ getReadMode()

daq::ReadMode getReadMode ( ) const
inline

Gets the read mode (Unscaled, Scaled, RawValue)

Returns
The read mode

◆ getSignal()

daq::SignalPtr getSignal ( ) const
inline

Gets the signal.

Returns
The signal which will be handled in tail 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()

TailReaderBuilderPtr setDomainReadType ( daq::SampleType  type) const
inline

Sets the domain signal read type.

Parameters
typeThe domain signal read type

◆ setHistorySize()

TailReaderBuilderPtr setHistorySize ( daq::SizeT  historySize) const
inline

Sets the history size.

Parameters
historySizeThe history size

◆ setInputPort()

TailReaderBuilderPtr setInputPort ( const daq::InputPortPtr &  port) const
inline

Sets the input port to tail reader.

Parameters
portThe input port which will be handled in tail reader

◆ setReadMode()

TailReaderBuilderPtr setReadMode ( daq::ReadMode  mode) const
inline

Sets the read mode (Unscaled, Scaled, RawValue)

Parameters
modeThe read mode

◆ setSignal()

TailReaderBuilderPtr setSignal ( const daq::SignalPtr &  signal) const
inline

Sets the signal to tail reader.

Parameters
signalThe signal which will be handled in tail reader

◆ setSkipEvents()

TailReaderBuilderPtr setSkipEvents ( daq::Bool  skipEvents) const
inline

Sets the skip events.

Parameters
skipEventsThe skip events

◆ setValueReadType()

TailReaderBuilderPtr setValueReadType ( daq::SampleType  type) const
inline

Sets the value signal read type.

Parameters
typeThe value signal read type