Triclops SDK
4.0.3.0
triclopscontext.h
Go to the documentation of this file.
1 //=============================================================================
2 // Copyright © 2016 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
3 //
4 // This software is the confidential and proprietary information of FLIR
5 // Integrated Imaging Solutions, Inc. ("Confidential Information"). You
6 // shall not disclose such Confidential Information and shall use it only in
7 // accordance with the terms of the license agreement you entered into
8 // with FLIR Integrated Imaging Solutions, Inc. (FLIR).
9 //
10 // FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
11 // SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
12 // IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
13 // PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
14 // SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
15 // THIS SOFTWARE OR ITS DERIVATIVES.
16 //=============================================================================
17 
18 //=============================================================================
19 // $Id: triclopscontext.h 309688 2016-12-21 18:28:11Z silvanoa $
20 //=============================================================================
21 
22 //=============================================================================
25 //=============================================================================
26 
27 #ifndef TRICLOPSCONTEXT_H
28 #define TRICLOPSCONTEXT_H
29 
30 //=============================================================================
31 //
32 // This file defines the API for TriclopsContext management functions
33 // within the Triclops Stereo Vision SDK.
34 //
35 //=============================================================================
36 #include "triclops.h"
37 
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42 
43 //=============================================================================
44 // Function Prototypes
45 //=============================================================================
46 
47 //=============================================================================
48 // Triclops Context Manipulation
49 //=============================================================================
50 
80 enum TriclopsError
82  const char *filename);
83 
96 enum TriclopsError
98  void *fileData);
99 
116 enum TriclopsError
118  const char *filename);
119 
135 enum TriclopsError
137  const char *filename);
138 
154 enum TriclopsError
155 triclopsCopyContext(const TriclopsContext contextIn,
156  TriclopsContext *contextOut);
157 
166 enum TriclopsError
168  // End of group TriclopsContext
170 
187 enum TriclopsError
190 
209 enum TriclopsError
212 
226 enum TriclopsError
229 
239 enum TriclopsError
241  int *serialNumber);
242  // End of group CameraConfiguration
244 
245 #ifdef __cplusplus
246 }
247 #endif
248 
249 #endif // #ifndef TRICLOPSCONTEXT_H
enum TriclopsError triclopsSetCameraConfiguration(const TriclopsContext context, TriclopsCameraConfiguration config)
Sets a new camera configuration for the stereo pipeline.
Definition: triclopscontext.cpp:170
enum TriclopsError triclopsCopyContext(const TriclopsContext contextIn, TriclopsContext *contextOut)
Copies the contents of a context to another context.
Definition: triclopscontext.cpp:122
enum TriclopsError triclopsWriteCurrentContextToFile(TriclopsContext context, const char *filename)
Writes on file the current context configuration.
Definition: triclopscontext.cpp:110
TriclopsError
Error enumerator.
Definition: triclopserror.h:46
void * TriclopsContext
Wrapper for the internal C++ Triclops context.
Definition: triclopstype.h:54
TriclopsCameraConfiguration
Sensor configuration enumerator.
Definition: triclopsenum.h:152
enum TriclopsError triclopsGetDefaultContextFromMemory(TriclopsContext *defaultContext, void *fileData)
Sets up a new context using the information retrieved from a configuration file loaded on memory...
Definition: triclopscontext.cpp:71
enum TriclopsError triclopsWriteDefaultContextToFile(TriclopsContext context, const char *filename)
Writes on file the default context configuration.
Definition: triclopscontext.cpp:96
enum TriclopsError triclopsGetCameraConfiguration(const TriclopsContext context, TriclopsCameraConfiguration *config)
Retrieves the current camera configuration for the stereo pipeline.
Definition: triclopscontext.cpp:157
enum TriclopsError triclopsDestroyContext(TriclopsContext context)
Destroys a context.
Definition: triclopscontext.cpp:137
enum TriclopsError triclopsGetSerialNumber(const TriclopsContext context, int *serialNumber)
Retrieves the serial number of the camera associated with a provided context.
Definition: triclopscontext.cpp:194
Triclops operations API.
enum TriclopsError triclopsGetDeviceConfiguration(const TriclopsContext context, TriclopsCameraConfiguration *config)
Retrieves the current camera configuration for the stereo pipeline.
Definition: triclopscontext.cpp:182
enum TriclopsError triclopsGetDefaultContextFromFile(TriclopsContext *defaultContext, const char *filename)
Sets up a new context using the information retrieved from a configuration file.
Definition: triclopscontext.cpp:41
Contact Support Triclops SDK Programmer's Guide and API Reference