This class implements as singleton-based manager which allows to access all available devices. More...

#include <Manager.h>

Inheritance diagram for Ocean::Devices::Manager:

Data Structures
class	AdhocFactory
	This class implements an ad-hoc factory for devices which are implemented outside of an own library e.g., during rapid prototyping. More...

Public Types
using	AdhocInstanceFunction = Factory::InstanceFunction
	Definition of a callback function creating an ad-hoc device.

Public Member Functions
DeviceRef	device (const std::string &name, const bool useExclusive=false)
	Returns a specific device.

DeviceRef	device (const Device::DeviceType type, const bool useExclusive=false)
	Returns a specified device.

Strings	devices () const
	Returns a list with the names of all available devices.

Strings	devices (const Device::DeviceType type) const
	Returns a list with the names of all available devices matching a major and minor device type.

bool	isRegistered (const std::string &library)
	Returns whether a specified library is registered at this manager.

Strings	libraries () const
	Returns the names of all registered libraries.

std::string	objectDescription (const Measurement::ObjectId objectId) const
	Returns the description of an object id.

void	release ()
	Destructs all registered libraries and their corresponding factories.

bool	registerAdhocDevice (const std::string &deviceName, const Device::DeviceType &deviceType, const AdhocInstanceFunction &deviceInstanceFunction)
	Registes an ad-hoc device at this manager.

bool	unregisterAdhocDevice (const std::string &deviceName)
	Unregisters a previously registered ad-hoc device from this manager.

Static Public Member Functions
static std::string	nameAdhocFactory ()
	Returns the name of the ad-hoc factory.

Static Public Member Functions inherited from Ocean::Singleton< Manager >
static Manager &	get ()
	Returns a reference to the unique object.

Protected Types
typedef std::vector< std::unique_ptr< Factory > >	FactoryUniquePointers
	Definition of a vector holding unique pointers of factories.

typedef std::unordered_multimap< Measurement::ObjectId, std::string >	ObjectIdMultimap
	Definition of an unsorted multimap mapping object ids to descriptions.

Private Member Functions
	Manager ()
	Creates a new manager object.

virtual	~Manager ()
	Destructs a manager object.

Measurement::ObjectId	createUniqueObjectId (const std::string &description)
	Creates a unique object id for a new object (e.g., a tracking object like an image, a marker, or a location).

bool	registerFactory (std::unique_ptr< Factory > &&factory)
	Registers a new factory.

bool	unregisterFactory (const std::string &factory)
	Unregisters a factory.

Factory *	factory (const std::string &name, TemporaryScopedLock &scopedLock)
	Returns a specified factory.

Private Attributes
ObjectIdMultimap	objectIdMultimap_
	The map mapping object ids to descriptions.

Measurement::ObjectId	uniqueObjectIdCounter_ = Measurement::ObjectId(0)
	The counter for unique object ids.

FactoryUniquePointers	factories_
	All registered device factories.

Lock	lock_
	The Manager's lock.

Friends
class	Singleton< Manager >

class	Factory

class	Measurement

Additional Inherited Members
Protected Member Functions inherited from Ocean::Singleton< Manager >
	Singleton ()=default
	Default constructor.

Detailed Description

This class implements as singleton-based manager which allows to access all available devices.

Member Typedef Documentation

◆ AdhocInstanceFunction

using Ocean::Devices::Manager::AdhocInstanceFunction = Factory::InstanceFunction

Definition of a callback function creating an ad-hoc device.

◆ FactoryUniquePointers

typedef std::vector<std::unique_ptr<Factory> > Ocean::Devices::Manager::FactoryUniquePointers

protected

Definition of a vector holding unique pointers of factories.

◆ ObjectIdMultimap

typedef std::unordered_multimap<Measurement::ObjectId, std::string> Ocean::Devices::Manager::ObjectIdMultimap

protected

Definition of an unsorted multimap mapping object ids to descriptions.

Constructor & Destructor Documentation

◆ Manager()

Ocean::Devices::Manager::Manager ( )

private

Creates a new manager object.

◆ ~Manager()

virtual Ocean::Devices::Manager::~Manager ( )

privatevirtual

Destructs a manager object.

Member Function Documentation

◆ createUniqueObjectId()

Measurement::ObjectId Ocean::Devices::Manager::createUniqueObjectId ( const std::string & description )

private

Creates a unique object id for a new object (e.g., a tracking object like an image, a marker, or a location).

Parameters

description The description of the new object, must be valid

Returns: The unique id which is unique across all devices

◆ device() [1/2]

DeviceRef Ocean::Devices::Manager::device	(	const Device::DeviceType	type,
		const bool	useExclusive = `false`
	)

Returns a specified device.

Parameters

type	The major type of the device to return
useExclusive	True, if the caller would like to use this device exclusively; False, if the device can be shared

Returns: The requested device, if available

◆ device() [2/2]

DeviceRef Ocean::Devices::Manager::device	(	const std::string &	name,
		const bool	useExclusive = `false`
	)

Returns a specific device.

Parameters

name	The name of the device to return, must be valid
useExclusive	True, if the caller would like to use this device exclusively; False, if the device can be shared

Returns: The requested device, if available

◆ devices() [1/2]

Strings Ocean::Devices::Manager::devices ( ) const

Returns a list with the names of all available devices.

Returns: Device names

◆ devices() [2/2]

Strings Ocean::Devices::Manager::devices ( const Device::DeviceType type ) const

Returns a list with the names of all available devices matching a major and minor device type.

Parameters

type	Type of the device to return

Returns: Device names

◆ factory()

Factory * Ocean::Devices::Manager::factory	(	const std::string &	name,
		TemporaryScopedLock &	scopedLock
	)

private

Returns a specified factory.

Parameters

name	The name of the factory to return, must be valid
scopedLock	The scoped lock which will be used to lock access the access to the factor, needs to be released as soon as possible

Returns: The requested factory, nullptr if the factory does not exist

◆ isRegistered()

bool Ocean::Devices::Manager::isRegistered ( const std::string & library )

Returns whether a specified library is registered at this manager.

Parameters

library Name of the library to check

Returns: True, if so

◆ libraries()

Strings Ocean::Devices::Manager::libraries ( ) const

Returns the names of all registered libraries.

Returns: Registered library names

◆ nameAdhocFactory()

static std::string Ocean::Devices::Manager::nameAdhocFactory ( )

static

Returns the name of the ad-hoc factory.

The ad-hoc factory is for devices which are implemented outside of an own library e.g., during rapid prototyping.

Returns: The name of the ad-hoc factor

◆ objectDescription()

std::string Ocean::Devices::Manager::objectDescription ( const Measurement::ObjectId objectId ) const

Returns the description of an object id.

Parameters

objectId The object id for which the description will be returned

Returns: The description of the object, empty if the object id is unknown

◆ registerAdhocDevice()

bool Ocean::Devices::Manager::registerAdhocDevice	(	const std::string &	deviceName,
		const Device::DeviceType &	deviceType,
		const AdhocInstanceFunction &	deviceInstanceFunction
	)

Registes an ad-hoc device at this manager.

In general, devices should be implemented in an own decicated plugin-based library. However, for prototyping an ad-hoc device cames with the same features as a device implemented in a dedicatd library without the overhead of writing the code for the plugin mechanisms etc.

Parameters

deviceName	Unique name of the device to register
deviceType	Type of the device
deviceInstanceFunction	Function creating an instance of the device

See also: unregisterAdhocDevice().

◆ registerFactory()

bool Ocean::Devices::Manager::registerFactory ( std::unique_ptr< Factory > && factory )

private

Registers a new factory.

Parameters

factory The factory to register

Returns: True, if the factory hasn't been registered before

◆ release()

void Ocean::Devices::Manager::release ( )

Destructs all registered libraries and their corresponding factories.

◆ unregisterAdhocDevice()

bool Ocean::Devices::Manager::unregisterAdhocDevice ( const std::string & deviceName )

Unregisters a previously registered ad-hoc device from this manager.

Beware: Ensure that the device is not used anymore before unregistering it.

Parameters

deviceName The name of the device to unregister, must be valid

Returns: True, if succeeded

See also: registerAdhocDevice().

◆ unregisterFactory()

bool Ocean::Devices::Manager::unregisterFactory ( const std::string & factory )

private

Unregisters a factory.

Parameters

factory Name of the factory to unregister

Returns: True, if succeeded

Friends And Related Symbol Documentation

◆ Factory

friend class Factory

friend

◆ Measurement

friend class Measurement

friend

◆ Singleton< Manager >

friend class Singleton< Manager >

friend

Field Documentation

◆ factories_

FactoryUniquePointers Ocean::Devices::Manager::factories_

private

All registered device factories.

◆ lock_

Lock Ocean::Devices::Manager::lock_

mutableprivate

The Manager's lock.

◆ objectIdMultimap_

ObjectIdMultimap Ocean::Devices::Manager::objectIdMultimap_

private

The map mapping object ids to descriptions.

◆ uniqueObjectIdCounter_

Measurement::ObjectId Ocean::Devices::Manager::uniqueObjectIdCounter_ = Measurement::ObjectId(0)

private

The counter for unique object ids.

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

devices/Manager.h

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AdhocInstanceFunction

◆ FactoryUniquePointers

◆ ObjectIdMultimap

Constructor & Destructor Documentation

◆ Manager()

◆ ~Manager()

Member Function Documentation

◆ createUniqueObjectId()

◆ device() [1/2]

◆ device() [2/2]

◆ devices() [1/2]

◆ devices() [2/2]

◆ factory()

◆ isRegistered()

◆ libraries()

◆ nameAdhocFactory()

◆ objectDescription()

◆ registerAdhocDevice()

◆ registerFactory()

◆ release()

◆ unregisterAdhocDevice()

◆ unregisterFactory()

Friends And Related Symbol Documentation

◆ Factory

◆ Measurement

◆ Singleton< Manager >

Field Documentation

◆ factories_

◆ lock_

◆ objectIdMultimap_

◆ uniqueObjectIdCounter_