iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImageSourceType.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies (voorhies@usc.edu)
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_DETAILS_IMAGESOURCETYPE_H
37 #define INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_DETAILS_IMAGESOURCETYPE_H
38 
42 
43 namespace nrt
44 {
45  class ImageSourceType : public nrt::Component
46  {
47  public:
48  ImageSourceType(std::string const& instanceID="ImageSourceType");
49 
50  virtual nrt::GenericImage const in() = 0;
51  virtual bool const ok() const = 0;
52  };
53 
54  //! ImageSource factory
55  typedef ComponentFactory<
56  std::string,
57  std::function<std::shared_ptr<nrt::ImageSourceType>(nrt::Component * parent, std::string const & instanceName)>,
58  std::map<std::string, std::string>
60 }
61 
62 /*! \def NRT_REGISTER_SOURCE(CLASSNAME) Register an ImageSourceType with a global Factory. */
63 #define NRT_REGISTER_SOURCE(CLASSNAME) \
64  std::shared_ptr<nrt::ImageSourceType> create##CLASSNAME(nrt::Component * parent, std::string const & instanceName) \
65  { return parent->addSubComponent<CLASSNAME>(instanceName); } \
66  \
67  bool imageSourceRegister##CLASSNAME() \
68  { \
69  std::map<std::string,std::string> metadata; \
70  metadata["id"] = CLASSNAME::id(); \
71  metadata["description"] = CLASSNAME::description(); \
72  nrt::ImageSourceFactory::instance(). \
73  registerType(metadata["id"], create##CLASSNAME, metadata); \
74  return true; \
75  } \
76  \
77  bool const CLASSNAME##Registered __attribute__ ((unused)) = \
78  imageSourceRegister##CLASSNAME(); \
79 
80 #endif // INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_DETAILS_IMAGESOURCETYPE_H