ADTF  3.18.2
cDataBinding

The cFilter class implements a basic filter that supports the IFilter and IPinEventSink interfaces. More...

Inheritance diagram for cDataBinding:
[legend]

Public Member Functions

tResult GetPins (ucom::ant::iobject_list< IPin > &lstPins) const
 Returns the current Pins (only const access). More...
 
tResult FindPin (const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pPin) const
 Find a Pin with the name of strName (only const access) More...
 
virtual tResult RegisterPin (const ucom::ant::iobject_ptr< IPin > &pIPin)
 Registers a Pin in a pin list. More...
 
tResult RegisterPin (const ucom::ant::iobject_ptr< IInPin > &pIInPin)
 Registers a InPin in a pin list. More...
 
tResult RegisterPin (const ucom::ant::iobject_ptr< IOutPin > &pIOutPin)
 Registers a InPin in a pin list. More...
 
virtual tResult UnregisterPin (const ucom::ant::iobject_ptr< IPin > &pIPin)
 Unregisters a Pin from the pin list. More...
 
tResult ReleasePins ()
 Unregisters all Pins from the pin list. More...
 
virtual tResult ActivatePins ()
 Activate all pins.
 
virtual tResult DeactivatePins ()
 Deactivate all pins.
 
tResult Disconnect ()
 Disconnect all pins.
 

Protected Member Functions

 cDataBinding ()
 CTOR.
 
virtual ~cDataBinding ()
 DTOR.
 

Private Member Functions

 A_UTILS_D (cDataBinding)
 private d-pointer
 

Detailed Description

The cFilter class implements a basic filter that supports the IFilter and IPinEventSink interfaces.

The cFilter is implemented as a state machine. Which handles the IFilter::SetState call.

Definition at line 24 of file data_binding.h.

Member Function Documentation

◆ FindPin()

tResult FindPin ( const char *  strName,
ucom::ant::iobject_ptr< ucom::ant::IObject > &  pPin 
) const

Find a Pin with the name of strName (only const access)

Parameters
strName[in] Pointer to a string that identifies the pin that searches for. Call the IPin::GetName method to retrieve a pin's identifier.
pPin[out] contains the pin if found.
Returns
Returns a standard result code.
Return values
ERR_NOT_FOUNDPin with the given name strName not found.

Referenced by data_binding< Interface >::FindPin().

◆ GetPins()

tResult GetPins ( ucom::ant::iobject_list< IPin > &  lstPins) const

Returns the current Pins (only const access).

Parameters
[out]lstPinsobject_list where to push the pins to.
Returns
Returns a standard result code.

Referenced by data_binding< Interface >::GetPins().

◆ RegisterPin() [1/3]

tResult RegisterPin ( const ucom::ant::iobject_ptr< IInPin > &  pIInPin)

Registers a InPin in a pin list.

Parameters
pIInPin[in] Pin to register.
Returns
Standard result code.

◆ RegisterPin() [2/3]

tResult RegisterPin ( const ucom::ant::iobject_ptr< IOutPin > &  pIOutPin)

Registers a InPin in a pin list.

Parameters
pIOutPin[in] Pin to register.
Returns
Standard result code.

◆ RegisterPin() [3/3]

virtual tResult RegisterPin ( const ucom::ant::iobject_ptr< IPin > &  pIPin)
virtual

Registers a Pin in a pin list.

Parameters
pIPin[in] Pin to register.
Returns
Standard result code.

◆ ReleasePins()

tResult ReleasePins ( )

Unregisters all Pins from the pin list.

Returns
Standard result code.

◆ UnregisterPin()

virtual tResult UnregisterPin ( const ucom::ant::iobject_ptr< IPin > &  pIPin)
virtual

Unregisters a Pin from the pin list.

Parameters
pIPin[in] Pin to unregister.
Returns
Standard result code.