Point Cloud Library (PCL)  1.7.1
metadata.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Point Cloud Library (PCL) - www.pointclouds.org
5  * Copyright (c) 2010-2012, Willow Garage, Inc.
6  *
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * * Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following
17  * disclaimer in the documentation and/or other materials provided
18  * with the distribution.
19  * * Neither the name of Willow Garage, Inc. nor the names of its
20  * contributors may be used to endorse or promote products derived
21  * from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  * $Id$
37  */
38 
39 
40 #ifndef PCL_OUTOFCORE_METADATA_H_
41 #define PCL_OUTOFCORE_METADATA_H_
42 
43 #include <pcl/outofcore/boost.h>
44 #include <vector>
45 #include <ostream>
46 
47 namespace pcl
48 {
49  namespace outofcore
50  {
51 
52  /** \class AbstractMetadata
53  *
54  * \brief Abstract interface for outofcore metadata file types
55  *
56  * \ingroup outofcore
57  * \author Stephen Fox (foxstephend@gmail.com)
58  */
59 
60  class PCL_EXPORTS OutofcoreAbstractMetadata
61  {
62  public:
63 
64  /** \brief Empty constructor */
66  {
67  }
68 
69  virtual
71  {}
72 
73  /** \brief Write the metadata in the on-disk format, e.g. JSON. */
74  virtual void
75  serializeMetadataToDisk () = 0;
76 
77  /** \brief Method which should read and parse metadata and store
78  * it in variables that have public getters and setters*/
79  virtual int
80  loadMetadataFromDisk (const boost::filesystem::path& path_to_metadata) = 0;
81 
82  /** \brief Should write the same ascii metadata that is saved on
83  * disk, or a human readable format of the metadata in case a binary format is being used */
84  friend std::ostream&
85  operator<<(std::ostream& os, const OutofcoreAbstractMetadata& metadata_arg);
86 
87  protected:
88 
89  /** \brief Constructs the metadata ascii which can be written to disk or piped to stdout */
90  virtual void
91  writeMetadataString (std::vector<char>& buf) =0;
92 
93  };
94 
95  }//namespace outofcore
96 }//namespace pcl
97 
98 #endif //PCL_OUTOFCORE_METADATA_H_