adtf::streaming::ant::detail::port_router< T, U > Struct Template Reference

#include <filtergraphport.h>

Classes
struct	tDestination

Public Member Functions
	port_router ()=default
	CTOR.
	~port_router ()
	DTOR.
tResult	ResetFrom (const adtf::ucom::ant::iobject_ptr< T > &pFrom)
tResult	AddTo (const adtf::ucom::ant::iobject_ptr< U > &pTo)
void	RemoveTos ()
tResult	ConnectRouting (const adtf::ucom::ant::iobject_ptr< T > &pFrom, const tDestination &sTo)
tResult	DisconnectRouting (const adtf::ucom::ant::iobject_ptr< T > &pFrom, const tDestination &sTo)
tResult	SetTriggerForwardingFromParent (bool bForwarded)
tResult	SetTriggerForwardingToChild (const adtf::ucom::ant::iobject_ptr< U > &pTo, bool bForwarded)

Public Attributes
adtf::ucom::object_ptr< T >	m_pFrom
	the from reference.
std::vector< tDestination >	m_oTos
	the to references.
bool	m_bTriggerForwardingFromParent = false

Detailed Description

template<typename T, typename U = T>
struct adtf::streaming::ant::detail::port_router< T, U >

Helper template class to route a ISampleStream or a IBindingProxy

Member Function Documentation

AddTo()

template<typename T, typename U = T>

tResult adtf::streaming::ant::detail::port_router< T, U >::AddTo ( const adtf::ucom::ant::iobject_ptr< U > & pTo )

inline

Resets the To Routing.

Parameters

pTo	the to reference.

Returns

Standard Result Code

ConnectRouting()

template<typename T, typename U = T>

tResult adtf::streaming::ant::detail::port_router< T, U >::ConnectRouting ( const adtf::ucom::ant::iobject_ptr< T > & pFrom, const tDestination & sTo )

inline

Connects the Routing.

Parameters

pFrom	the from reference.
sTo	the destination.

Returns

Standard Result Code

DisconnectRouting()

template<typename T, typename U = T>

tResult adtf::streaming::ant::detail::port_router< T, U >::DisconnectRouting ( const adtf::ucom::ant::iobject_ptr< T > & pFrom, const tDestination & sTo )

inline

Disonnects the Routing.

Parameters

pFrom	the from reference.
sTo	the destination.

Returns

Standard Result Code

ResetFrom()

template<typename T, typename U = T>

tResult adtf::streaming::ant::detail::port_router< T, U >::ResetFrom ( const adtf::ucom::ant::iobject_ptr< T > & pFrom )

inline

Resets the From Router.

Parameters

pFrom

the from reference.

Returns

Standard Result Code

SetTriggerForwardingFromParent()

template<typename T, typename U = T>

tResult adtf::streaming::ant::detail::port_router< T, U >::SetTriggerForwardingFromParent ( bool bForwarded )

inline

Enable forwarding of triggers from the parent trigger pipe. Default state of a port is to not forward them. A trigger reaches a child only if both forwarding from the parent and forwarding to the specific child is enabled.

See also

SetTriggerForwardingToChild.

Parameters

[in]

bForwarded

Whether triggers are forwarded or not.

Returns

Standard Result Code.

SetTriggerForwardingToChild()

template<typename T, typename U = T>

tResult adtf::streaming::ant::detail::port_router< T, U >::SetTriggerForwardingToChild ( const adtf::ucom::ant::iobject_ptr< U > & pTo, bool bForwarded )

inline

Enable forwarding of triggers to the given child sample stream and its trigger pipe. Default state of a port is to not forward them. A trigger reaches a child only if both forwarding from the parent and forwarding to the specific child is enabled.

See also

SetTriggerForwardingFromParent.

Parameters

[in]	pSampleStream	The stream the connection leads to.
[in]	bForwarded	Whether triggers are forwarded or not.

Returns

Standard Result Code.

Return values

ERR_NOT_FOUND

The port does not route to pSampleStream.

Member Data Documentation

m_bTriggerForwardingFromParent

template<typename T, typename U = T>

bool adtf::streaming::ant::detail::port_router< T, U >::m_bTriggerForwardingFromParent = false

Whether a trigger reaches the port this routing belongs to, which is the case exactly while the connection leading to it is synchronous,

See also

SetTriggerForwardingFromParent.

---

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

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