A default implementation for the IPvTriggerSelector interface. This defines the typical base behavior for trigger selectors, and it is used when TriggerMode[TriggerSelector] is set to OFF.
More...
#include <PvTriggerSelector.h>
|
| | PvTriggerSelectorDefault (const char *const aName="N/A") |
| | Constructor.
|
| |
|
virtual | ~PvTriggerSelectorDefault () |
| | Virtual destructor.
|
| |
| void | Start (const uint32_t aHeight) override |
| | Nothing to do for the default implementation.
|
| |
|
void | Stop () override |
| | Nothing to do for the default implementation.
|
| |
|
void | FireTrigger () override |
| | Nothing to do for the default implementation.
|
| |
|
void | Rearm () override |
| | Nothing to do for the default implementation.
|
| |
| void | SetMode (const bool aIsEnabled) override |
| | Sets the trigger mode (enabled or disabled).
|
| |
| bool | GetMode () const override |
| | Gets the trigger mode.
|
| |
| void | SetSource (const uint32_t aSource) override |
| | Sets the trigger source.
|
| |
| uint32_t | GetSource () const override |
| | Gets the trigger source.
|
| |
| PvString | GetName () const override |
| | Gets the selector name.
|
| |
| bool | IsEnabled () const override |
| | Checks if the trigger is enabled.
|
| |
|
virtual | ~IPvTriggerSelector () |
| | Virtual destructor.
|
| |
A default implementation for the IPvTriggerSelector interface. This defines the typical base behavior for trigger selectors, and it is used when TriggerMode[TriggerSelector] is set to OFF.
◆ PvTriggerSelectorDefault()
| PvTriggerSelectorDefault::PvTriggerSelectorDefault |
( |
const char *const |
aName = "N/A" | ) |
|
|
inline |
Constructor.
- Parameters
-
| [in] | aName | The selector name. |
◆ GetMode()
| bool PvTriggerSelectorDefault::GetMode |
( |
| ) |
const |
|
inlineoverridevirtual |
Gets the trigger mode.
- Returns
- A boolean value (true for enabled, false for disabled).
Implements IPvTriggerSelector.
◆ GetName()
| PvString PvTriggerSelectorDefault::GetName |
( |
| ) |
const |
|
inlineoverridevirtual |
Gets the selector name.
- Returns
- A string with the selector name.
Implements IPvTriggerSelector.
◆ GetSource()
| uint32_t PvTriggerSelectorDefault::GetSource |
( |
| ) |
const |
|
inlineoverridevirtual |
◆ GetState()
| State PvTriggerSelectorDefault::GetState |
( |
| ) |
const |
|
inlineoverrideprotectedvirtual |
Gets the current selector state.
- Returns
- A state value (disabled, enabled, armed, fired or one-shot).
Implements IPvTriggerSelector.
◆ IsEnabled()
| bool PvTriggerSelectorDefault::IsEnabled |
( |
| ) |
const |
|
inlineoverridevirtual |
Checks if the trigger is enabled.
- Returns
- A boolean value set to true if the trigger is enabled, and false otherwise.
Implements IPvTriggerSelector.
◆ SetMode()
| void PvTriggerSelectorDefault::SetMode |
( |
const bool |
aIsEnabled | ) |
|
|
inlineoverridevirtual |
Sets the trigger mode (enabled or disabled).
- Parameters
-
| [in] | aIsEnabled | A boolean value (true for enabled, false for disabled). |
Implements IPvTriggerSelector.
◆ SetSource()
| void PvTriggerSelectorDefault::SetSource |
( |
const uint32_t |
aSource | ) |
|
|
inlineoverridevirtual |
Sets the trigger source.
- Parameters
-
| [in] | aSource | A source index. |
Implements IPvTriggerSelector.
◆ SetState()
| void PvTriggerSelectorDefault::SetState |
( |
const State |
aState | ) |
|
|
inlineprotected |
Sets the selector state.
- Parameters
-
| [in] | aState | A state value (disabled, enabled, armed, fired or one-shot). |
◆ Start()
| void PvTriggerSelectorDefault::Start |
( |
const uint32_t |
aHeight | ) |
|
|
inlineoverridevirtual |
The documentation for this class was generated from the following file:
eBUS SDK v7.0.1.7536 API
Public Member Functions inherited from IPvTriggerSelector