Combined gain limit feature implementation for brightness controllers. More...

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

Inheritance diagram for BrightnessGainCombinedLimit:

Public Member Functions
	BrightnessGainCombinedLimit (std::shared_ptr< peak::afl::Controller > controller)
	Constructs a combined gain limit feature with the specified controller.
void	Set (const IntervalD &value) override
	Sets the combined gain limits.
IntervalD	Get () const override
	Gets the current combined gain limits.
Public Member Functions inherited from BrightnessLimit
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.

Detailed Description

Combined gain limit feature implementation for brightness controllers.

The BrightnessGainCombinedLimit class manages combined analog and digital gain limits as a unified control. This feature treats both analog and digital gain as a single combined gain parameter, allowing for simplified gain management when the distinction between analog and digital gain is not critical.

This approach is useful when the camera system handles the distribution between analog and digital gain automatically, or when the application requires unified gain control without concern for the specific gain type.

See also: BrightnessLimit; peak::afl::Controller::SetGainCombinedLimit(); peak::afl::Controller::GetGainCombinedLimit(); BrightnessGainAnalogLimit; BrightnessGainDigitalLimit

Since: 1.8

Constructor & Destructor Documentation

◆ BrightnessGainCombinedLimit()

BrightnessGainCombinedLimit ( std::shared_ptr< peak::afl::Controller > controller )

inlineexplicit

Constructs a combined gain limit feature with the specified controller.

Parameters

[in] controller Shared pointer to the auto controller that will be used to manage the combined gain limits. The controller must support combined gain operations.

Precondition: controller must not be null; controller must support combined gain functionality

Since: 1.8

Member Function Documentation

◆ Get()

IntervalD Get ( ) const

inlineoverridevirtual

Gets the current combined gain limits.

Returns: The current combined gain limits as an IntervalD object

Exceptions

May	throw exceptions based on the underlying controller implementation if the controller is in an invalid state

See also: Set()

Since: 1.8

Implements IFeature< IntervalD >.

◆ Set()

void Set ( const IntervalD & value )