Zivid C++ API  1.4.0+956f554d-12
Defining the Future of 3D Machine Vision
Namespaces | Classes | Functions
Zivid Namespace Reference

The main Zivid namespace. All Zivid code is found here More...

Namespaces

 Environment
 Zivid environment, configured through environment variables
 
 Experimental
 
 Firmware
 
 HDR
 Contains a global HDR method.
 
 Version
 Get version information for the library
 

Classes

class  Application
 Manager class for Zivid More...
 
class  ArgumentException
 An exception that is thrown when an argument provided to a method is invalid. More...
 
class  Camera
 Interface to one Zivid camera More...
 
class  CameraIntrinsics
 Information about the intrinsic parameters of the camera (OpenCV model) More...
 
class  CameraRevision
 Camera revision More...
 
class  CameraState
 Information about camera connection state, live mode, temperatures, etc. More...
 
class  CloudVisualizer
 Simple visualization component for point clouds (residing either on the Compute device or on the CPU) More...
 
class  ComputeDevice
 Compute device on which to allocate a device point cloud More...
 
class  DeviceCloud
 Point cloud on the Compute device More...
 
class  Exception
 A common base class for all Zivid exceptions. More...
 
class  Frame
 A frame captured by a Zivid camera More...
 
class  FrameInfo
 Various information for a frame More...
 
class  IOException
 An exception that is thrown whenever an I/O error occurs. More...
 
class  LogicException
 An exception that is thrown when attempting to do an operation that doesn't make sense in the current execution context. More...
 
class  Point
 A 3D point with contrast and RGBA values More...
 
class  PointCloud
 A point cloud with x,y,z, contrast and color data laid out on a 2D grid. More...
 
class  Range
 Class describing a range of values for a given type T The range boudaries for both minimum and maximum are inclusive /summary> More...
 
class  RuntimeException
 An exception that is thrown when an unpredictable event caused an operation to fail. More...
 
class  SerialNumber
 Serial number of a Zivid camera More...
 
class  Settings
 Settings for a Zivid camera More...
 
class  SettingsBatch
 Helper class to a apply a batch of settings changes to a camera More...
 

Functions

ZIVID_API_EXPORT std::ostream & operator<< (std::ostream &stream, const Camera &camera)
 Serialize the value to a stream More...
 
template<typename Setting >
SettingsBatch operator<< (Camera &camera, Setting value)
 Apply a setting to camera More...
 
ZIVID_API_EXPORT std::ostream & operator<< (std::ostream &stream, const CameraRevision &cameraRevision)
 Serialize the value to a stream More...
 
ZIVID_API_EXPORT std::ostream & operator<< (std::ostream &stream, const ComputeDevice &computeDevice)
 Serialize the value to a stream More...
 
ZIVID_API_EXPORT std::string toString (const std::exception &exception)
 Get string representation of the exception More...
 
template<typename T >
std::ostream & operator<< (std::ostream &os, const Range< T > &range)
 Append the range to a stream More...
 
ZIVID_API_EXPORT std::ostream & operator<< (std::ostream &os, const SerialNumber &serialNumber)
 Serialize serial number to a stream More...
 

Detailed Description

The main Zivid namespace. All Zivid code is found here

Function Documentation

◆ operator<<() [1/6]

ZIVID_API_EXPORT std::ostream& Zivid::operator<< ( std::ostream &  os,
const SerialNumber serialNumber 
)

Serialize serial number to a stream

Parameters
osTarget std::ostream
serialNumberSerial number

◆ operator<<() [2/6]

ZIVID_API_EXPORT std::ostream& Zivid::operator<< ( std::ostream &  stream,
const CameraRevision cameraRevision 
)

Serialize the value to a stream

◆ operator<<() [3/6]

template<typename T >
std::ostream& Zivid::operator<< ( std::ostream &  os,
const Range< T > &  range 
)

Append the range to a stream

◆ operator<<() [4/6]

ZIVID_API_EXPORT std::ostream& Zivid::operator<< ( std::ostream &  stream,
const ComputeDevice computeDevice 
)

Serialize the value to a stream

◆ operator<<() [5/6]

ZIVID_API_EXPORT std::ostream& Zivid::operator<< ( std::ostream &  stream,
const Camera camera 
)

Serialize the value to a stream

◆ operator<<() [6/6]

template<typename Setting >
SettingsBatch Zivid::operator<< ( Camera camera,
Setting  value 
)

Apply a setting to camera

Additional settings passed using operator<< will we be applied in the same update command to camera.

◆ toString()

ZIVID_API_EXPORT std::string Zivid::toString ( const std::exception &  exception)

Get string representation of the exception

Returns
The exceptions as a string, potential nested exceptions are included as well