ADTF  3.13.0
cInterfaceBinding

Default IInterfaceBinding implementation. More...

Inheritance diagram for cInterfaceBinding:
[legend]

Public Member Functions

 cInterfaceBinding ()
 CTOR.
 
virtual ~cInterfaceBinding ()
 DTOR.
 
tResult GetBindingObjects (ucom::ant::iobject_list< IBindingObject > &lstBindingObject)
 Return a list of all Binding Objects on lstBindingObject. More...
 
tResult GetBindingObjects (ucom::ant::iobject_list< const IBindingObject > &lstBindingObject) const
 Return a list of all Binding Objects on lstBindingObject. More...
 
tResult FindBindingObject (const tChar *strName, ucom::ant::iobject_ptr< const ucom::ant::IObject > &pIBindingObject) const
 This Function will search a binding object with the given strName and return it on pIBindingObject. More...
 
tResult FindBindingObject (const tChar *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pIBindingObject)
 This Function will search a binding object with the given strName and return it on pIBindingObject. More...
 
virtual tResult RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingObject > &pBindingObject)
 RegisterBindingObject will register the given pBindingObject within the internal registry. More...
 
tResult RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingServer > &pBindingServer)
 Registers the given pBindingServer. More...
 
tResult RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingClient > &pBindingClient)
 Registers the given pBindingClient. More...
 
tResult UnregisterBindingObject (const ucom::ant::iobject_ptr< const IBindingObject > &pBindingObject)
 Unregisters the given pBindingObject. More...
 
tResult Unbind ()
 Will Unbind (IBindingObject::Unbind ) every registered binding objects registered with RegisterBindingObject. More...
 
tResult ReleaseBindingObjects ()
 ReleaseBindingObjects will Unbind (IBindingObject::Unbind ) every registered binding objects registered with RegisterBindingObject and unregister them automatically. More...
 

Private Member Functions

 A_UTILS_D (cInterfaceBinding)
 D Pointer Implementation for private members.
 

Detailed Description

Default IInterfaceBinding implementation.

Definition at line 22 of file interface_binding.h.

Member Function Documentation

◆ FindBindingObject() [1/2]

tResult FindBindingObject ( const tChar strName,
ucom::ant::iobject_ptr< const ucom::ant::IObject > &  pIBindingObject 
) const

This Function will search a binding object with the given strName and return it on pIBindingObject.

Parameters
[in]strNameName to search for. ( see IBindingObject::GetName ).
[out]pIBindingObjectobject refernce to the binding object if succeeded.
Returns
Standard Result Code.

Referenced by interface_binding< Interface >::FindBindingObject().

◆ FindBindingObject() [2/2]

tResult FindBindingObject ( const tChar strName,
ucom::ant::iobject_ptr< ucom::ant::IObject > &  pIBindingObject 
)

This Function will search a binding object with the given strName and return it on pIBindingObject.

Parameters
[in]strNameName to search for. ( see IBindingObject::GetName ).
[out]pIBindingObjectobject refernce to the binding object if succeeded.
Returns
Standard Result Code.

◆ GetBindingObjects() [1/2]

tResult GetBindingObjects ( ucom::ant::iobject_list< IBindingObject > &  lstBindingObject)

Return a list of all Binding Objects on lstBindingObject.

Parameters
[out]lstBindingObjectobject list to push the binding objects to.
Returns
Standard Result Code.

Referenced by interface_binding< Interface >::GetBindingObjects().

◆ GetBindingObjects() [2/2]

tResult GetBindingObjects ( ucom::ant::iobject_list< const IBindingObject > &  lstBindingObject) const

Return a list of all Binding Objects on lstBindingObject.

Parameters
[out]lstBindingObjectobject list to push the binding objects to.
Returns
Standard Result Code.

◆ RegisterBindingObject() [1/3]

virtual tResult RegisterBindingObject ( const ucom::ant::iobject_ptr< IBindingObject > &  pBindingObject)
virtual

RegisterBindingObject will register the given pBindingObject within the internal registry.

Parameters
[in]pBindingObjectThe binding object to register.
Returns
Standard Result Code.
Return values
ERR_NOERRORNo Error.
ERR_UNEXPECTEDInternal Error occurred.
ERR_POINTERpBindingObject is invalid.
ERR_INVALID_ARGCan not register a Object with the same name twice.

Referenced by cGraphObject::CreateInterfaceClient(), and cGraphObject::CreateInterfaceServer().

◆ RegisterBindingObject() [2/3]

tResult RegisterBindingObject ( const ucom::ant::iobject_ptr< IBindingServer > &  pBindingServer)

Registers the given pBindingServer.

Parameters
[in]pBindingServerThe binding server to register.
Returns
see return values of RegisterBindingObject(IBindingObject).

◆ RegisterBindingObject() [3/3]

tResult RegisterBindingObject ( const ucom::ant::iobject_ptr< IBindingClient > &  pBindingClient)

Registers the given pBindingClient.

Parameters
[in]pBindingClientThe binding client to register.
Returns
see return values of RegisterBindingObject(IBindingObject).

◆ ReleaseBindingObjects()

tResult ReleaseBindingObjects ( )

ReleaseBindingObjects will Unbind (IBindingObject::Unbind ) every registered binding objects registered with RegisterBindingObject and unregister them automatically.

Returns
Standard Result Code.
Return values
ERR_NOERRORNo Error.
ERR_POINTERInternal Error.

◆ Unbind()

tResult Unbind ( )

Will Unbind (IBindingObject::Unbind ) every registered binding objects registered with RegisterBindingObject.

Returns
Standard Result Code.
Standard Result Code.
Return values
ERR_NOERRORNo Error.
ERR_POINTERInternal Error.

◆ UnregisterBindingObject()

tResult UnregisterBindingObject ( const ucom::ant::iobject_ptr< const IBindingObject > &  pBindingObject)

Unregisters the given pBindingObject.

Parameters
[in]pBindingObjectThe binding object to unregister.
Returns
Standard Result Code.
Return values
ERR_NOERRORNo Error.
ERR_UNEXPECTEDInternal Error occurred.
ERR_POINTERpBindingObject is invalid.
ERR_NOT_FOUNDThe given pBindingObject not found in registry.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Sep 28 2021 by doxygen 1.8.14)