adtf::filter::ITriggerConfiguration Class Reference

brings the last ant::ITriggerConfiguration to users space More...

#include <trigger_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::filter::private_implementations::IInternalTriggerConfiguration.

Public Types
enum	tKindOfConfiguration : uint32_t { eDataIn = 0 , eDataOut = 1 , eTimer = 2 , eThread = 3 }
	The kind of trigger configuration to retrieve with ITriggerConfiguration::GetConfiguration. More...

Public Member Functions
	ADTF_IID (ITriggerConfiguration, "triggerconfiguration.ant.streaming.adtf.iid")
	definitoon of interface id
virtual const adtf::base::ant::IConfiguration &	GetConfiguration (tKindOfConfiguration eKind) const=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Static Public Attributes
static constexpr const tChar *const	Prop_IsActive = "is_active"
static constexpr const tChar *const	Prop_DataInTriggered = "data_in_triggered"
static constexpr const tChar *const	Prop_DataOutTrigger = "data_out_trigger"
static constexpr const tChar *const	Prop_TimerPeriodInMicroSec = "timer_period_micro_sec"
static constexpr const tChar *const	Prop_ThreadIsCyclic = "thread_is_cyclic"

Protected Member Functions
	~ITriggerConfiguration ()=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

brings the last ant::ITriggerConfiguration to users space

Internal interface to retrieve the default information a IRunner wants to be configured.

This interface is only used by the cFilter implementation while calling cFilter::RegisterRunner and the corresponding cFilter::ConfigureDataTrigger, cFilter::ConfigureTimeTrigger, cFilter::ConfigureThreadTrigger

See also

create_default_runner

Member Enumeration Documentation

tKindOfConfiguration

enum adtf::filter::ant::ITriggerConfiguration::tKindOfConfiguration : uint32_t

The kind of trigger configuration to retrieve with ITriggerConfiguration::GetConfiguration.

Enumerator
eDataIn	A default DataTrigger of the Runner. If a DataTrigger is active the property Prop_IsActive of the returned adtf::base::ant::IConfiguration is set to true.
eDataOut	Data (Out) Trigger of the Runner. If a Data (Out) Trigger is active the property Prop_IsActive of the returned adtf::base::ant::IConfiguration is set to true. This only means, that a OutPin is registered to forward a trigger after the cTriggerFuntion::RunTrigger was called. It forward the Run call to receive synchronous DataTriggers on every connected SampleStream.
eTimer	A default TimeTrigger of the Runner is configured. If a TimeTrigger is active the property Prop_IsActive of the returned adtf::base::ant::IConfiguration is set to true.
eThread	A default ThreadTrigger of the Runner is configured. If a ThreadTrigger is active the property Prop_IsActive of the returned adtf::base::ant::IConfiguration is set to true.

Member Function Documentation

GetConfiguration()

virtual const adtf::base::ant::IConfiguration & adtf::filter::ant::ITriggerConfiguration::GetConfiguration ( tKindOfConfiguration eKind ) const

pure virtual

Returns the default trigger configuration requested by eKind.

See also

tKindOfConfiguration

Parameters

[in]

eKind

Kind of configuration requested.

Returns

The configuration with the properties for a default trigger configuration on a IRunner.

Member Data Documentation

Prop_DataInTriggered

const tChar* const adtf::filter::ant::ITriggerConfiguration::Prop_DataInTriggered = "data_in_triggered"

staticconstexpr

Defines the property name for the DataTrigger

The value is a comma separated list of InPins with a synchronous DataTrigger.

Prop_DataOutTrigger

const tChar* const adtf::filter::ant::ITriggerConfiguration::Prop_DataOutTrigger = "data_out_trigger"

staticconstexpr

Defines the property name for the Data (Out) Trigger

The value is a comma separated list of OutPins with a synchronous Data (Out) Trigger.

Prop_IsActive

const tChar* const adtf::filter::ant::ITriggerConfiguration::Prop_IsActive = "is_active"

staticconstexpr

Defines the property name to retrieve the activation state of a configuration retrieved by GetConfiguration

If a certain trigger is active the property value of Prop_IsActive of the returned adtf::base::ant::IConfiguration is set to true.

Prop_ThreadIsCyclic

const tChar* const adtf::filter::ant::ITriggerConfiguration::Prop_ThreadIsCyclic = "thread_is_cyclic"

staticconstexpr

Defines the property name of an IActiveRunner that supports cyclic and non-cyclic trigger calls on IRunner,

The Property value is true or false

Prop_TimerPeriodInMicroSec

const tChar* const adtf::filter::ant::ITriggerConfiguration::Prop_TimerPeriodInMicroSec = "timer_period_micro_sec"

staticconstexpr

Defines the property name of an IActiveRunner that supports Timer Trigger Calls on IRunner.

The property value defines the period in micro second for the timer.

---

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

• src/libraries/filtersdk/include/adtffiltersdk/trigger_intf.h