HAL Plugin API

class Plugin

Content of a plugin.

Public Functions

~Plugin()

Destructor.

const std::string &get_plugin_name() const

Provides the plugin name.

Returns

The name of the plugin

const std::string &get_integrator_name() const

Gets the integrator name.

Returns

The name of the camera integrator that the plugin handle

void set_integrator_name(const std::string &integrator_name)

Sets the integrator name.

Parameters

integrator_name – The name of the camera integrator that the plugin handle

template<typename CameraDiscoveryType>
inline CameraDiscoveryType &add_camera_discovery(std::unique_ptr<CameraDiscoveryType> p)

Appends the camera discovery to the list.

Template Parameters

CameraDiscoveryType – Type of CameraDiscovery

Parameters

p – The camera discovery to add

Returns

T& A reference to the added camera discovery for convenience

template<typename FileDiscoveryType>
inline FileDiscoveryType &add_file_discovery(std::unique_ptr<FileDiscoveryType> p)

Appends the file discovery to the list.

Template Parameters

FileDiscoveryType – Type of FileDiscovery

Parameters

p – The file discovery to add

Returns

T& A reference to the added file discovery for convenience

const SoftwareInfo &get_plugin_info() const

Returns information about the plugin’s software.

Returns

Plugin software info

void set_plugin_info(const SoftwareInfo &info)

Sets the plugin software info.

Parameters

info – Plugin software info

const SoftwareInfo &get_hal_info() const

Returns information about the hal software with which the plugin was compiled.

Returns

Hal software info

void set_hal_info(const SoftwareInfo &info)

Sets the HAL software info.

Parameters

info – HAL software info