adtf::streaming::ant::cInterfaceBinding Class Reference

#include <interface_binding.h>

Inherited by adtf::filter::cGraphObject, and adtf::streaming::ant::interface_binding< Interface >.

Public Member Functions
	cInterfaceBinding ()
	D Pointer Implementation for private members.
virtual	~cInterfaceBinding ()
tResult	GetBindingObjects (ucom::ant::iobject_list< IBindingObject > &lstBindingObject)
tResult	GetBindingObjects (ucom::ant::iobject_list< const IBindingObject > &lstBindingObject) const
tResult	FindBindingObject (const char *strName, ucom::ant::iobject_ptr< const ucom::ant::IObject > &pIBindingObject) const
tResult	FindBindingObject (const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pIBindingObject)
virtual tResult	RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingObject > &pBindingObject)
tResult	RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingServer > &pBindingServer)
tResult	RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingClient > &pBindingClient)
tResult	UnregisterBindingObject (const ucom::ant::iobject_ptr< const IBindingObject > &pBindingObject)
tResult	Unbind ()
tResult	ReleaseBindingObjects ()

Detailed Description

Default IInterfaceBinding implementation.

Constructor & Destructor Documentation

cInterfaceBinding()

adtf::streaming::ant::cInterfaceBinding::cInterfaceBinding

(

)

D Pointer Implementation for private members.

CTOR.

~cInterfaceBinding()

virtual adtf::streaming::ant::cInterfaceBinding::~cInterfaceBinding ( )

virtual

DTOR.

Member Function Documentation

FindBindingObject() [1/2]

tResult adtf::streaming::ant::cInterfaceBinding::FindBindingObject	(	const char *	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]	strName	Name to search for. ( see IBindingObject::GetName ).
[out]	pIBindingObject	object refernce to the binding object if succeeded.

Returns

Standard Result Code.

FindBindingObject() [2/2]

tResult adtf::streaming::ant::cInterfaceBinding::FindBindingObject	(	const char *	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]	strName	Name to search for. ( see IBindingObject::GetName ).
[out]	pIBindingObject	object refernce to the binding object if succeeded.

Returns

Standard Result Code.

GetBindingObjects() [1/2]

tResult adtf::streaming::ant::cInterfaceBinding::GetBindingObjects

(

ucom::ant::iobject_list< const IBindingObject > &

lstBindingObject

)

const

Return a list of all Binding Objects on lstBindingObject.

Parameters

[out]

lstBindingObject

object list to push the binding objects to.

Returns

Standard Result Code.

GetBindingObjects() [2/2]

tResult adtf::streaming::ant::cInterfaceBinding::GetBindingObjects

(

ucom::ant::iobject_list< IBindingObject > &

lstBindingObject

)

Return a list of all Binding Objects on lstBindingObject.

Parameters

[out]

lstBindingObject

object list to push the binding objects to.

Returns

Standard Result Code.

RegisterBindingObject() [1/3]

tResult adtf::streaming::ant::cInterfaceBinding::RegisterBindingObject

(

const ucom::ant::iobject_ptr< IBindingClient > &

pBindingClient

)

Registers the given pBindingClient.

Parameters

[in]

pBindingClient

The binding client to register.

Returns

see return values of RegisterBindingObject(IBindingObject).

RegisterBindingObject() [2/3]

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

virtual

RegisterBindingObject will register the given pBindingObject within the internal registry.

Parameters

[in]

pBindingObject

The binding object to register.

Returns

Standard Result Code.

Return values

ERR_NOERROR	No Error.
ERR_UNEXPECTED	Internal Error occurred.
ERR_POINTER	pBindingObject is invalid.
ERR_INVALID_ARG	Can not register a Object with the same name twice.

RegisterBindingObject() [3/3]

tResult adtf::streaming::ant::cInterfaceBinding::RegisterBindingObject

(

const ucom::ant::iobject_ptr< IBindingServer > &

pBindingServer

)

Registers the given pBindingServer.

Parameters

[in]

pBindingServer

The binding server to register.

Returns

see return values of RegisterBindingObject(IBindingObject).

ReleaseBindingObjects()

tResult adtf::streaming::ant::cInterfaceBinding::ReleaseBindingObjects

(

)

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

Returns

Standard Result Code.

Return values

ERR_NOERROR	No Error.
ERR_POINTER	Internal Error.

Unbind()

tResult adtf::streaming::ant::cInterfaceBinding::Unbind

(

)

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

Returns

Standard Result Code.

Standard Result Code.

Return values

ERR_NOERROR	No Error.
ERR_POINTER	Internal Error.

UnregisterBindingObject()

tResult adtf::streaming::ant::cInterfaceBinding::UnregisterBindingObject

(

const ucom::ant::iobject_ptr< const IBindingObject > &

pBindingObject

)

Unregisters the given pBindingObject.

Parameters

[in]

pBindingObject

The binding object to unregister.

Returns

Standard Result Code.

Return values

ERR_NOERROR	No Error.
ERR_UNEXPECTED	Internal Error occurred.
ERR_POINTER	pBindingObject is invalid.
ERR_NOT_FOUND	The given pBindingObject not found in registry.

---

The documentation for this class was generated from the following file:

• src/libraries/streaming3/include/adtfstreaming3/interface_binding.h