Image Component Library (ICL)
RSBImageOutput.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/RSBImageOutput.h **
10 ** Module : ICLIO **
11 ** Authors: Christof Elbrechter **
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 #pragma once
32 
33 #include <ICLUtils/CompatMacros.h>
35 
36 #if !defined(ICL_HAVE_RSB) || !defined(ICL_HAVE_PROTOBUF)
37  #if WIN32
38  #pragma WARNING("This header should only be included if ICL_HAVE_RSB and ICL_HAVE_PROTOBUF are defined and available in ICL")
39  #else
40  #warning "This header should only be included if ICL_HAVE_RSB and ICL_HAVE_PROTOBUF are defined and available in ICL"
41  #endif
42 #endif
43 namespace icl{
44  namespace io{
45 
47  class RSBImageOutput : public ImageOutput{
48  struct Data;
49  Data *m_data;
50 
51  public:
54 
57 
59 
61  ICLIO_API RSBImageOutput(const std::string &scope, const std::string &transportList = "spread");
62 
64 
66  ICLIO_API void init(const std::string &scope, const std::string &transportList = "spread");
67 
69  ICLIO_API virtual void send(const core::ImgBase *image);
70 
72  inline bool isNull() const { return !m_data; }
73 
75  inline operator bool() const { return static_cast<bool>(m_data); }
76  };
77  } // namespace io
78 }
79 
undocument this line if you encounter any issues!
Definition: Any.h:37
bool isNull() const
returns whether this is a null instance
Definition: RSBImageOutput.h:72
image output implementation using the "Robotics Service Bus (RSB)"
Definition: RSBImageOutput.h:47
ICLIO_API void init(const std::string &scope, const std::string &transportList="spread")
deferred initialization (see RSBImageOutput(const string&,const string&)
#define ICLIO_API
Definition: CompatMacros.h:176
ICLIO_API ~RSBImageOutput()
Destructor.
Data * m_data
pimpl type
Definition: RSBImageOutput.h:48
virtual ICLIO_API void send(const core::ImgBase *image)
sender method
ICLIO_API RSBImageOutput()
creates a null instance
Minimal interface for image output classes.
Definition: ImageOutput.h:54
ImgBase is the Image-Interface class that provides save access to underlying Img-template .
Definition: ImgBase.h:131