ADTF  3.15.3
ITriggerConfigurationabstract

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

Inheritance diagram for ITriggerConfiguration:
[legend]

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::IConfigurationGetConfiguration (tKindOfConfiguration eKind) const =0
 Returns the default trigger configuration requested by eKind. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Static Public Attributes

static constexpr const tChar *const Prop_IsActive = "is_active"
 Defines the property name to retrieve the activation state of a configuration retrieved by GetConfiguration. More...
 
static constexpr const tChar *const Prop_DataInTriggered = "data_in_triggered"
 Defines the property name for the DataTrigger. More...
 
static constexpr const tChar *const Prop_DataOutTrigger = "data_out_trigger"
 Defines the property name for the Data (Out) Trigger. More...
 
static constexpr const tChar *const Prop_TimerPeriodInMicroSec = "timer_period_micro_sec"
 Defines the property name of an IActiveRunner that supports Timer Trigger Calls on IRunner. More...
 
static constexpr const tChar *const Prop_ThreadIsCyclic = "thread_is_cyclic"
 Defines the property name of an IActiveRunner that supports cyclic and non-cyclic trigger calls on IRunner,. More...
 

Protected Member Functions

 ~ITriggerConfiguration ()=default
 not destructable
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

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

Definition at line 25 of file trigger_intf.h.

Member Enumeration Documentation

◆ tKindOfConfiguration

enum 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 \b 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 \b 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 \b 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 \b true. 

Definition at line 36 of file trigger_intf.h.

Member Function Documentation

◆ GetConfiguration()

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

Returns the default trigger configuration requested by eKind.

See also
tKindOfConfiguration
Parameters
[in]eKindKind of configuration requested.
Returns
The configuration with the properties for a default trigger configuration on a IRunner.

Member Data Documentation

◆ Prop_DataInTriggered

constexpr const tChar* const 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.

Definition at line 64 of file trigger_intf.h.

◆ Prop_DataOutTrigger

constexpr const tChar* const 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.

Definition at line 68 of file trigger_intf.h.

◆ Prop_IsActive

constexpr const tChar* const 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.

Definition at line 60 of file trigger_intf.h.

◆ Prop_ThreadIsCyclic

constexpr const tChar* const 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

Definition at line 76 of file trigger_intf.h.

◆ Prop_TimerPeriodInMicroSec

constexpr const tChar* const 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.

Definition at line 72 of file trigger_intf.h.