#include <streaming_graph_intf.h>

Inherits adtf::streaming::ant::IGraph, and adtf::streaming::ant::INamedGraphObject.

Public Types
enum	tStreamingState : uint8_t { State_Constructed = 1 , State_Initialized = 2 , State_Streaming = 3 }
	State Levels for the streaming graph. More...

Public Member Functions
	ADTF_IID (IStreamingGraph, "streaming_graph.ant.streaming.adtf.iid")
	definiton of interface id

virtual tResult	SetState (tStreamingState eState)=0

virtual tStreamingState	GetState ()=0

Public Member Functions inherited from adtf::streaming::ant::IGraph
	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

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

Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

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

Additional Inherited Members
Protected Member Functions inherited from adtf::streaming::ant::IGraph
	~IGraph ()=default
	not desstructable

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

Protected Member Functions inherited from adtf::streaming::ant::INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Detailed Description

Interface defintion for a streaming graph.

Member Enumeration Documentation

◆ tStreamingState

enum adtf::streaming::ant::IStreamingGraph::tStreamingState : uint8_t

State Levels for the streaming graph.

Enumerator

State_Constructed

Constructed state. The Streaming Graph is ready to add objects These objects will be constructed immediately while the IGraph::AddNamedGraphObject() call.

See also: IGraph::AddNamedGraphObject()

State_Initialized

Initialized state Every data connection is established. The sources and sinks are ready to stream.

See also: subsection_streaming_graph_init_method

State_Streaming

Streaming state Usually all source and sink streaming data

See also: subsection_streaming_graph_start_streaming_method

Member Function Documentation

◆ GetState()

virtual tStreamingState adtf::streaming::ant::IStreamingGraph::GetState ( )

pure virtual

Gets the state of the Streaming Graph.

Returns: The state currently valid.

Remarks: The current state will be returned with the right value only if a state change was successfully completed.

◆ SetState()

virtual tResult adtf::streaming::ant::IStreamingGraph::SetState ( tStreamingState eState )

pure virtual

Sets the state of the Streaming Graph.

Parameters

eState [in] The State to set.

Returns: Standard result code which depends also on errors occures within sink and source implementations.

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

src/libraries/streaming3/include/adtfstreaming3/streaming_graph_intf.h

Public Types