Interface defintion for a Streaming Graph. More...

#include <streaming_graph_intf.h>

Inheritance diagram for IStreamingGraph:

Public Types
enum	tStreamingState : uint8_t { State_Constructed = 1 , State_Initialized = 2 , State_Streaming = 3 }
	State Levels for the Streaming Graph as a Top-Level Graph. More...

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

	UCOM_RESOLVE (adtf::ucom::ant::IObject, IGraph)

virtual tResult	SetState (tStreamingState eState)=0
	Sets the state of the Streaming Graph.

virtual tStreamingState	GetState ()=0
	Gets the state of the Streaming Graph.

Public Member Functions inherited from 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
	Gets a registered graph object by `strName`.

virtual tResult	GetNamedGraphObjects (ucom::ant::iobject_list< INamedGraphObject > &lstItems) const =0
	Gets a every registered graph objects.

Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the `IObject` to be castable with the `ucom_cast()`

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`.

virtual tResult	SetName (const char *strName)=0
	Sets the Name of the object.

virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
	Sets the Parent of the object.

virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
	Retrieves the Parent of the object.

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

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

Protected Member Functions inherited from INamedGraphObject
	~INamedGraphObject ()=default
	not destructable

Detailed Description

Interface defintion for a Streaming Graph.

Definition at line 58 of file streaming_graph_intf.h.

Member Enumeration Documentation

◆ tStreamingState

enum tStreamingState : uint8_t

State Levels for the Streaming Graph as a Top-Level 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: section_streaming_graph_state, 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

Definition at line 67 of file streaming_graph_intf.h.

Member Function Documentation

◆ GetState()

virtual tStreamingState GetState ( )

pure virtual

Gets the state of the Streaming Graph.

See also: section_streaming_graph_state

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 SetState ( tStreamingState eState )

pure virtual

Sets the state of the Streaming Graph.

See also: section_streaming_graph_state

Parameters

eState [in] The State to set.

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

Public Types