Pleora Technologies Inc. eBUS SDK v6.5.1.6797 API



Public Member Functions | List of all members
IPvTriggerSelector Class Referenceabstract

Interface used by PvStreamingChannelSourceTrigger to support a trigger mechanism. More...

#include <PvTriggerSelector.h>

Public Member Functions

virtual ~IPvTriggerSelector ()
 Virtual destructor.
 
virtual void Start (const uint32_t aHeight)=0
 Signals the state machine to move from the Enabled state to the Armed state. More...
 
virtual void Stop ()=0
 Unconditionally moves the state machine into the Enabled state. More...
 
virtual void FireTrigger ()=0
 With all conditions met, fires a trigger signal to move to the Fired state.
 
virtual void Rearm ()=0
 Moves the state from Fired, to another state like Armed (in case of a per-frame TriggerSelector like FrameStart). More...
 
virtual void SetMode (bool aIsEnabled)=0
 Sets the trigger mode (enabled or disabled). More...
 
virtual bool GetMode () const =0
 Gets the trigger mode. More...
 
virtual void SetSource (uint32_t aSource)=0
 Sets the trigger source. More...
 
virtual uint32_t GetSource () const =0
 Gets the trigger source. More...
 
virtual PvString GetName () const =0
 Gets the selector name. More...
 
virtual State GetState () const =0
 Gets the current selector state. More...
 
virtual bool IsEnabled () const =0
 Checks if the trigger is enabled. More...
 

Detailed Description

Interface used by PvStreamingChannelSourceTrigger to support a trigger mechanism.

Member Function Documentation

◆ GetMode()

virtual bool IPvTriggerSelector::GetMode ( ) const
pure virtual

Gets the trigger mode.

Returns
A boolean value (true for enabled, false for disabled).

Implemented in PvTriggerSelectorDefault.

◆ GetName()

virtual PvString IPvTriggerSelector::GetName ( ) const
pure virtual

Gets the selector name.

Returns
A string with the selector name.

Implemented in PvTriggerSelectorDefault.

◆ GetSource()

virtual uint32_t IPvTriggerSelector::GetSource ( ) const
pure virtual

Gets the trigger source.

Returns
A source index.

Implemented in PvTriggerSelectorDefault.

◆ GetState()

virtual State IPvTriggerSelector::GetState ( ) const
pure virtual

Gets the current selector state.

Returns
A state value (disabled, enabled, armed, fired or one-shot).

Implemented in PvTriggerSelectorDefault.

◆ IsEnabled()

virtual bool IPvTriggerSelector::IsEnabled ( ) const
pure virtual

Checks if the trigger is enabled.

Returns
A boolean value set to true if the trigger is enabled, and false otherwise.

Implemented in PvTriggerSelectorDefault.

◆ Rearm()

virtual void IPvTriggerSelector::Rearm ( )
pure virtual

Moves the state from Fired, to another state like Armed (in case of a per-frame TriggerSelector like FrameStart).

May also do nothing for permanently fired TriggerSelector like AcquistionStart.

Implemented in PvTriggerSelectorLineStart, PvTriggerSelectorFrameStart, and PvTriggerSelectorDefault.

◆ SetMode()

virtual void IPvTriggerSelector::SetMode ( bool  aIsEnabled)
pure virtual

Sets the trigger mode (enabled or disabled).

Parameters
[in]aIsEnabledA boolean value (true for enabled, false for disabled).

Implemented in PvTriggerSelectorDefault.

◆ SetSource()

virtual void IPvTriggerSelector::SetSource ( uint32_t  aSource)
pure virtual

Sets the trigger source.

Parameters
[in]aSourceA source index.

Implemented in PvTriggerSelectorDefault.

◆ Start()

virtual void IPvTriggerSelector::Start ( const uint32_t  aHeight)
pure virtual

Signals the state machine to move from the Enabled state to the Armed state.

The implementation must not perform state transition when in states that are not concerned with this signal.

Parameters
[in]aHeightThe image height.

Implemented in PvTriggerSelectorLineStart, PvTriggerSelectorAcquisitionStart, and PvTriggerSelectorDefault.

◆ Stop()

virtual void IPvTriggerSelector::Stop ( )
pure virtual

Unconditionally moves the state machine into the Enabled state.

This allows to potentially unblock the acquisition loop, while avoiding to acquire any image.

Implemented in PvTriggerSelectorAcquisitionStart, and PvTriggerSelectorDefault.

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

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