firevision::CameraControlFocus Class Reference

Camera focus control interface. More...

#include <cams/control/focus.h>

Inheritance diagram for firevision::CameraControlFocus:

[legend]

List of all members.

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

---

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

firevision::CameraControlFocus::~CameraControlFocus

(

)

[virtual]

Empty virtual destructor.

Definition at line 69 of file focus.cpp.

---

Member Function Documentation

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:

NotImplementedException

Not implemented by this control

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

unsigned int firevision::CameraControlFocus::focus

(

)

[pure virtual]

Get current focus value.

Returns:

current focus value.

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

unsigned int firevision::CameraControlFocus::focus_max

(

)

[pure virtual]

Get maximum focus value.

Returns:

maximum focus value.

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

unsigned int firevision::CameraControlFocus::focus_min

(

)

[pure virtual]

Get minimum focus value.

Returns:

minimum focus value.

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

void firevision::CameraControlFocus::set_auto_focus

(

bool

enabled

)

[pure virtual]

Enable or disable auto focus.

Parameters:

enabled

if true, enable auto focus, otherwise disable

Exceptions:

NotImplementedException

Not implemented by this control

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

void firevision::CameraControlFocus::set_focus

(

unsigned int

focus

)

[pure virtual]

Set new focus value.

Parameters:

focus

new focus value

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

---

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

• src/firevision/cams/control/focus.h
• src/firevision/cams/control/focus.cpp