adtf::streaming::ant::IGraphConnection Class Reference

#include <graph_intf.h>

Inherits adtf::streaming::ant::INamedGraphObject.

Inherited by adtf::streaming::ant::IFilterGraphConnection.

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
virtual tResult	GetSourceName (base::ant::IString &&strName) const =0
virtual tResult	GetSourceConnectorName (base::ant::IString &&strName) const =0
virtual tResult	GetDestination (ucom::ant::iobject_ptr< INamedGraphObject > &pDestination) const =0
virtual tResult	GetDestinationName (base::ant::IString &&strName) const =0
virtual tResult	GetDestinationConnectorName (base::ant::IString &&strName) const =0
virtual tResult	Connect ()=0
virtual tResult	Disconnect ()=0
virtual bool	IsConnected () const =0
Public Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetName (base::ant::IString &&strName) const =0
virtual tResult	SetName (const char *strName)=0
virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IGraphConnection ()=default
	not destrucable
Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	~INamedGraphObject ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Interface to describe a connection within the IGraph.

Member Function Documentation

Connect()

virtual tResult adtf::streaming::ant::IGraphConnection::Connect ( )

pure virtual

Establishes the conenction between the source and the destination.

Returns

Standard Result Code - Error depends also on the return value of the connection objects.

Return values

ERR_NOERROR

The connection is established.

Disconnect()

virtual tResult adtf::streaming::ant::IGraphConnection::Disconnect ( )

pure virtual

Disconnects the connection between the source and the destination.

Returns

Standard Result Code

GetDestination()

virtual tResult adtf::streaming::ant::IGraphConnection::GetDestination ( ucom::ant::iobject_ptr< INamedGraphObject > & pDestination ) const

pure virtual

Gets the destination object.

Parameters

[out]

pDestination

The destination object of the connection.

Returns

Standard Result Code

GetDestinationConnectorName()

virtual tResult adtf::streaming::ant::IGraphConnection::GetDestinationConnectorName ( base::ant::IString && strName ) const

pure virtual

Gets the destination object name.

Parameters

[out]

strName

The destination objects name to return.

Returns

Standard Result Code of adtf::base::IString::Set

GetDestinationName()

virtual tResult adtf::streaming::ant::IGraphConnection::GetDestinationName ( base::ant::IString && strName ) const

pure virtual

Gets the destination object name.

Parameters

[out]

strName

The destination objects name to return.

Returns

Standard Result Code of adtf::base::IString::Set

GetSource()

virtual tResult adtf::streaming::ant::IGraphConnection::GetSource ( ucom::ant::iobject_ptr< INamedGraphObject > & pSource ) const

pure virtual

Gets the source object.

Parameters

[out]

pSource

The source object of the connection.

Returns

Standard Result Code

GetSourceConnectorName()

virtual tResult adtf::streaming::ant::IGraphConnection::GetSourceConnectorName ( base::ant::IString && strName ) const

pure virtual

Gets the source object name.

Parameters

[out]

strName

The source objects name to return.

Returns

Standard Result Code of adtf::base::IString::Set

GetSourceName()

virtual tResult adtf::streaming::ant::IGraphConnection::GetSourceName ( base::ant::IString && strName ) const

pure virtual

Gets the source object name.

Parameters

[out]

strName

The source objects name to return.

Returns

Standard Result Code of adtf::base::IString::Set

IsConnected()

virtual bool adtf::streaming::ant::IGraphConnection::IsConnected ( ) const

pure virtual

Return if either the connection is established or not

Return values

true	connection is established
false	connection is not established

---

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

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