Time-of-Flight-SDK
frame.h
1 /*
2  * BSD 3-Clause License
3  *
4  * Copyright (c) 2019, Analog Devices, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 #ifndef FRAME_H
33 #define FRAME_H
34 
35 #include "frame_definitions.h"
36 #include "sdk_exports.h"
37 #include "status_definitions.h"
38 
39 #include <memory>
40 
41 class FrameImpl;
42 
43 namespace aditof {
44 
49 class Frame {
50  public:
54  SDK_API Frame();
55 
59  SDK_API ~Frame();
60 
64  SDK_API Frame(const Frame &op);
65 
69  SDK_API Frame &operator=(const Frame &op);
70 
74  SDK_API Frame(Frame &&) noexcept;
75 
79  SDK_API Frame &operator=(Frame &&) noexcept;
80 
81  public:
87  SDK_API Status setDetails(const FrameDetails &details);
88 
94  SDK_API Status getDetails(FrameDetails &details) const;
95 
102  SDK_API Status getData(FrameDataType dataType, uint16_t **dataPtr);
103 
104  private:
105  std::unique_ptr<FrameImpl> m_impl;
106 };
107 
108 } // namespace aditof
109 
110 #endif // FRAME_H
SDK_API Status getData(FrameDataType dataType, uint16_t **dataPtr)
Gets the address where the specified data is being stored.
Namespace aditof.
Definition: frame.h:43
SDK_API Status getDetails(FrameDetails &details) const
Gets the current details of the frame.
SDK_API Frame()
Constructor.
FrameDataType
Types of data that a frame can contain.
SDK_API ~Frame()
Destructor.
Frame of a camera.
Definition: frame.h:49
Status
Status of any operation that the TOF sdk performs.
SDK_API Frame & operator=(const Frame &op)
Copy assignment.
SDK_API Status setDetails(const FrameDetails &details)
Configures the frame with the given details.
Describes the properties of a frame.