Zivid C++ API  2.4.2+1a2e8cfb-1
Defining the Future of 3D Machine Vision
Public Member Functions | List of all members
Zivid::Application Class Reference

Manager class for Zivid More...

#include <Zivid/Application.h>

Public Member Functions

 Application ()
 Constructor More...
 
ZIVID_CORE_EXPORT Camera connectCamera ()
 Connect to the next available Zivid camera More...
 
ZIVID_CORE_EXPORT Camera connectCamera (const CameraInfo::SerialNumber &serialNumber)
 Connect to the Zivid camera with the specified serial number More...
 
ZIVID_CORE_EXPORT Camera createFileCamera (const std::string &cameraFile)
 Create a virtual camera to simulate Zivid measurements by reading data from a file More...
 
ZIVID_CORE_EXPORT std::vector< Cameracameras ()
 Get a list of all cameras More...
 
ZIVID_CORE_EXPORT ComputeDevice computeDevice () const
 The default compute device, used when connecting to new cameras More...
 
ZIVID_CORE_EXPORT std::string toString () const
 Get string representation of the application More...
 

Detailed Description

Manager class for Zivid

Constructor & Destructor Documentation

◆ Application()

Zivid::Application::Application ( )
inline

Constructor

Member Function Documentation

◆ cameras()

ZIVID_CORE_EXPORT std::vector<Camera> Zivid::Application::cameras ( )

Get a list of all cameras

Returns
A list of cameras including all physical cameras as well as virtual ones (e.g. cameras created by createFileCamera())

◆ computeDevice()

ZIVID_CORE_EXPORT ComputeDevice Zivid::Application::computeDevice ( ) const

The default compute device, used when connecting to new cameras

Returns
A compute device

◆ connectCamera() [1/2]

ZIVID_CORE_EXPORT Camera Zivid::Application::connectCamera ( )

Connect to the next available Zivid camera

Returns
Zivid camera instance

◆ connectCamera() [2/2]

ZIVID_CORE_EXPORT Camera Zivid::Application::connectCamera ( const CameraInfo::SerialNumber serialNumber)

Connect to the Zivid camera with the specified serial number

Parameters
serialNumberConnect to the camera with this serial number
Returns
Zivid camera instance

◆ createFileCamera()

ZIVID_CORE_EXPORT Camera Zivid::Application::createFileCamera ( const std::string &  cameraFile)

Create a virtual camera to simulate Zivid measurements by reading data from a file

Parameters
cameraFileData file in ZFC format containing a Zivid File Camera
Returns
Zivid virtual camera instance

An example file camera may be found at zivid.com/downloads

◆ toString()

ZIVID_CORE_EXPORT std::string Zivid::Application::toString ( ) const

Get string representation of the application

Returns
Applicaton info as string

The documentation for this class was generated from the following file: