Point Cloud Library (PCL)  1.14.1-dev
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 
42 #include <pcl/memory.h>
43 #include <pcl/pcl_config.h>
44 
45 namespace pcl
46 {
47  namespace io
48  {
49 
50  /**
51  * Pure abstract interface to wrap native frame data types.
52  */
54  {
55  public:
56  using Ptr = shared_ptr<FrameWrapper>;
57  using ConstPtr = shared_ptr<const FrameWrapper>;
58 
59  virtual
60  ~FrameWrapper() = default;
61 
62  virtual const void*
63  getData () const = 0;
64 
65  virtual unsigned
66  getDataSize () const = 0;
67 
68  virtual unsigned
69  getWidth () const = 0;
70 
71  virtual unsigned
72  getHeight () const = 0;
73 
74  virtual unsigned
75  getFrameID () const = 0;
76 
77  // Microseconds from some arbitrary start point
78  virtual std::uint64_t
79  getTimestamp () const = 0;
80  };
81 
82  } // namespace
83 }
84 
Pure abstract interface to wrap native frame data types.
virtual unsigned getWidth() const =0
virtual ~FrameWrapper()=default
virtual std::uint64_t getTimestamp() const =0
virtual unsigned getFrameID() const =0
virtual unsigned getDataSize() const =0
virtual const void * getData() const =0
virtual unsigned getHeight() const =0
shared_ptr< const FrameWrapper > ConstPtr
shared_ptr< FrameWrapper > Ptr
Defines functions, macros and traits for allocating and using memory.