Fawkes API  Fawkes Development Version
camera.h
1 
2 /***************************************************************************
3  * camera.h - Abstract class defining a camera
4  *
5  * Created: Tue Feb 22 10:36:39 2005
6  * Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #ifndef _FIREVISION_CAMERA_H_
25 #define _FIREVISION_CAMERA_H_
26 
27 #include <fvutils/color/colorspaces.h>
28 #include <utils/time/time.h>
29 
30 namespace firevision {
31 
32 class Camera
33 {
34 public:
35  virtual ~Camera();
36 
37  virtual void open() = 0;
38  virtual void start() = 0;
39  virtual void stop() = 0;
40  virtual void close() = 0;
41  virtual void capture() = 0;
42  virtual void flush() = 0;
43 
44  virtual bool ready() = 0;
45 
46  virtual void print_info() = 0;
47 
48  virtual unsigned char *buffer() = 0;
49  virtual unsigned int buffer_size() = 0;
50  virtual void dispose_buffer() = 0;
51 
52  virtual unsigned int pixel_width() = 0;
53  virtual unsigned int pixel_height() = 0;
54  virtual colorspace_t colorspace() = 0;
55  virtual fawkes::Time *capture_time();
56 
57  // virtual unsigned int number_of_images() = 0;
58  virtual void set_image_number(unsigned int n) = 0;
59 };
60 
61 } // end namespace firevision
62 
63 #endif
firevision::Camera::~Camera
virtual ~Camera()
Virtual empty destructor.
Definition: camera.cpp:123
firevision::Camera::capture_time
virtual fawkes::Time * capture_time()
Get the Time of the last successfully captured image.
Definition: camera.cpp:137
firevision::Camera::start
virtual void start()=0
Start image transfer from the camera.
firevision::Camera::colorspace
virtual colorspace_t colorspace()=0
Colorspace of returned image.
firevision::Camera::buffer_size
virtual unsigned int buffer_size()=0
Size of buffer.
firevision::Camera::stop
virtual void stop()=0
Stop image transfer from the camera.
firevision::Camera::open
virtual void open()=0
Open the camera.
firevision::Camera::dispose_buffer
virtual void dispose_buffer()=0
Dispose current buffer.
firevision::Camera::close
virtual void close()=0
Close camera.
firevision::Camera::ready
virtual bool ready()=0
Camera is ready for taking pictures.
firevision::Camera::buffer
virtual unsigned char * buffer()=0
Get access to current image buffer.
firevision::Camera::pixel_height
virtual unsigned int pixel_height()=0
Height of image in pixels.
firevision::Camera::print_info
virtual void print_info()=0
Print out camera information.
firevision::Camera::set_image_number
virtual void set_image_number(unsigned int n)=0
Set image number to retrieve.
firevision::Camera::pixel_width
virtual unsigned int pixel_width()=0
Width of image in pixels.
firevision::Camera::flush
virtual void flush()=0
Flush image queue.
fawkes::Time
A class for handling time.
Definition: time.h:93
firevision::Camera::capture
virtual void capture()=0
Capture an image.
firevision::Camera
Camera interface for image aquiring devices in FireVision.
Definition: camera.h:33