Reader config

Collaboration diagram for Reader config:

Detailed Description

Classes
struct	IReaderConfig
	An interface providing access to a new reader in order to reuse the invalidated reader's settings and configuration. More...
class	ReaderConfigPtr
	An interface providing access to a new reader in order to reuse the invalidated reader's settings and configuration. More...

Functions
virtual ErrCode INTERFACE_FUNC	getValueTransformFunction (IFunction **transform)=0
	Gets the transform function that will be called with the read value-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step. More...
virtual ErrCode INTERFACE_FUNC	getDomainTransformFunction (IFunction **transform)=0
	Gets the transform function that will be called with the read domain-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step. More...
virtual ErrCode INTERFACE_FUNC	getInputPorts (IList **ports)=0
	Gets the internally created input-ports if used. More...
virtual ErrCode INTERFACE_FUNC	getReadTimeoutType (ReadTimeoutType *timeoutType)=0
	Gets the type of time-out handling used by the reader. More...
virtual ErrCode INTERFACE_FUNC	markAsInvalid ()=0
	Marks the current reader as invalid preventing any additional operations to be performed on the reader except reusing its info and configuration in a new reader.
daq::FunctionPtr	getValueTransformFunction () const
	Gets the transform function that will be called with the read value-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step. More...
daq::FunctionPtr	getDomainTransformFunction () const
	Gets the transform function that will be called with the read domain-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step. More...
daq::ListPtr< daq::IInputPortConfig >	getInputPorts () const
	Gets the internally created input-ports if used. More...
daq::ReadTimeoutType	getReadTimeoutType () const
	Gets the type of time-out handling used by the reader. More...
void	markAsInvalid () const
	Marks the current reader as invalid preventing any additional operations to be performed on the reader except reusing its info and configuration in a new reader.

Function Documentation

getDomainTransformFunction() [1/2]

daq::FunctionPtr getDomainTransformFunction ( ) const

inline

Gets the transform function that will be called with the read domain-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step.

Returns

The function performing the post-processing or nullptr if not assigned.

getDomainTransformFunction() [2/2]

virtual ErrCode INTERFACE_FUNC getDomainTransformFunction ( IFunction **  transform )

pure virtual

Gets the transform function that will be called with the read domain-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step.

Parameters

[out]

transform

The function performing the post-processing or nullptr if not assigned.

getInputPorts() [1/2]

daq::ListPtr<daq::IInputPortConfig> getInputPorts ( ) const

inline

Gets the internally created input-ports if used.

Returns

The internal Input-Ports if used by the reader otherwise nullptr.

getInputPorts() [2/2]

virtual ErrCode INTERFACE_FUNC getInputPorts ( IList **  ports )

pure virtual

Gets the internally created input-ports if used.

Parameters

[out]

ports

The internal Input-Ports if used by the reader otherwise nullptr.

getReadTimeoutType() [1/2]

daq::ReadTimeoutType getReadTimeoutType ( ) const

inline

Gets the type of time-out handling used by the reader.

Returns

How the reader handles time-outs.

getReadTimeoutType() [2/2]

virtual ErrCode INTERFACE_FUNC getReadTimeoutType ( ReadTimeoutType *  timeoutType )

pure virtual

Gets the type of time-out handling used by the reader.

Parameters

[out]

timeoutType

How the reader handles time-outs.

getValueTransformFunction() [1/2]

daq::FunctionPtr getValueTransformFunction ( ) const

inline

Gets the transform function that will be called with the read value-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step.

Returns

The function performing the post-processing or nullptr if not assigned.

getValueTransformFunction() [2/2]

virtual ErrCode INTERFACE_FUNC getValueTransformFunction ( IFunction **  transform )

pure virtual

Gets the transform function that will be called with the read value-data and currently valid Signal-Descriptor giving the user the chance add a custom post-processing step.

Parameters

[out]

transform

The function performing the post-processing or nullptr if not assigned.