openDAQ
Open data acquisition platform
BlockReaderBuilderPtr Class Reference

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

Inherits ObjectPtr< IBlockReaderBuilder >.

Detailed Description

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

Public Member Functions

daq::BlockReaderPtr build () const
 Builds and returns a Block reader object using the currently set values of the Builder. More...
 
BlockReaderBuilderPtr setOldBlockReader (const daq::BlockReaderPtr &blockReader) const
 Sets old block reader instance to copy from. More...
 
daq::BlockReaderPtr getOldBlockReader () const
 Gets the old Block reader instance to copy from. More...
 
BlockReaderBuilderPtr setSignal (const daq::SignalPtr &signal) const
 Sets the signal to block reader. More...
 
daq::SignalPtr getSignal () const
 Gets the signal. More...
 
BlockReaderBuilderPtr setInputPort (const daq::InputPortPtr &port) const
 Sets the input port to block reader. More...
 
daq::InputPortPtr getInputPort () const
 Gets the input port. More...
 
BlockReaderBuilderPtr setValueReadType (daq::SampleType type) const
 Sets the value signal read type. More...
 
daq::SampleType getValueReadType () const
 Gets the value signal read type. More...
 
BlockReaderBuilderPtr setDomainReadType (daq::SampleType type) const
 Sets the domain signal read type. More...
 
daq::SampleType getDomainReadType () const
 Gets the domain signal read type. More...
 
BlockReaderBuilderPtr 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...
 
BlockReaderBuilderPtr setBlockSize (daq::SizeT size) const
 Sets the block size. More...
 
daq::SizeT getBlockSize () const
 Gets the block size. More...
 
BlockReaderBuilderPtr setOverlap (daq::SizeT overlap) const
 Sets the overlap. More...
 
daq::SizeT getOverlap () const
 Gets the overlap. More...
 
BlockReaderBuilderPtr setSkipEvents (daq::Bool skipEvents) const
 Sets the skip events. More...
 
daq::Bool getSkipEvents () const
 Gets the skip events. More...
 

Member Function Documentation

◆ build()

daq::BlockReaderPtr build ( ) const
inline

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

Returns
The built Block reader.

◆ getBlockSize()

daq::SizeT getBlockSize ( ) const
inline

Gets the block size.

Parameters
[out]modeThe block size

◆ 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 block reader

◆ getOldBlockReader()

daq::BlockReaderPtr getOldBlockReader ( ) const
inline

Gets the old Block reader instance to copy from.

Returns
The old Block reader instance

◆ getOverlap()

daq::SizeT getOverlap ( ) const
inline

Gets the overlap.

Parameters
[out]modeThe overlap[

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

◆ setBlockSize()

BlockReaderBuilderPtr setBlockSize ( daq::SizeT  size) const
inline

Sets the block size.

Parameters
modeThe block size

◆ setDomainReadType()

BlockReaderBuilderPtr setDomainReadType ( daq::SampleType  type) const
inline

Sets the domain signal read type.

Parameters
typeThe domain signal read type

◆ setInputPort()

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

Sets the input port to block reader.

Parameters
portThe input port which will be handled in block reader

◆ setOldBlockReader()

BlockReaderBuilderPtr setOldBlockReader ( const daq::BlockReaderPtr &  blockReader) const
inline

Sets old block reader instance to copy from.

Parameters
blockReaderThe old Block reader instance

◆ setOverlap()

BlockReaderBuilderPtr setOverlap ( daq::SizeT  overlap) const
inline

Sets the overlap.

Parameters
modeThe overlap

◆ setReadMode()

BlockReaderBuilderPtr setReadMode ( daq::ReadMode  mode) const
inline

Sets the read mode (Unscaled, Scaled, RawValue)

Parameters
modeThe read mode

◆ setSignal()

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

Sets the signal to block reader.

Parameters
signalThe signal which will be handled in block reader

◆ setSkipEvents()

BlockReaderBuilderPtr setSkipEvents ( daq::Bool  skipEvents) const
inline

Sets the skip events.

Parameters
skipEventsThe skip events

◆ setValueReadType()

BlockReaderBuilderPtr setValueReadType ( daq::SampleType  type) const
inline

Sets the value signal read type.

Parameters
typeThe value signal read type