ADTF
IGraphConnectionabstract

Interface to describe a connection within the IGraph. More...

Inheritance diagram for IGraphConnection:
[legend]

Public Member Functions

 ADTF_IID (IGraphConnection, "graphconnection.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult GetSource (ucom::ant::iobject_ptr< INamedGraphObject > &pSource) const =0
 Gets the source object. More...
 
virtual tResult GetSourceName (base::ant::IString &&strName) const =0
 Gets the source object name. More...
 
virtual tResult GetSourceConnectorName (base::ant::IString &&strName) const =0
 Gets the source object name. More...
 
virtual tResult GetDestination (ucom::ant::iobject_ptr< INamedGraphObject > &pDestination) const =0
 Gets the destination object. More...
 
virtual tResult GetDestinationName (base::ant::IString &&strName) const =0
 Gets the destination object name. More...
 
virtual tResult GetDestinationConnectorName (base::ant::IString &&strName) const =0
 Gets the destination object name. More...
 
virtual tResult Connect ()=0
 Establishes the conenction between the source and the destination. More...
 
virtual tResult Disconnect ()=0
 Disconnects the connection between the source and the destination. More...
 
virtual bool IsConnected () const =0
 Return if either the connection is established or not. More...
 
- Public Member Functions inherited from INamedGraphObject
 ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
 defintion of interface id
 
virtual tResult GetName (base::ant::IString &&strName) const =0
 Gets the Name of the object to the IString rvalue reference strName. More...
 
virtual tResult SetName (const char *strName)=0
 Sets the Name of the object. More...
 
virtual tResult SetParent (const ucom::ant::IObject *oParentObject)=0
 Sets the Parent of the object. More...
 
virtual tResult GetParent (const ucom::ant::IObject *&poParentObject) const =0
 Retrieves the Parent of the object. 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

 ~IGraphConnection ()=default
 not destrucable
 
- Protected Member Functions inherited from INamedGraphObject
 ~INamedGraphObject ()=default
 not destructable
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Interface to describe a connection within the IGraph.

Definition at line 23 of file graph_intf.h.

Member Function Documentation

◆ Connect()

virtual tResult Connect ( )
pure virtual

Establishes the conenction between the source and the destination.

See also
sec_filter_graph which connections are possible.
Returns
Standard Result Code - Error depends also on the return value of the connection objects.
Return values
ERR_NOERRORThe connection is established.

◆ Disconnect()

virtual tResult Disconnect ( )
pure virtual

Disconnects the connection between the source and the destination.

Returns
Standard Result Code

◆ GetDestination()

virtual tResult GetDestination ( ucom::ant::iobject_ptr< INamedGraphObject > &  pDestination) const
pure virtual

Gets the destination object.

Parameters
[out]pDestinationThe destination object of the connection.
Returns
Standard Result Code

◆ GetDestinationConnectorName()

virtual tResult GetDestinationConnectorName ( base::ant::IString &&  strName) const
pure virtual

Gets the destination object name.

Parameters
[out]strNameThe destination objects name to return.
Returns
Standard Result Code of adtf::base::IString::Set

◆ GetDestinationName()

virtual tResult GetDestinationName ( base::ant::IString &&  strName) const
pure virtual

Gets the destination object name.

Parameters
[out]strNameThe destination objects name to return.
Returns
Standard Result Code of adtf::base::IString::Set

◆ GetSource()

virtual tResult GetSource ( ucom::ant::iobject_ptr< INamedGraphObject > &  pSource) const
pure virtual

Gets the source object.

Parameters
[out]pSourceThe source object of the connection.
Returns
Standard Result Code

◆ GetSourceConnectorName()

virtual tResult GetSourceConnectorName ( base::ant::IString &&  strName) const
pure virtual

Gets the source object name.

Parameters
[out]strNameThe source objects name to return.
Returns
Standard Result Code of adtf::base::IString::Set

◆ GetSourceName()

virtual tResult GetSourceName ( base::ant::IString &&  strName) const
pure virtual

Gets the source object name.

Parameters
[out]strNameThe source objects name to return.
Returns
Standard Result Code of adtf::base::IString::Set

◆ IsConnected()

virtual bool IsConnected ( ) const
pure virtual

Return if either the connection is established or not.

Return values
trueconnection is established
falseconnection is not established