Zivid::Application Class Reference

Manager class for Zivid More...

#include <Zivid/Application.h>

Public Member Functions
	Application ()
	Constructor More...
ZIVID_API_EXPORT Camera	connectCamera (const Settings &settings={})
	Connect to the next available Zivid camera More...
ZIVID_API_EXPORT Camera	connectCamera (const SerialNumber &serialNumber, const Settings &settings={})
	Connect to the next available Zivid camera More...
ZIVID_API_EXPORT Camera	createFileCamera (const std::string &frameFile, const Settings &settings={})
	Create a virtual camera to simulate Zivid measurements by reading data from a file More...
ZIVID_API_EXPORT std::vector< Camera >	cameras ()
	Get a list of all cameras More...
ZIVID_API_EXPORT void	setDefaultComputeDevice (ComputeDevice device)
	Set the default compute device to be used for new cameras More...
ZIVID_API_EXPORT ComputeDevice	defaultComputeDevice () const
	The default compute device, used when connecting to new cameras More...
ZIVID_API_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_API_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())

connectCamera() [1/2]

ZIVID_API_EXPORT Camera Zivid::Application::connectCamera	(	const SerialNumber &	serialNumber,
		const Settings &	settings = {}
	)

Connect to the next available Zivid camera

Parameters

serialNumber	Connect to the camera with this serial number
settings	Settings for the camera

Returns

Zivid camera instance

connectCamera() [2/2]

ZIVID_API_EXPORT Camera Zivid::Application::connectCamera

(

const Settings &

settings = {}

)

Connect to the next available Zivid camera

Parameters

settings

Settings for the camera

Returns

Zivid camera instance

createFileCamera()

ZIVID_API_EXPORT Camera Zivid::Application::createFileCamera	(	const std::string &	frameFile,
		const Settings &	settings = {}
	)

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

Parameters

frameFile	Data file in ZDF format containing Zivid data
settings	Settings for the virtual camera

Returns

Zivid virtual camera instance

defaultComputeDevice()

ZIVID_API_EXPORT ComputeDevice Zivid::Application::defaultComputeDevice

(

)

const

The default compute device, used when connecting to new cameras

Returns

A compute device

setDefaultComputeDevice()

ZIVID_API_EXPORT void Zivid::Application::setDefaultComputeDevice

(

ComputeDevice

device

)

Set the default compute device to be used for new cameras

Parameters

device

The compute device

toString()

ZIVID_API_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:

• Zivid/Application.h