Zivid::Application Class Reference

Manager class for Zivid More...

#include <Application.h>

Public Member Functions
ZIVID_API	Application ()
	Constructor More...
ZIVID_API	~Application ()
	Destructor More...
ZIVID_API	Application (const Application &other)=delete
ZIVID_API Application &	operator= (const Application &other)=delete
ZIVID_API	Application (Application &&other) noexcept
	Move constructor More...
ZIVID_API Application &	operator= (Application &&other) noexcept
	Move assignment operator More...
ZIVID_API Camera	connectCamera (const Settings &settings={})
	Connect to the next available Zivid camera More...
ZIVID_API Camera	connectCamera (const SerialNumber &serialNumber, const Settings &settings={})
	Connect to the next available Zivid camera More...
ZIVID_API 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 std::vector< Camera >	cameras ()
	Get a list of all cameras More...
ZIVID_API void	setDefaultComputeDevice (ComputeDevice device)
	Set the default compute device to be used for new cameras More...
ZIVID_API ComputeDevice	defaultComputeDevice () const
	The default compute device, used when connecting to new cameras More...

Detailed Description

Manager class for Zivid

Constructor & Destructor Documentation

Application() [1/2]

ZIVID_API Zivid::Application::Application

(

)

Constructor

~Application()

ZIVID_API Zivid::Application::~Application

(

)

Destructor

Application() [2/2]

ZIVID_API Zivid::Application::Application ( Application &&  other )

noexcept

Move constructor

Member Function Documentation

cameras()

ZIVID_API 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 Camera Zivid::Application::connectCamera

(

const Settings &

settings = {}

)

Connect to the next available Zivid camera

Parameters

settings

Settings for the camera

Returns

Zivid camera instance

connectCamera() [2/2]

ZIVID_API 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

createFileCamera()

ZIVID_API 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 ComputeDevice Zivid::Application::defaultComputeDevice

(

)

const

The default compute device, used when connecting to new cameras

Returns

A compute device

operator=()

ZIVID_API Application& Zivid::Application::operator= ( Application &&  other )

noexcept

Move assignment operator

setDefaultComputeDevice()

ZIVID_API void Zivid::Application::setDefaultComputeDevice

(

ComputeDevice

device

)

Set the default compute device to be used for new cameras

Parameters

device

The compute device

---

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

• C:/vagrant/source/cpp/build/install/include/Zivid/Application.h