ADTF  3.18.3
IGraphabstract

Defines the Interface used to connect Items to each other. More...

Inheritance diagram for IGraph:
[legend]

Public Member Functions

 ADTF_IID (IGraph, "graph.ant.streaming.adtf.iid")
 definition of interface id
 
virtual tResult GetNamedGraphObject (const char *strName, ucom::ant::iobject_ptr< IObject > &pObject) const =0
 Gets a registered graph object by strName. More...
 
virtual tResult GetNamedGraphObjects (ucom::ant::iobject_list< INamedGraphObject > &lstItems) const =0
 Gets a every registered graph objects. 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...
 

Protected Member Functions

 ~IGraph ()=default
 not desstructable
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Defines the Interface used to connect Items to each other.

The GraphInterface is theory basic.

Definition at line 103 of file graph_intf.h.

Member Function Documentation

◆ GetNamedGraphObject()

virtual tResult GetNamedGraphObject ( const char *  strName,
ucom::ant::iobject_ptr< IObject > &  pObject 
) const
pure virtual

Gets a registered graph object by strName.

(const access)

Parameters
[in]strNameName of the Object looking for.
[out]pObjectObject reference return if found. Will be at least a INamedGraphObject.
See also
sec_filter_graph for information which objects are possible by default.
Returns
Standard Result Code
Return values
ERR_NOT_FOUNDno object found with the name strName.
ERR_NO_INTERFACEThe given iobject_ptr::Reset call refused object.

◆ GetNamedGraphObjects()

virtual tResult GetNamedGraphObjects ( ucom::ant::iobject_list< INamedGraphObject > &  lstItems) const
pure virtual

Gets a every registered graph objects.

(const access only)

Parameters
[in]lstItemsenumeration of object where to put the references to.
Returns
Standard Result Code
See also
sec_filter_graph for information which objects are possible by default.

Referenced by adtf::streaming::hollow::get_graph_objects().