Ocean::Devices::Pattern::PatternDevice Class Reference

This class implements a base class for all devices of the Pattern library. More...

#include <PatternDevice.h>

Inheritance diagram for Ocean::Devices::Pattern::PatternDevice:

Public Member Functions
virtual const std::string &	library () const
	Returns the name of the owner library.
Public Member Functions inherited from Ocean::Devices::Device
const std::string &	name () const
	Returns the name of this device.
virtual bool	isStarted () const
	Returns whether this device is active.
bool	isValid () const
	Returns whether this device is valid.
bool	isExclusive () const
	Returns whether this device can be use exclusively.
virtual bool	start ()
	Starts the device.
virtual bool	pause ()
	Pauses the device.
virtual bool	stop ()
	Stops the device.
virtual bool	setParameter (const std::string &parameter, const Value &value)
	Sets an abstract parameter of this device.
virtual bool	parameter (const std::string &parameter, Value &value)
	Returns an abstract parameter of this device.
DeviceType	type () const
	Returns the major and minor type of this device.

Protected Member Functions
	PatternDevice (const std::string &name, const DeviceType type)
	Creates a new device by is name.
Protected Member Functions inherited from Ocean::Devices::Device
	Device (const Device &device)=delete
	Disabled copy constructor.
	Device (const std::string &name, const DeviceType type)
	Creates a new device by is name.
virtual	~Device ()
	Destructs a device.
Device &	operator= (const Device &device)=delete
	Disabled copy operator.

Additional Inherited Members
Public Types inherited from Ocean::Devices::Device
enum	MajorType : uint32_t { DEVICE_INVALID = 0u , DEVICE_MEASUREMENT = (1u << 0u) , DEVICE_SENSOR = (1u << 1u) | DEVICE_MEASUREMENT , DEVICE_TRACKER = (1u << 2u) | DEVICE_MEASUREMENT }
	Definition of all major device types. More...
enum	MinorType : uint32_t { MINOR_INVALID = 0u }
	Base definition of a minor type. More...
Static Public Member Functions inherited from Ocean::Devices::Device
static std::string	translateMajorType (const MajorType majorType)
	Translates the major devices type to a readable string.
static MajorType	translateMajorType (const std::string &majorType)
	Translates the major devices type from a readable string to a value.
Protected Types inherited from Ocean::Devices::Device
typedef unsigned int	SubscriptionId
	Definition of a subscription id for event callbacks.
Static Protected Member Functions inherited from Ocean::Devices::Device
static constexpr SubscriptionId	invalidSubscriptionId ()
	Returns an invalid subscription id.
Protected Attributes inherited from Ocean::Devices::Device
std::string	deviceName
	Name of this device.
DeviceType	deviceType
	Major and minor type of this device.
bool	deviceIsValid
	Flag determining whether this device is valid.
Lock	deviceLock
	Device lock.

Detailed Description

This class implements a base class for all devices of the Pattern library.

Constructor & Destructor Documentation

PatternDevice()

Ocean::Devices::Pattern::PatternDevice::PatternDevice ( const std::string &  name, const DeviceType  type  )

protected

Creates a new device by is name.

Parameters

name	The name of the device
type	Major and minor device type of the device

Member Function Documentation

library()

virtual const std::string & Ocean::Devices::Pattern::PatternDevice::library ( ) const

virtual

Returns the name of the owner library.

See also

Device::library().

Implements Ocean::Devices::Device.

---

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

• PatternDevice.h