This class implements a factory able to create instances of devices. More...

#include <Factory.h>

Inheritance diagram for Ocean::Devices::Factory:

Data Structures
class	DeviceDescriptor
	This class stores information to describe and to creator a device. More...

Public Member Functions
const std::string &	name () const
	Returns the name of this factory.

Protected Types
using	InstanceFunction = Callback< Device *, const std::string &, const Device::DeviceType & >
	Definition of a callback function creating a specific device.

using	DeviceDescriptors = std::vector< DeviceDescriptor >
	Definition of a vector holding device descriptor objects.

Protected Member Functions
	Factory (const Factory &factory)=delete
	Disabled copy constructor.

	Factory (const std::string &name)
	Creates a new factory.

virtual	~Factory ()
	Destructs this factory.

virtual Strings	devices () const
	Returns a list of available devices.

virtual Strings	devices (const Device::DeviceType type) const
	Returns a list of available devices matching a specified major device type.

virtual Device::DeviceType	deviceType (const std::string &device) const
	Returns the type of a specified device.

virtual DeviceRef	device (const std::string &name, const bool useExclusive=false) const
	Creates a new device by its name or returns an existing one if an exclusive use is not necessary.

virtual DeviceRef	device (const Device::DeviceType type, const bool useExclusive=false)
	Creates a new device defined by a major and a minor device type or returns an existing one if an exclusive use is not necessary.

DeviceRef	adapterDevice (const Device::DeviceType type, const std::string &name)
	Returns a new adapter measurement device, which is exclusive always.

Factory &	operator= (const Factory &factory)=delete
	Disabled copy operator.

bool	registerDevice (const std::string &deviceName, const Device::DeviceType deviceType, const InstanceFunction &deviceInstanceFunction, const unsigned int priority=100u)
	Registes a device at this factory.

bool	unregisterDevice (const std::string &deviceName)
	Unregisters a previously registered device from this factory.

Static Protected Member Functions
static bool	registerFactory (std::unique_ptr< Factory > &&factory)
	Registers a factory at the manager.

static bool	unregisterFactory (const std::string &factory)
	Unregisters a factory at the manager.

static DeviceRef	createDevice (const DeviceDescriptor &deviceDescriptor, bool useExclusive)
	Creates a new device by a given device triple.

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

Private Attributes
std::string	name_
	The factory's name.

DeviceDescriptors	deviceDescriptors_
	Vector holding all registered devices with name and type.

Lock	lock_
	Factory lock.

Friends
class	Manager

struct	std::default_delete< Factory >

Detailed Description

This class implements a factory able to create instances of devices.

Member Typedef Documentation

◆ DeviceDescriptors

using Ocean::Devices::Factory::DeviceDescriptors = std::vector<DeviceDescriptor>

protected

Definition of a vector holding device descriptor objects.

◆ InstanceFunction

using Ocean::Devices::Factory::InstanceFunction = Callback<Device*, const std::string&, const Device::DeviceType&>

protected

Definition of a callback function creating a specific device.

Constructor & Destructor Documentation

◆ Factory() [1/2]

Ocean::Devices::Factory::Factory ( const Factory & factory )

protecteddelete

Disabled copy constructor.

Parameters

factory Object which would be copied

◆ Factory() [2/2]

Ocean::Devices::Factory::Factory ( const std::string & name )

explicitprotected

Creates a new factory.

Parameters

name	The name of the factory to create

◆ ~Factory()

virtual Ocean::Devices::Factory::~Factory ( )

protectedvirtual

Destructs this factory.

Member Function Documentation

◆ adapterDevice()

DeviceRef Ocean::Devices::Factory::adapterDevice	(	const Device::DeviceType	type,
		const std::string &	name
	)

protected

Returns a new adapter measurement device, which is exclusive always.

Parameters

type	Type of the device to return
name	Unique name of the resulting adapter device, this name will be assigned to the new adapter device

◆ createDevice()

static DeviceRef Ocean::Devices::Factory::createDevice	(	const DeviceDescriptor &	deviceDescriptor,
		bool	useExclusive
	)

staticprotected

Creates a new device by a given device triple.

Parameters

deviceDescriptor	The descriptor of the device to be created
useExclusive	Determines whether the device will be used exclusively

Returns: New device if succeeded

◆ device() [1/2]

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

protectedvirtual

Creates a new device defined by a major and a minor device type or returns an existing one if an exclusive use is not necessary.

Parameters

type	Type of the device to return
useExclusive	Determines whether the device will be used exclusively

Returns: Requested device

◆ device() [2/2]

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

protectedvirtual

Creates a new device by its name or returns an existing one if an exclusive use is not necessary.

Parameters

name	The name of the device to create
useExclusive	Determines whether the device will be used exclusively

Returns: Requested device

◆ devices() [1/2]

virtual Strings Ocean::Devices::Factory::devices ( ) const

protectedvirtual

Returns a list of available devices.

Returns: Device list

◆ devices() [2/2]

virtual Strings Ocean::Devices::Factory::devices ( const Device::DeviceType type ) const

protectedvirtual

Returns a list of available devices matching a specified major device type.

Parameters

type	Type to return device names for

Returns: Device list

◆ deviceType()

virtual Device::DeviceType Ocean::Devices::Factory::deviceType ( const std::string & device ) const

protectedvirtual

Returns the type of a specified device.

Parameters

device Name of the device to return the type for

Returns: Device type holding major and minor type

◆ factory()

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

staticprotected

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

◆ name()

const std::string & Ocean::Devices::Factory::name ( ) const

inline

Returns the name of this factory.

◆ operator=()

Factory & Ocean::Devices::Factory::operator= ( const Factory & factory )

protecteddelete

Disabled copy operator.

Parameters

factory Object which would be copied

Returns: Reference to this object

◆ registerDevice()

bool Ocean::Devices::Factory::registerDevice	(	const std::string &	deviceName,
		const Device::DeviceType	deviceType,
		const InstanceFunction &	deviceInstanceFunction,
		const unsigned int	priority = `100u`
	)

protected

Registes a device at this factory.

Parameters

deviceName	Unique name of the device to register
deviceType	Type of the device
deviceInstanceFunction	Function creating an instance of the device
priority	The priority of the device, in case two devices are equivalent, the device with the higher priority will be used

See also: unregisterDevice().

◆ registerFactory()

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

staticprotected

Registers a factory at the manager.

Each factory should be registered at most once.

Parameters

factory The factory to register

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

◆ unregisterDevice()

bool Ocean::Devices::Factory::unregisterDevice ( const std::string & deviceName )

protected

Unregisters a previously registered device from this factory.

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: registerDevice().

◆ unregisterFactory()

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

staticprotected

Unregisters a factory at the manager.

Beware: All devices created by the factory must be released before,
otherwise the factory cannot be unregistered.

Parameters

factory Name of the factory to unregister

Returns: True, if the factory could be unregistered

Friends And Related Symbol Documentation

◆ Manager

friend class Manager

friend

◆ std::default_delete< Factory >

friend struct std::default_delete< Factory >

friend

Field Documentation

◆ deviceDescriptors_

DeviceDescriptors Ocean::Devices::Factory::deviceDescriptors_

private

Vector holding all registered devices with name and type.

◆ lock_

Lock Ocean::Devices::Factory::lock_

mutableprivate

Factory lock.

◆ name_

std::string Ocean::Devices::Factory::name_

private

The factory's name.

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

devices/Factory.h

Data Structures

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ DeviceDescriptors

◆ InstanceFunction

Constructor & Destructor Documentation

◆ Factory() [1/2]

◆ Factory() [2/2]

◆ ~Factory()

Member Function Documentation

◆ adapterDevice()

◆ createDevice()

◆ device() [1/2]

◆ device() [2/2]

◆ devices() [1/2]

◆ devices() [2/2]

◆ deviceType()

◆ factory()

◆ name()

◆ operator=()

◆ registerDevice()

◆ registerFactory()

◆ unregisterDevice()

◆ unregisterFactory()

Friends And Related Symbol Documentation

◆ Manager

◆ std::default_delete< Factory >

Field Documentation

◆ deviceDescriptors_

◆ lock_

◆ name_