Zivid C++ API  2.4.2+1a2e8cfb-1
Defining the Future of 3D Machine Vision
Application.h
Go to the documentation of this file.
1 
2 
3 /*******************************************************************************
4 
5  * This file is part of the Zivid 3D Camera API
6 
7  *
8 
9  * Copyright 2015-2021 (C) Zivid AS
10 
11  * All rights reserved.
12 
13  *
14 
15  * Zivid Software License, v1.0
16 
17  *
18 
19  * Redistribution and use in source and binary forms, with or without
20 
21  * modification, are permitted provided that the following conditions are met:
22 
23  *
24 
25  * 1. Redistributions of source code must retain the above copyright notice,
26 
27  * this list of conditions and the following disclaimer.
28 
29  *
30 
31  * 2. Redistributions in binary form must reproduce the above copyright notice,
32 
33  * this list of conditions and the following disclaimer in the documentation
34 
35  * and/or other materials provided with the distribution.
36 
37  *
38 
39  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
40 
41  * to endorse or promote products derived from this software without specific
42 
43  * prior written permission.
44 
45  *
46 
47  * 4. This software, with or without modification, must not be used with any
48 
49  * other 3D camera than from Zivid AS.
50 
51  *
52 
53  * 5. Any software provided in binary form under this license must not be
54 
55  * reverse engineered, decompiled, modified and/or disassembled.
56 
57  *
58 
59  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
60 
61  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
62 
63  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
64 
65  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
66 
67  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 
69  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70 
71  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72 
73  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
74 
75  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76 
77  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78 
79  *
80 
81  * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
82 
83  * Info: http://www.zivid.com
84 
85  ******************************************************************************/
86 
87 
88 
89 #pragma once
90 
91 #include "Zivid/Camera.h"
92 #include "Zivid/ComputeDevice.h"
94 #include "Zivid/Detail/Pimpl.h"
95 #include "Zivid/Version.h"
96 
98 namespace Zivid
99 {
100  class SerialNumber;
101 
106  {
107  ZIVID_PIMPL_MOVE_ONLY(Application, ZIVID_CORE_EXPORT);
108 
109  private:
110  ZIVID_CORE_EXPORT Application(const std::string &headerVersion);
111 
112  public:
116  {}
117 
121 
126 
133  ZIVID_CORE_EXPORT Camera createFileCamera(const std::string &cameraFile);
134 
138  ZIVID_CORE_EXPORT std::vector<Camera> cameras();
139 
143 
146  ZIVID_CORE_EXPORT std::string toString() const;
147  };
148 } // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
#define ZIVID_CORE_VERSION
Zivid version string
Definition: Version.h:107
Manager class for Zivid
Definition: Application.h:106
ZIVID_CORE_EXPORT Camera createFileCamera(const std::string &cameraFile)
Create a virtual camera to simulate Zivid measurements by reading data from a file
ZIVID_CORE_EXPORT Camera connectCamera()
Connect to the next available Zivid camera
ZIVID_CORE_EXPORT ComputeDevice computeDevice() const
The default compute device, used when connecting to new cameras
ZIVID_CORE_EXPORT Camera connectCamera(const CameraInfo::SerialNumber &serialNumber)
Connect to the Zivid camera with the specified serial number
ZIVID_CORE_EXPORT std::vector< Camera > cameras()
Get a list of all cameras
ZIVID_CORE_EXPORT std::string toString() const
Get string representation of the application
Application()
Constructor
Definition: Application.h:114
The serial number of the camera
Definition: CameraInfo.h:687
Interface to one Zivid camera
Definition: Camera.h:113
Contains information about the compute device used by Zivid::Application.
Definition: ComputeDevice.h:103
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99