Point Cloud Library (PCL)  1.7.2
image_metadata_wrapper.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Point Cloud Library (PCL) - www.pointclouds.org
5  * Copyright (c) 2009-2012, Willow Garage, Inc.
6  * Copyright (c) 2012-, Open Perception, Inc.
7  * Copyright (c) 2014, respective authors.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above
18  * copyright notice, this list of conditions and the following
19  * disclaimer in the documentation and/or other materials provided
20  * with the distribution.
21  * * Neither the name of the copyright holder(s) nor the names of its
22  * contributors may be used to endorse or promote products derived
23  * from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  */
39 
40 #pragma once
41 #ifndef PCL_IO_IMAGE_METADATA_WRAPPER_H_
42 #define PCL_IO_IMAGE_METADATA_WRAPPER_H_
43 
44 #include <pcl/pcl_config.h>
45 #include <pcl/pcl_macros.h>
46 
47 namespace pcl
48 {
49  namespace io
50  {
51 
52  /**
53  * Pure abstract interface to wrap native frame data types.
54  */
55  class FrameWrapper
56  {
57  public:
58  typedef boost::shared_ptr<FrameWrapper> Ptr;
59 
60  virtual const void*
61  getData () const = 0;
62 
63  virtual unsigned
64  getDataSize () const = 0;
65 
66  virtual unsigned
67  getWidth () const = 0;
68 
69  virtual unsigned
70  getHeight () const = 0;
71 
72  virtual unsigned
73  getFrameID () const = 0;
74 
75  // Microseconds from some arbitrary start point
76  virtual pcl::uint64_t
77  getTimestamp () const = 0;
78  };
79 
80  } // namespace
81 }
82 
83 #endif // PCL_IO_IMAGE_METADATA_WRAPPER_H_