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 
27 namespace firevision {
28 #if 0 /* just to make Emacs auto-indent happy */
29 }
30 #endif
31 
32 /** @class CameraControlFocus <fvcams/control/focus.h>
33  * Camera focus control interface.
34  * Some cameras feature an adjustable focus.
35  *
36  * This interface shall be implemented by such cameras.
37  *
38  * @author Tim Niemueller
39  * @author Tobias Kellner
40  *
41  * @fn bool CameraControlFocus::auto_focus() = 0
42  * Check if auto focus is enabled.
43  * @return true, if the camera is in auto focus mode, false otherwise
44  * @throws NotImplementedException Not implemented by this control
45  *
46  * @fn void CameraControlFocus::set_auto_focus(bool enabled) = 0
47  * Enable or disable auto focus.
48  * @param enabled if true, enable auto focus, otherwise disable
49  * @throws NotImplementedException Not implemented by this control
50  *
51  * @fn unsigned int CameraControlFocus::focus()
52  * Get current focus value.
53  * @return current focus value.
54  *
55  * @fn void CameraControlFocus::set_focus(unsigned int focus)
56  * Set new focus value.
57  * @param focus new focus value
58  *
59  * @fn unsigned int CameraControlFocus::focus_min()
60  * Get minimum focus value.
61  * @return minimum focus value.
62  *
63  * @fn unsigned int CameraControlFocus::focus_max()
64  * Get maximum focus value.
65  * @return maximum focus value.
66  */
67 
68 /** Empty virtual destructor. */
70 {
71 }
72 
73 } // end namespace firevision
virtual ~CameraControlFocus()
Empty virtual destructor.
Definition: focus.cpp:69