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

Inheritance diagram for ITailReaderBuilder:

Collaboration diagram for 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
virtual ErrCode INTERFACE_FUNC	build (ITailReader **tailReader)=0
	Builds and returns a Tail reader object using the currently set values of the Builder. More...
virtual ErrCode INTERFACE_FUNC	setSignal (ISignal *signal)=0
	Sets the signal to tail 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 tail 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	setHistorySize (SizeT historySize)=0
	Sets the history size. More...
virtual ErrCode INTERFACE_FUNC	getHistorySize (SizeT *historySize)=0
	Gets the history size. 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...
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 ( ITailReader **  tailReader )

pure virtual

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

Parameters

[out]

tailReader

The built Tail 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

getHistorySize()

virtual ErrCode INTERFACE_FUNC getHistorySize ( SizeT *  historySize )

pure virtual

Gets the history size.

Parameters

[out]

historySize

The history size

getInputPort()

virtual ErrCode INTERFACE_FUNC getInputPort ( IInputPort **  port )

pure virtual

Gets the input port.

Parameters

port	The input port which will be handled in tail reader

getReadMode()

virtual ErrCode INTERFACE_FUNC getReadMode ( ReadMode *  mode )

pure virtual

Gets the read mode (Unscaled, Scaled, RawValue)

Parameters

[out]

mode

The read mode

getSignal()

virtual ErrCode INTERFACE_FUNC getSignal ( ISignal **  signal )

pure virtual

Gets the signal.

Parameters

signal

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

setHistorySize()

virtual ErrCode INTERFACE_FUNC setHistorySize ( SizeT  historySize )

pure virtual

Sets the history size.

Parameters

historySize

The history size

setInputPort()

virtual ErrCode INTERFACE_FUNC setInputPort ( IInputPort *  port )

pure virtual

Sets the input port to tail reader.

Parameters

port	The input port which will be handled in tail reader

setReadMode()

virtual ErrCode INTERFACE_FUNC setReadMode ( ReadMode  mode )

pure virtual

Sets the read mode (Unscaled, Scaled, RawValue)

Parameters

mode	The read mode

setSignal()

virtual ErrCode INTERFACE_FUNC setSignal ( ISignal *  signal )

pure virtual

Sets the signal to tail reader.

Parameters

signal

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