Time-of-Flight-SDK
system.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 SYSTEM_H
33 #define SYSTEM_H
34 
35 #include "sdk_exports.h"
36 #include "status_definitions.h"
37 
38 #include <memory>
39 #include <string>
40 #include <vector>
41 
42 class SystemImpl;
43 
44 namespace aditof {
45 
46 class Camera;
47 
52 class System {
53  public:
57  SDK_API System();
58 
62  SDK_API ~System();
63 
64  // Make System movable and non-copyable
68  SDK_API System(System &&op) noexcept;
69 
73  SDK_API System &operator=(System &&op) noexcept;
74 
75  public:
82  SDK_API Status
83  getCameraList(std::vector<std::shared_ptr<Camera>> &cameraList) const;
84 
92  SDK_API Status
93  getCameraListAtIp(std::vector<std::shared_ptr<Camera>> &cameraList,
94  const std::string &ip) const;
95 
96  private:
97  std::unique_ptr<SystemImpl> m_impl;
98 };
99 
100 } // namespace aditof
101 
102 #endif // SYSTEM_H
SDK_API ~System()
Destructor.
Namespace aditof.
Definition: frame.h:43
SDK_API System & operator=(System &&op) noexcept
Move assignment.
SDK_API System()
Constructor.
SDK_API Status getCameraList(std::vector< std::shared_ptr< Camera >> &cameraList) const
Populates the given list with Camera objects that correspond to the available cameras.
The TOF system that manages the cameras.
Definition: system.h:52
Status
Status of any operation that the TOF sdk performs.
SDK_API Status getCameraListAtIp(std::vector< std::shared_ptr< Camera >> &cameraList, const std::string &ip) const
Populates the given list with Camera objects that correspond to the available cameras from the remote...