Image Component Library (ICL)
RSBGrabber.h
Go to the documentation of this file.
1 /********************************************************************
2 ** Image Component Library (ICL) **
3 ** **
4 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld **
5 ** Neuroinformatics Group **
6 ** Website: www.iclcv.org and **
7 ** http://opensource.cit-ec.de/projects/icl **
8 ** **
9 ** File : ICLIO/src/ICLIO/RSBGrabber.h **
10 ** Module : ICLIO **
11 ** Authors: Christof Elbrechter, Viktor Richter **
12 ** **
13 ** **
14 ** GNU LESSER GENERAL PUBLIC LICENSE **
15 ** This file may be used under the terms of the GNU Lesser General **
16 ** Public License version 3.0 as published by the **
17 ** **
18 ** Free Software Foundation and appearing in the file LICENSE.LGPL **
19 ** included in the packaging of this file. Please review the **
20 ** following information to ensure the license requirements will **
21 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt **
22 ** **
23 ** The development of this software was supported by the **
24 ** Excellence Cluster EXC 277 Cognitive Interaction Technology. **
25 ** The Excellence Cluster EXC 277 is a grant of the Deutsche **
26 ** Forschungsgemeinschaft (DFG) in the context of the German **
27 ** Excellence Initiative. **
28 ** **
29 ********************************************************************/
30 
31 
32 #pragma once
33 
34 #include <ICLUtils/CompatMacros.h>
35 #include <ICLIO/Grabber.h>
36 
37 #if !defined(ICL_HAVE_RSB) || !defined(ICL_HAVE_PROTOBUF)
38  #if WIN32
39  #pragma WARNING("This header should only be included if ICL_HAVE_RSB and ICL_HAVE_PROTOBUF are defined and available in ICL")
40  #else
41  #warning "This header should only be included if ICL_HAVE_RSB and ICL_HAVE_PROTOBUF are defined and available in ICL"
42  #endif
43 #endif
44 
45 namespace icl{
46  namespace io{
47 
49  class RSBGrabber : public Grabber{
50  struct Data;
51  Data *m_data;
52 
53  public:
54 
57 
60 
62 
64  ICLIO_API RSBGrabber(const std::string &scope, const std::string &transportList="spread");
65 
67 
69  ICLIO_API void init(const std::string &scope, const std::string &transportList = "spread");
70 
72  ICLIO_API virtual const core::ImgBase *acquireImage();
73 
75  inline bool isNull() const { return !m_data; }
76 
78  ICLIO_API static const std::vector<GrabberDeviceDescription> &getDeviceList(bool rescan);
79 
82 
83  };
84 
85  } // namespace io
86 }
87 
undocument this line if you encounter any issues!
Definition: Any.h:37
Data * m_data
pimpl type
Definition: RSBGrabber.h:50
static ICLIO_API const std::vector< GrabberDeviceDescription > & getDeviceList(bool rescan)
returns a list of all available rsb streams
Grabber implementation for RSB based image transfer.
Definition: RSBGrabber.h:49
#define ICLIO_API
Definition: CompatMacros.h:176
Common interface class for all grabbers.
Definition: Grabber.h:153
ICLIO_API void processPropertyChange(const utils::Configurable::Property &prop)
callback for changed configurable properties
Property & prop(const std::string &propertyName)
this CAN be used e.g. to store a property value in internal property-list
virtual ICLIO_API const core::ImgBase * acquireImage()
grabber-interface
bool isNull() const
returns whether this grabber has not jet been initialized
Definition: RSBGrabber.h:75
ICLIO_API RSBGrabber()
empty constructor (creates a null instance)
Represents a single property.
Definition: Configurable.h:200
ICLIO_API void init(const std::string &scope, const std::string &transportList="spread")
deferred intialization with given scope and comma separated transportList
ImgBase is the Image-Interface class that provides save access to underlying Img-template .
Definition: ImgBase.h:131
ICLIO_API ~RSBGrabber()
Destructor.