iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NoneImageSource.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_NONEIMAGESOURCE_H
37 #define INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_NONEIMAGESOURCE_H
38 
41 
42 namespace nrt
43 {
44  //! An ImageSourceType that always returns empty GenericImages
45  class NoneImageSource : public ImageSourceType
46  {
47  public:
48  //! Inherited constructor
49  using ImageSourceType::ImageSourceType;
50 
51  //! Returns an uninitialized GenericImage
52  GenericImage const in();
53 
54  //! The none image source is never ok!
55  bool const ok() const;
56 
57  //! Get the name associated with our --in type
58  static std::string const id() { return "none"; }
59 
60  //! Get a description to show for --help
61  static std::string const description() { return "Always returns uninitialized images"; }
62  };
63 }
64 
65 
66 #endif // INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_NONEIMAGESOURCE_H