Point Cloud Library (PCL)  1.9.1-dev
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 #pragma once
40 
41 #include <pcl/outofcore/boost.h>
42 #include <vector>
43 #include <ostream>
44 
45 namespace pcl
46 {
47  namespace outofcore
48  {
49 
50  /** \class AbstractMetadata
51  *
52  * \brief Abstract interface for outofcore metadata file types
53  *
54  * \ingroup outofcore
55  * \author Stephen Fox (foxstephend@gmail.com)
56  */
57 
59  {
60  public:
61 
62  /** \brief Empty constructor */
64  {
65  }
66 
67  virtual
69  {}
70 
71  /** \brief Write the metadata in the on-disk format, e.g. JSON. */
72  virtual void
73  serializeMetadataToDisk () = 0;
74 
75  /** \brief Method which should read and parse metadata and store
76  * it in variables that have public getters and setters*/
77  virtual int
78  loadMetadataFromDisk (const boost::filesystem::path& path_to_metadata) = 0;
79 
80  /** \brief Should write the same ascii metadata that is saved on
81  * disk, or a human readable format of the metadata in case a binary format is being used */
82  friend std::ostream&
83  operator<<(std::ostream& os, const OutofcoreAbstractMetadata& metadata_arg);
84 
85  protected:
86 
87  /** \brief Constructs the metadata ascii which can be written to disk or piped to stdout */
88  virtual void
89  writeMetadataString (std::vector<char>& buf) =0;
90 
91  };
92 
93  }//namespace outofcore
94 }//namespace pcl
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
OutofcoreAbstractMetadata()
Empty constructor.
Definition: metadata.h:63
std::ostream & operator<<(std::ostream &os, const BivariatePolynomialT< real > &p)
#define PCL_EXPORTS
Definition: pcl_macros.h:241