Fawkes API  Fawkes Development Version
firevision::CameraControlFocus Class Referenceabstract

Camera focus control interface. More...

#include <>>

Inheritance diagram for firevision::CameraControlFocus:

Public Member Functions

virtual ~CameraControlFocus ()
 Empty virtual destructor. More...
 
virtual bool auto_focus ()=0
 Check if auto focus is enabled. More...
 
virtual void set_auto_focus (bool enabled)=0
 Enable or disable auto focus. More...
 
virtual unsigned int focus ()=0
 Get current focus value. More...
 
virtual void set_focus (unsigned int focus)=0
 Set new focus value. More...
 
virtual unsigned int focus_min ()=0
 Get minimum focus value. More...
 
virtual unsigned int focus_max ()=0
 Get maximum focus value. More...
 
- Public Member Functions inherited from firevision::CameraControl
virtual ~CameraControl ()
 Virtual empty destructor. More...
 

Detailed Description

Camera focus control interface.

Some cameras feature an adjustable focus.

This interface shall be implemented by such cameras.

Author
Tim Niemueller
Tobias Kellner

Definition at line 35 of file focus.h.

Constructor & Destructor Documentation

◆ ~CameraControlFocus()

firevision::CameraControlFocus::~CameraControlFocus ( )
virtual

Empty virtual destructor.

Definition at line 69 of file focus.cpp.

Member Function Documentation

◆ auto_focus()

bool firevision::CameraControlFocus::auto_focus ( )
pure virtual

Check if auto focus is enabled.

Returns
true, if the camera is in auto focus mode, false otherwise
Exceptions
NotImplementedExceptionNot implemented by this control

Implemented in firevision::DummyCameraControl, and firevision::FirewireCamera.

◆ focus()

unsigned int firevision::CameraControlFocus::focus ( )
pure virtual

Get current focus value.

Returns
current focus value.

Implemented in firevision::DummyCameraControl, and firevision::FirewireCamera.

◆ focus_max()

unsigned int firevision::CameraControlFocus::focus_max ( )
pure virtual

Get maximum focus value.

Returns
maximum focus value.

Implemented in firevision::DummyCameraControl, and firevision::FirewireCamera.

◆ focus_min()

unsigned int firevision::CameraControlFocus::focus_min ( )
pure virtual

Get minimum focus value.

Returns
minimum focus value.

Implemented in firevision::DummyCameraControl, and firevision::FirewireCamera.

◆ set_auto_focus()

void firevision::CameraControlFocus::set_auto_focus ( bool  enabled)
pure virtual

Enable or disable auto focus.

Parameters
enabledif true, enable auto focus, otherwise disable
Exceptions
NotImplementedExceptionNot implemented by this control

Implemented in firevision::DummyCameraControl, and firevision::FirewireCamera.

◆ set_focus()

void firevision::CameraControlFocus::set_focus ( unsigned int  focus)
pure virtual

Set new focus value.

Parameters
focusnew focus value

Implemented in firevision::DummyCameraControl, and firevision::FirewireCamera.


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