ADTF  3.18.2
data_binding< Interface >

Template class for the default implementation of IDataBinding. More...

Inheritance diagram for data_binding< Interface >:
[legend]

Public Member Functions

tResult GetPins (ucom::ant::iobject_list< IPin > &lstPins) const override
 Returns the current Pins (only const access). More...
 
tResult FindPin (const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pPin) const override
 Find a Pin with the name of strName (only const access) More...
 
- Public Member Functions inherited from object< IDataBinding, IDataBinding >
tResult GetInterface (const char *i_strIID, void *&o_pInterface) override
 Query interfaces on an object. More...
 
tResult GetInterface (const char *i_strIID, const void *&o_pInterface) const override
 Provides const correct interface querying. More...
 
void Destroy () const override
 Destruct and deallocate instantiations of type IObject. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 
- Public Member Functions inherited from cDataBinding
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.
 

Additional Inherited Members

- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from cDataBinding
 cDataBinding ()
 CTOR.
 
virtual ~cDataBinding ()
 DTOR.
 

Detailed Description

template<typename Interface = IDataBinding>
class adtf::streaming::ant::data_binding< Interface >

Template class for the default implementation of IDataBinding.

Template Parameters
InterfaceThe interface derived from IDataBinding can be used as interface parameter to prevent multiple inheritance.

Definition at line 97 of file data_binding.h.

Member Function Documentation

◆ FindPin()

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

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.

Definition at line 106 of file data_binding.h.

References cDataBinding::FindPin().

◆ GetPins()

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

Returns the current Pins (only const access).

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

Definition at line 101 of file data_binding.h.

References cDataBinding::GetPins().