libcamera  v0.3.1+12-19bbca3c
Supporting cameras in Linux since 2019
Public Member Functions | List of all members
libcamera::ControlValidator Class Referenceabstract

Interface for the control validator. More...

Inheritance diagram for libcamera::ControlValidator:
Inheritance graph
[legend]

Public Member Functions

virtual const std::string & name () const =0
 Retrieve the name of the object associated with the validator. More...
 
virtual bool validate (unsigned int id) const =0
 Validate a control. More...
 

Detailed Description

Interface for the control validator.

The ControlValidator class is used by the ControlList class to validate controls added to the list. It is an abstract class providing an interface for object-specific control validation, such a Camera controls and V4L2 controls.

Member Function Documentation

◆ name()

libcamera::ControlValidator::name ( ) const
pure virtual

Retrieve the name of the object associated with the validator.

Returns
The name of the object associated with the validator

Implemented in libcamera::CameraControlValidator.

◆ validate()

libcamera::ControlValidator::validate ( unsigned int  id) const
pure virtual

Validate a control.

Parameters
[in]idThe control ID

This function validates the control id against the object corresponding to the validator. It shall at least validate that the control is applicable to the object instance, and may perform additional checks.

Returns
True if the control is valid, false otherwise

Implemented in libcamera::CameraControlValidator.


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