adtf::filter::interface_client< Interface > Class Template Reference

#include <graph_object.h>

Public Member Functions
	interface_client ()=default
	default constructor that initializes the object to an invalid state.
	interface_client (const ucom::ant::iobject_ptr< streaming::ant::IBindingClient > &pClient)
	interface_client (const interface_client &)=default
	interface_client (interface_client &&)=default
interface_client &	operator= (const interface_client &)=default
interface_client &	operator= (interface_client &&)=default
bool	IsValid ()
Interface &	Get () const
Interface *	operator-> () const

Detailed Description

template<typename Interface>
class adtf::filter::interface_client< Interface >

Helper class that wraps a streaming::ant::IBindingClient. See cGraphObject::CreateInterfaceClient.

Example Usage

#include <adtffiltersdk/adtf_filtersdk.h>
 
class IMyInterface: public adtf::ucom::IObject
{
    public:
        ADTF_IID(IMyInterface, "my_interface.iid");
 
    public:
        virtual void DoSomething() = 0;
};
 
class cMyFilter: public adtf::filter::cFilter
{
    public:
        ADTF_CLASS_ID_NAME(cMyFilter, "my_filter.filter.example.cid", "My Filter");
 
        cMyFilter()
        {
            m_oInterfaceClient = CreateInterfaceClient<IMyInterface>("my_interface");
            CreateRunner("do_something");
        }
 
        tResult Process(adtf::base::tNanoSeconds /*tmTrigger*/,
                        adtf::streaming::IRunner* /*pRunner*/) override
        {
            m_oInterfaceClient->DoSomething();
            RETURN_NOERROR;
        }
 
    private:
        adtf::filter::interface_client<IMyInterface> m_oInterfaceClient;
};

Constructor & Destructor Documentation

interface_client()

template<typename Interface>

adtf::filter::interface_client< Interface >::interface_client ( const ucom::ant::iobject_ptr< streaming::ant::IBindingClient > & pClient )

inline

/// initializes the object with an existing binding client.

Parameters

[in]

pClient

The binding client to use.

Member Function Documentation

Get()

template<typename Interface>

Interface & adtf::filter::interface_client< Interface >::Get ( ) const

inline

Returns

A reference to the wrapped interface.

IsValid()

template<typename Interface>

bool adtf::filter::interface_client< Interface >::IsValid ( )

inline

Returns

Whether the client has a valid interface pointer or not.

---

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

• src/libraries/filtersdk/include/adtffiltersdk/graph_object.h