Pleora Technologies Inc. eBUS SDK v6.5.1.6797 API



PvTriggerSelectorDefault Class Reference

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>

Public Member Functions

 PvTriggerSelectorDefault (const char *const aName="N/A")
 Constructor. More...
 
virtual ~PvTriggerSelectorDefault ()
 Virtual destructor.
 
void Start (const uint32_t aHeight) override
 Nothing to do for the default implementation. More...
 
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). More...
 
bool GetMode () const override
 Gets the trigger mode. More...
 
void SetSource (const uint32_t aSource) override
 Sets the trigger source. More...
 
uint32_t GetSource () const override
 Gets the trigger source. More...
 
PvString GetName () const override
 Gets the selector name. More...
 
bool IsEnabled () const override
 Checks if the trigger is enabled. More...
 
- Public Member Functions inherited from IPvTriggerSelector
virtual ~IPvTriggerSelector ()
 Virtual destructor.
 

Protected Member Functions

void SetState (const State aState)
 Sets the selector state. More...
 
State GetState () const override
 Gets the current selector state. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ PvTriggerSelectorDefault()

PvTriggerSelectorDefault::PvTriggerSelectorDefault ( const char *const  aName = "N/A")
inline

Constructor.

Parameters
[in]aNameThe selector name.

Member Function Documentation

◆ 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

Gets the trigger source.

Returns
A source index.

Implements IPvTriggerSelector.

◆ 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]aIsEnabledA 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]aSourceA source index.

Implements IPvTriggerSelector.

◆ SetState()

void PvTriggerSelectorDefault::SetState ( const State  aState)
inlineprotected

Sets the selector state.

Parameters
[in]aStateA state value (disabled, enabled, armed, fired or one-shot).

◆ Start()

void PvTriggerSelectorDefault::Start ( const uint32_t  aHeight)
inlineoverridevirtual

Nothing to do for the default implementation.

Parameters
[in]aHeightThe image height (ignored).

Implements IPvTriggerSelector.

Reimplemented in PvTriggerSelectorLineStart, and PvTriggerSelectorAcquisitionStart.


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

Copyright (c) 2002-2024 Pleora Technologies Inc.
www.pleora.com