ome-files  0.5.0
FileInfo.h
1 /*
2  * #%L
3  * OME-FILES C++ library for image IO.
4  * Copyright © 2006 - 2015 Open Microscopy Environment:
5  * - Massachusetts Institute of Technology
6  * - National Institutes of Health
7  * - University of Dundee
8  * - Board of Regents of the University of Wisconsin-Madison
9  * - Glencoe Software, Inc.
10  * %%
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * The views and conclusions contained in the software and documentation are
33  * those of the authors and should not be interpreted as representing official
34  * policies, either expressed or implied, of any organization.
35  * #L%
36  */
37 
38 #ifndef OME_FILES_FILEINFO_H
39 #define OME_FILES_FILEINFO_H
40 
41 #include <string>
42 #include <ostream>
43 
44 #include <boost/filesystem/path.hpp>
45 
46 namespace ome
47 {
48  namespace files
49  {
50 
54  struct FileInfo
55  {
57  boost::filesystem::path filename;
58 
67  std::string reader;
68 
74  };
75 
83  template<class charT, class traits>
84  inline std::basic_ostream<charT,traits>&
85  operator<< (std::basic_ostream<charT,traits>& os,
86  const FileInfo& info)
87  {
88  return os << "filename = " << info.filename
89  << "\nreader = " << info.reader
90  << "\nused to initialize = " << info.usedToInitialize;
91  }
92 
93  }
94 }
95 
96 #endif // OME_FILES_FILEINFO_H
97 
98 /*
99  * Local Variables:
100  * mode:C++
101  * End:
102  */
103 
boost::filesystem::path filename
Absolute path to this file.
Definition: FileInfo.h:57
Basic metadata for a file.
Definition: FileInfo.h:54
Open Microscopy Environment C++.
bool usedToInitialize
true if this file can be passed to the appropriate reader&#39;s FormatReader::setId() method; false if ot...
Definition: FileInfo.h:73
std::string reader
FormatReader implementation used to read this file.
Definition: FileInfo.h:67