zebra::camera_sdk::ZebraCameraManager Class Reference

#include <zebra_camera_manager.h>

Public Member Functions
	ZebraCameraManager ()
	~ZebraCameraManager ()
Version	GetVersion ()
std::shared_ptr< ZebraCamera >	CreateZebraCamera (zebra::DeviceInfo camera_info)
std::shared_ptr< ZebraCamera >	Reboot (std::shared_ptr< ZebraCamera > camera, uint16_t timeout=20)
void	DownloadFirmware (std::shared_ptr< ZebraCamera > camera, std::string filepath)
std::shared_ptr< ZebraCamera >	InstallFirmware (std::shared_ptr< ZebraCamera > camera, uint16_t timeout=20)
void	CancelFirmwareDownload (std::shared_ptr< ZebraCamera > camera)
void	AddFirmwareDownloadEventListener (FirmwareDownloadEventListener &firmware_download_event_listener)
void	RemoveFirmwareDownloadEventListener (FirmwareDownloadEventListener &firmware_download_event_listener)
std::string	RetrieveConfiguration (std::shared_ptr< ZebraCamera > camera)
void	RetrieveConfigurationToFile (std::shared_ptr< ZebraCamera > camera, std::string configuration_file_path)
void	LoadConfiguration (std::shared_ptr< ZebraCamera > camera, std::string configuration, bool persist=true)
void	LoadConfigurationFromFile (std::shared_ptr< ZebraCamera > camera, std::string configuration_file_path, bool persist=true)

Detailed Description

Manages Zebra camera devices.

Constructor & Destructor Documentation

ZebraCameraManager()

zebra::camera_sdk::ZebraCameraManager::ZebraCameraManager

(

)

Constructor.

~ZebraCameraManager()

zebra::camera_sdk::ZebraCameraManager::~ZebraCameraManager

(

)

Destructor.

Member Function Documentation

AddFirmwareDownloadEventListener()

void zebra::camera_sdk::ZebraCameraManager::AddFirmwareDownloadEventListener

(

FirmwareDownloadEventListener &

firmware_download_event_listener

)

Add firmware download event listener.

Parameters

firmware_download_event_listener

Reference to the listener object.

CancelFirmwareDownload()

void zebra::camera_sdk::ZebraCameraManager::CancelFirmwareDownload

(

std::shared_ptr< ZebraCamera >

camera

)

Cancel a firmware update.

CreateZebraCamera()

std::shared_ptr<ZebraCamera> zebra::camera_sdk::ZebraCameraManager::CreateZebraCamera

(

zebra::DeviceInfo

camera_info

)

Create a ZebraCamera from the provided CameraInfo.

Parameters

camera_info

Information related to the camera we intend to create.

Returns

ZebraCamera shared pointer on success.

Exceptions

An	exception in an error.

DownloadFirmware()

void zebra::camera_sdk::ZebraCameraManager::DownloadFirmware	(	std::shared_ptr< ZebraCamera >	camera,
		std::string	filepath
	)

Download firmware to Zebra camera.

Parameters

camera	Zebra camera to which firmware should be downloaded.
filepath	Firmware file path.

GetVersion()

Version zebra::camera_sdk::ZebraCameraManager::GetVersion

(

)

Return Camera SDK Version.

InstallFirmware()

std::shared_ptr<ZebraCamera> zebra::camera_sdk::ZebraCameraManager::InstallFirmware	(	std::shared_ptr< ZebraCamera >	camera,
		uint16_t	timeout = 20
	)

Install downloaded firmware.

Parameters

camera	Zebra camera to which the downloaded firmware should be installed.
timeout	Install timeout in seconds.

Returns

The new camera.

LoadConfiguration()

void zebra::camera_sdk::ZebraCameraManager::LoadConfiguration	(	std::shared_ptr< ZebraCamera >	camera,
		std::string	configuration,
		bool	persist = true
	)

Load provided configuration as an XML string to the provided camera.

Parameters

ZebraCamera	Camera which the configuration should writes to.
std::string	Camera configuration as an XML string.
persist	Whether to write the configuration to flash.

LoadConfigurationFromFile()

void zebra::camera_sdk::ZebraCameraManager::LoadConfigurationFromFile	(	std::shared_ptr< ZebraCamera >	camera,
		std::string	configuration_file_path,
		bool	persist = true
	)

Load provided configuration as an XML file (*camcfg) to the provided camera.

Parameters

ZebraCamera	Camera which the configuration should writes to.
std::string	Path to camera configuration file (*camcfg).
persist	Whether to write the configuration to flash.

Reboot()

std::shared_ptr<ZebraCamera> zebra::camera_sdk::ZebraCameraManager::Reboot	(	std::shared_ptr< ZebraCamera >	camera,
		uint16_t	timeout = 20
	)

Reboot the specified ZebraCamera.

Parameters

camera	Zebra camera to reboot.
timeout	Reboot timeout in seconds.

Returns

New camera object.

RetrieveConfiguration()

std::string zebra::camera_sdk::ZebraCameraManager::RetrieveConfiguration

(

std::shared_ptr< ZebraCamera >

camera

)

Retrieve the current configuration of the provided camera and return as an XML.

Parameters

ZebraCamera

camera which the configuration needs to be retrieved from.

Returns

std::string Configuration of the camera as an XML.

RetrieveConfigurationToFile()

void zebra::camera_sdk::ZebraCameraManager::RetrieveConfigurationToFile	(	std::shared_ptr< ZebraCamera >	camera,
		std::string	configuration_file_path
	)

Retrieve the current configuration of the provided camera and save to a *.camcfg file.

Parameters

ZebraCamera	Camera which the configuration needs to be retrieved from.
std::string	Path to the configuration file (*.camcfg).

---

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

• camera_sdk/inc/zebra_camera_manager.h