Image Component Library (ICL)
FileWriter.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/FileWriter.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>
34 #include <ICLUtils/Uncopyable.h>
35 #include <ICLCore/Types.h>
36 #include <ICLIO/ImageOutput.h>
38 #include <ICLIO/FileWriterPlugin.h>
39 #include <string>
40 #include <map>
41 
42 namespace icl{
43  namespace io{
44 
46 
128  public:
130  friend class FileWriterPluginMapInitializer;
131 
133  FileWriter();
134 
136 
139  FileWriter(const std::string &filepattern);
140 
142  FileWriter(const FilenameGenerator &gen);
143 
145  ~FileWriter();
146 
148  const FilenameGenerator &getFilenameGenerator() const;
149 
151  void write(const core::ImgBase *image);
152 
154  virtual void send(const core::ImgBase *image) { write(image); }
155 
157  FileWriter &operator<<(const core::ImgBase *image);
158 
160 
164  void setOption(const std::string &option, const std::string &value);
165 
166  private:
169 
171  static std::map<std::string,FileWriterPlugin*> s_mapPlugins;
172  };
173 
174  } // namespace io
175 }
176 
undocument this line if you encounter any issues!
Definition: Any.h:37
static std::map< std::string, FileWriterPlugin * > s_mapPlugins
static map of writer plugins
Definition: FileWriter.h:171
virtual void send(const core::ImgBase *image)
wraps write to implement ImageOutput interface
Definition: FileWriter.h:154
FilenameGenerator m_oGen
internal generator for new filenames
Definition: FileWriter.h:168
#define ICLIO_API
Definition: CompatMacros.h:176
File Writer implementation writing images to the hard disc.
Definition: FileWriter.h:127
Utility class for generating a stream of filenames.
Definition: FilenameGenerator.h:52
Minimal interface for image output classes.
Definition: ImageOutput.h:54
std::ostream & operator<<(std::ostream &stream, const FourCC &fourCC)
overloaded ostream operator for type fourCC
Definition: FourCC.h:97
ImgBase is the Image-Interface class that provides save access to underlying Img-template .
Definition: ImgBase.h:131