Fawkes API Fawkes Development Version
focus.cpp
1
2/***************************************************************************
3 * focus.cpp - Abstract class defining a camera focus controller
4 *
5 * Created: Wed Apr 22 10:37:16 2009
6 * Copyright 2009 Tobias Kellner
7 * 2005-2009 Tim Niemueller [www.niemueller.de]
8 *
9 ****************************************************************************/
10
11/* This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version. A runtime exception applies to
15 * this software (see LICENSE.GPL_WRE file mentioned below for details).
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
21 *
22 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
23 */
24
25#include <fvcams/control/focus.h>
26
27namespace firevision {
28
29/** @class CameraControlFocus <fvcams/control/focus.h>
30 * Camera focus control interface.
31 * Some cameras feature an adjustable focus.
32 *
33 * This interface shall be implemented by such cameras.
34 *
35 * @author Tim Niemueller
36 * @author Tobias Kellner
37 *
38 * @fn bool CameraControlFocus::auto_focus() = 0
39 * Check if auto focus is enabled.
40 * @return true, if the camera is in auto focus mode, false otherwise
41 * @throws NotImplementedException Not implemented by this control
42 *
43 * @fn void CameraControlFocus::set_auto_focus(bool enabled) = 0
44 * Enable or disable auto focus.
45 * @param enabled if true, enable auto focus, otherwise disable
46 * @throws NotImplementedException Not implemented by this control
47 *
48 * @fn unsigned int CameraControlFocus::focus()
49 * Get current focus value.
50 * @return current focus value.
51 *
52 * @fn void CameraControlFocus::set_focus(unsigned int focus)
53 * Set new focus value.
54 * @param focus new focus value
55 *
56 * @fn unsigned int CameraControlFocus::focus_min()
57 * Get minimum focus value.
58 * @return minimum focus value.
59 *
60 * @fn unsigned int CameraControlFocus::focus_max()
61 * Get maximum focus value.
62 * @return maximum focus value.
63 */
64
65/** Empty virtual destructor. */
67{
68}
69
70} // end namespace firevision
virtual ~CameraControlFocus()
Empty virtual destructor.
Definition: focus.cpp:66