IDS peak AFL v2.0.2
Loading...
Searching...
No Matches
IRangeFeature< T > Class Template Referenceabstract

Interface for features that have a valid range of values. More...

#include <peak_afl/pipeline/modules/controllers/features/peak_afl_ifeature.hpp>

Inheritance diagram for IRangeFeature< T >:
IFeature< T > ISerializable

Public Member Functions

virtual peak::common::detail::RangeT< T > GetRange () const =0
 Gets the valid range for this feature's values.
Public Member Functions inherited from IFeature< T >
virtual ~IFeature ()=default
 Virtual destructor for proper cleanup of derived classes.
virtual void Set (const T &value)=0
 Sets the feature value.
virtual T Get () const =0
 Gets the current feature value.
Public Member Functions inherited from ISerializable
virtual void Serialize (IArchive &archive) const =0
 Serializes the current object into the provided archive.
virtual void Deserialize (const IArchive &archive)=0
 Deserializes the object's state from the provided archive.

Detailed Description

template<typename T>
class peak::pipeline::modules::autofeature::features::IRangeFeature< T >

Interface for features that have a valid range of values.

The IRangeFeature template class extends IFeature to provide additional functionality for features that have a defined range of valid values. This is useful for numeric parameters that have minimum, maximum, and increment constraints.

Examples of range features include:

  • Auto target brightness (0-255 range)
  • Auto tolerance (0-100 range)
  • Skip frames (0-N range)
  • Hysteresis values
Template Parameters
TThe numeric type that this range feature manages
See also
IFeature
peak::common::detail::RangeT
Since
1.8

Member Function Documentation

◆ GetRange()

template<typename T>
virtual peak::common::detail::RangeT< T > GetRange ( ) const
pure virtual

Gets the valid range for this feature's values.

Retrieves the minimum, maximum, and increment values that define the valid range for this feature. This information can be used for input validation and user interface constraints.

Returns
A RangeT structure containing min, max, and increment values
Exceptions
Implementation-specificexceptions may be thrown if the underlying system is in an invalid state.
See also
IFeature::Set()
IFeature::Get()
Since
1.8

Implemented in AutoPercentile, AutoTarget, AutoTolerance, Hysteresis, and SkipFrames.


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