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...

Inheritance diagram for IStreamReaderBuilder:

Collaboration diagram for 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
virtual ErrCode INTERFACE_FUNC	build (IStreamReader **streamReader)=0
	Builds and returns a Stream reader object using the currently set values of the Builder. More...

virtual ErrCode INTERFACE_FUNC	setSignal (ISignal *signal)=0
	Sets the signal to stream reader. More...

virtual ErrCode INTERFACE_FUNC	getSignal (ISignal **signal)=0
	Gets the signal. More...

virtual ErrCode INTERFACE_FUNC	setInputPort (IInputPort *port)=0
	Sets the input port to stream reader. More...

virtual ErrCode INTERFACE_FUNC	getInputPort (IInputPort **port)=0
	Gets the input port. More...

virtual ErrCode INTERFACE_FUNC	setValueReadType (SampleType type)=0
	Sets the value signal read type. More...

virtual ErrCode INTERFACE_FUNC	getValueReadType (SampleType *type)=0
	Gets the value signal read type. More...

virtual ErrCode INTERFACE_FUNC	setDomainReadType (SampleType type)=0
	Sets the domain signal read type. More...

virtual ErrCode INTERFACE_FUNC	getDomainReadType (SampleType *type)=0
	Gets the domain signal read type. More...

virtual ErrCode INTERFACE_FUNC	setReadMode (ReadMode mode)=0
	Sets the read mode (Unscaled, Scaled, RawValue) More...

virtual ErrCode INTERFACE_FUNC	getReadMode (ReadMode *mode)=0
	Gets the read mode (Unscaled, Scaled, RawValue) More...

virtual ErrCode INTERFACE_FUNC	setReadTimeoutType (ReadTimeoutType type)=0
	Sets the read timeout mode. More...

virtual ErrCode INTERFACE_FUNC	getReadTimeoutType (ReadTimeoutType *type)=0
	Gets the read timeout mode. More...

virtual ErrCode INTERFACE_FUNC	setSkipEvents (Bool skipEvents)=0
	Sets the skip events. More...

virtual ErrCode INTERFACE_FUNC	getSkipEvents (Bool *skipEvents)=0
	Gets the skip events. More...

virtual ErrCode INTERFACE_FUNC	setInputPortNotificationMethod (PacketReadyNotification notificationMethod)=0
	Sets the notification method of port created/owned stream reader. The default notification method is SameThread. More...

virtual ErrCode INTERFACE_FUNC	getInputPortNotificationMethod (PacketReadyNotification *notificationMethod)=0
	Gets the notification method of port created/owned stream reader. The default notification method is SameThread. More...

Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...

virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...

virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...

virtual ErrCode INTERFACE_FUNC	equals (IBaseObject other, Bool equal) const =0
	Compares object to another object for equality. More...

virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...

Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...

virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...

virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

◆ build()

virtual ErrCode INTERFACE_FUNC build ( IStreamReader ** streamReader )

pure virtual

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

Parameters

[out] streamReader The built Stream reader.

◆ getDomainReadType()

virtual ErrCode INTERFACE_FUNC getDomainReadType ( SampleType * type )

pure virtual

Gets the domain signal read type.

Parameters

[out] type The domain signal read type

◆ getInputPort()

virtual ErrCode INTERFACE_FUNC getInputPort ( IInputPort ** port )

pure virtual

Gets the input port.

Parameters

port	The input port which will be handled in stream reader

◆ getInputPortNotificationMethod()

virtual ErrCode INTERFACE_FUNC getInputPortNotificationMethod ( PacketReadyNotification * notificationMethod )

pure virtual

Gets the notification method of port created/owned stream reader. The default notification method is SameThread.

Parameters

notificationMethod The notification method to be used. If "None", uses Scheduler for stream reader with signal, and keeps the mode of the input port.

◆ getReadMode()

virtual ErrCode INTERFACE_FUNC getReadMode ( ReadMode * mode )

pure virtual

Gets the read mode (Unscaled, Scaled, RawValue)

Parameters

[out] mode The read mode

◆ getReadTimeoutType()

virtual ErrCode INTERFACE_FUNC getReadTimeoutType ( ReadTimeoutType * type )

pure virtual

Gets 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.

◆ getSignal()

virtual ErrCode INTERFACE_FUNC getSignal ( ISignal ** signal )

pure virtual

Gets the signal.

Parameters

signal The signal which will be handled in stream reader

◆ getSkipEvents()

virtual ErrCode INTERFACE_FUNC getSkipEvents ( Bool * skipEvents )

pure virtual

Gets the skip events.

Parameters

[out] skipEvents The skip events

◆ getValueReadType()

virtual ErrCode INTERFACE_FUNC getValueReadType ( SampleType * type )

pure virtual

Gets the value signal read type.

Parameters

[out] type The value signal read type

◆ setDomainReadType()

virtual ErrCode INTERFACE_FUNC setDomainReadType ( SampleType type )

pure virtual

Sets the domain signal read type.

Parameters

type	The domain signal read type

◆ setInputPort()

virtual ErrCode INTERFACE_FUNC setInputPort ( IInputPort * port )

pure virtual

Sets the input port to stream reader.

Parameters

port	The input port which will be handled in stream reader

◆ setInputPortNotificationMethod()

virtual ErrCode INTERFACE_FUNC setInputPortNotificationMethod ( PacketReadyNotification notificationMethod )

pure virtual

Sets the notification method of port created/owned stream reader. The default notification method is SameThread.

Parameters

notificationMethod The notification method to be used. If "None", uses Scheduler for stream reader with signal, and keeps the mode of the input port.

◆ setReadMode()

virtual ErrCode INTERFACE_FUNC setReadMode ( ReadMode mode )

pure virtual

Sets the read mode (Unscaled, Scaled, RawValue)

Parameters

mode	The read mode

◆ setReadTimeoutType()

virtual ErrCode INTERFACE_FUNC setReadTimeoutType ( ReadTimeoutType type )

pure virtual

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.

◆ setSignal()

virtual ErrCode INTERFACE_FUNC setSignal ( ISignal * signal )

pure virtual

Sets the signal to stream reader.

Parameters

signal The signal which will be handled in stream reader

◆ setSkipEvents()

virtual ErrCode INTERFACE_FUNC setSkipEvents ( Bool skipEvents )

pure virtual

Sets the skip events.

Parameters

skipEvents The skip events

◆ setValueReadType()

virtual ErrCode INTERFACE_FUNC setValueReadType ( SampleType type )

pure virtual

Sets the value signal read type.

Parameters

type	The value signal read type

Detailed Description

Public Member Functions

Member Function Documentation

◆ build()

◆ getDomainReadType()

◆ getInputPort()

◆ getInputPortNotificationMethod()

◆ getReadMode()

◆ getReadTimeoutType()

◆ getSignal()

◆ getSkipEvents()

◆ getValueReadType()

◆ setDomainReadType()

◆ setInputPort()

◆ setInputPortNotificationMethod()

◆ setReadMode()

◆ setReadTimeoutType()

◆ setSignal()

◆ setSkipEvents()

◆ setValueReadType()