IListFeature< T > Class Template Reference

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

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

Inheritance diagram for IListFeature< T >:

Public Member Functions
virtual std::vector< T >	GetList () const =0
	Gets the list of valid values for this feature.
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::IListFeature< T >

Interface for features that have a list of valid values.

The IListFeature template class extends IFeature to provide additional functionality for features that have a discrete set of valid values. This is useful for enumerated parameters like algorithms or modes.

Examples of list features include:

• Focus search algorithms (Auto, GoldenRatio, HillClimbing, etc.)
• Brightness analysis algorithms (Mean, Median)
• Controller modes

Template Parameters

T	The enumerated type that this list feature manages

See also

IFeature

Since

1.8

Member Function Documentation

GetList()

template<typename T>

virtual std::vector< T > GetList ( ) const

pure virtual

Gets the list of valid values for this feature.

Retrieves all valid values that this feature can be set to. This information can be used for input validation and to populate user interface controls like dropdown lists.

Returns

A vector containing all valid values for this feature

Exceptions

Implementation-specific

exceptions may be thrown if the underlying system is in an invalid state.

See also

IFeature::Set()

IFeature::Get()

Since

1.8

Implemented in SearchAlgorithm, and SharpnessAlgorithm.

---

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

• peak_afl/pipeline/modules/controllers/features/peak_afl_ifeature.hpp