ADTF  3.18.3
adtf::streaming::testing::penguin Namespace Reference

Namespace for all testing functionality of the ADTF Streaming SDK provided since v3.15. More...

Classes

class  cDisconnector
 Utility class that can be used to disconnect a pin via RAII. More...
 

Functions

tResult connect_pins (const adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &pSource, const char *strOutputPin, const adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &pDestination, const char *strInputPin, bool bSync=true)
 Connect the given output pin with the given input pin. More...
 
std::vector< std::string > discover_trigger_pipe_call_path (const ucom::ant::iobject_ptr< const streaming::ant::ITriggerPipeSource > &pItem)
 Retrieves a vector of trigger pipe item names in order of call. More...
 
std::vector< std::string > discover_trigger_item_call_path (const ucom::ant::iobject_ptr< const ucom::ant::IObject > &pObject, const char *strPinOrRunnerName)
 Retrieves a vector of trigger pipe item names in order of call for a Pin or Runner of a object. More...
 
std::vector< std::string > discover_trigger_item_call_path (const ucom::ant::iobject_ptr< ucom::ant::IObject > &pObject, const char *strPinOrRunnerName)
 Retrieves a vector of trigger pipe item names in order of call for a Pin or Runner of a object. More...
 

Detailed Description

Namespace for all testing functionality of the ADTF Streaming SDK provided since v3.15.

Function Documentation

◆ connect_pins()

tResult adtf::streaming::testing::penguin::connect_pins ( const adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &  pSource,
const char *  strOutputPin,
const adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &  pDestination,
const char *  strInputPin,
bool  bSync = true 
)

Connect the given output pin with the given input pin.

This will create a sample stream when neccessary.

Parameters
[in]pSourceThe source object.
[in]strOutputPinThe output pin.
[in]pDestinationThe destination object.
[in]strInputPinThe input pin.
[in]bSyncWhether or not to connect the pins with a trigger pipe.
Returns
Standard result.

◆ discover_trigger_item_call_path() [1/2]

std::vector<std::string> adtf::streaming::testing::penguin::discover_trigger_item_call_path ( const ucom::ant::iobject_ptr< const ucom::ant::IObject > &  pObject,
const char *  strPinOrRunnerName 
)

Retrieves a vector of trigger pipe item names in order of call for a Pin or Runner of a object.

Warning
The ancensors may form a tree, this function will only return a single path out of all possible ones.
Parameters
pObjectThe filter or sample stream source
strPinOrRunnerNamethe pin name or runner name
Returns
std::vector<std::string> The trigger item names in order of call
Exceptions
tResultif strPinOrRunnerName was not found

◆ discover_trigger_item_call_path() [2/2]

std::vector<std::string> adtf::streaming::testing::penguin::discover_trigger_item_call_path ( const ucom::ant::iobject_ptr< ucom::ant::IObject > &  pObject,
const char *  strPinOrRunnerName 
)

Retrieves a vector of trigger pipe item names in order of call for a Pin or Runner of a object.

Warning
The ancensors may form a tree, this function will only return a single path out of all possible ones.
Parameters
pObjectThe filter or sample stream source
strPinOrRunnerNamethe pin name or runner name
Returns
std::vector<std::string> The trigger item names in order of call
Exceptions
tResultif strPinOrRunnerName was not found

◆ discover_trigger_pipe_call_path()

std::vector<std::string> adtf::streaming::testing::penguin::discover_trigger_pipe_call_path ( const ucom::ant::iobject_ptr< const streaming::ant::ITriggerPipeSource > &  pItem)

Retrieves a vector of trigger pipe item names in order of call.

Warning
The ancensors may form a tree, this function will only return a single path out of all possible ones.
Parameters
pItemthe trigger item source to discover
Returns
std::vector<std::string> The trigger item names in order of call