Base class for brightness limit features. More...

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

Inheritance diagram for BrightnessLimit:

Public Member Functions
void	Serialize (peak::common::serialization::IArchive &archive) const override
	Serializes the current brightness limit to an archive.
void	Deserialize (const peak::common::serialization::IArchive &archive) override
	Deserializes the brightness limit from an archive.
Public Member Functions inherited from IFeature< IntervalD >
virtual	~IFeature ()=default
	Virtual destructor for proper cleanup of derived classes.
virtual void	Set (const IntervalD &value)=0
	Sets the feature value.
virtual IntervalD	Get () const=0
	Gets the current feature value.

Detailed Description

Base class for brightness limit features.

The BrightnessLimit class provides a common base interface for all brightness-related limit features in auto controllers. This abstract base class defines the standard serialization behavior for interval-based limits used in automatic exposure and brightness control.

Brightness limits define the allowable range for various camera parameters that affect image brightness, such as exposure time, gain values, and other exposure components. These limits prevent the automatic algorithms from setting values outside acceptable ranges.

This class inherits from IFeature<IntervalD> and provides standard serialization support for double-precision intervals.

Note: This is an abstract base class. Use the specific derived classes like BrightnessExposureLimit, BrightnessGainLimit, etc. for actual functionality.

See also: IFeature; peak::common::detail::IntervalT; BrightnessExposureLimit; BrightnessGainLimit

Since: 1.8

Member Function Documentation

◆ Deserialize()

void Deserialize ( const peak::common::serialization::IArchive & archive )

inlineoverridevirtual

Deserializes the brightness limit from an archive.

Loads the brightness limit interval from the provided archive and applies it to the controller. The interval is expected to be stored with keys "Min" and "Max".

Parameters

[in] archive The archive to read the brightness limit from

Exceptions

May	throw serialization exceptions if the archive operation fails
May	throw controller exceptions if the deserialized interval is invalid

See also: Serialize()

Since: 1.8

Implements ISerializable.

◆ Serialize()

void Serialize ( peak::common::serialization::IArchive & archive ) const

inlineoverridevirtual

Serializes the current brightness limit to an archive.

Stores the current brightness limit interval in the provided archive for configuration persistence. The interval is stored with keys "Min" and "Max".