Base Filter Class.
More...
Base Filter Class.
This has been superseded by flash::cFilter.
The cFilter enriches the cConfigurableFilter with functionality to:
Use this implementation as your basic implementation for own Filters. Only this Filter is able to create Default Trigger Information that the ADTF Configuration Editor is able to automatic add the required Thread Runner and Timer Runner.
Internal trigger pipes for data triggers are created automatically!
- Data In Triggers can be reconfigured only by adding a non-synchronously connection to the related in pin.
- Data Out Triggers can be reconfigured only by adding a non-synchronously connection from the related out pin.
Definition at line 109 of file filtersdk/include/adtffiltersdk/filter.h.
◆ ConfigureDataInTrigger()
tResult ConfigureDataInTrigger |
( |
const char * |
strRunnerName, |
|
|
const char * |
strPinName |
|
) |
| |
Creates an internal trigger pipe for the given pin.
It will also create a internal trigger configuration.
- Parameters
-
strRunnerName | [in] The Runner to be triggered if data where received on strPinName . |
strPinName | [in] The pin to be triggered from. |
- Return values
-
ERR_NOERROR | Succeeded. |
ERR_NOTFOUND | Either strPinName or strRunnerName is not registered. |
◆ ConfigureDataOutTrigger()
tResult ConfigureDataOutTrigger |
( |
const char * |
strRunnerName, |
|
|
const char * |
strPinName |
|
) |
| |
Creates an internal trigger pipe for the given pin.
It will also create a internal trigger configuration.
- Parameters
-
strRunnerName | [in] The Runner to be triggered if data where received on strPinName . |
strPinName | [in] The pin to trigger forward the tigger to after strRunnerName was triggered. |
- Return values
-
ERR_NOERROR | Succeeded. |
ERR_NOTFOUND | Either strPinName or strRunnerName is not registered. |
◆ ConfigureThreadTrigger()
tResult ConfigureThreadTrigger |
( |
const char * |
strRunnerName, |
|
|
bool |
bCallCyclic |
|
) |
| |
Creates an internal a internal thread configuration for a timing trigger.
- Parameters
-
strRunnerName | [in] The Runner to be triggered if data where received on strPinName . |
bCallCyclic | [in] tFalase - Single Shot Trigger/ true - Endless repeat trigger after returning |
- Return values
-
ERR_NOERROR | Succeeded. |
ERR_NOTFOUND | Either strPinName or strRunnerName is not registered. |
◆ ConfigureTimerTrigger()
tResult ConfigureTimerTrigger |
( |
const char * |
strRunnerName, |
|
|
tTimeStamp |
tmPeriod |
|
) |
| |
Creates an internal a internal trigger configuration for a timing trigger.
- Parameters
-
strRunnerName | [in] The Runner to be triggered if data where received on strPinName . |
tmPeriod | [in] Default timing period configuration requested. |
- Return values
-
ERR_NOERROR | Succeeded. |
ERR_NOTFOUND | Either strPinName or strRunnerName is not registered. |