stmi::Device Class Reference

Device base class. More...

Inheritance diagram for stmi::Device:

Public Member Functions
virtual	~Device () noexcept=default
int32_t	getId () const noexcept
	The device id. More...
virtual std::string	getName () const noexcept=0
virtual shared_ptr< DeviceManager >	getDeviceManager () const noexcept=0
	The device manager that manages the device. More...
template<typename TCapa >
bool	getCapability (shared_ptr< TCapa > &refCapa) const noexcept
	Request a registered capability from this device. More...
virtual shared_ptr< Capability >	getCapability (const Capability::Class &oClass) const noexcept=0
	Requests the instance of a capability class. More...
virtual shared_ptr< Capability >	getCapability (int32_t nCapabilityId) const noexcept=0
	Returns the capability with the given id, or null if not found. More...
virtual std::vector< int32_t >	getCapabilities () const noexcept=0
	Returns the ids of all the device's capabilities. More...
virtual std::vector< Capability::Class >	getCapabilityClasses () const noexcept=0
	The capability classes supported by this device. More...

Protected Member Functions
	Device () noexcept

Detailed Description

Device base class.

Constructor & Destructor Documentation

~Device()

virtual stmi::Device::~Device ( )

virtualdefaultnoexcept

Device()

stmi::Device::Device ( )

protectednoexcept

Member Function Documentation

getCapabilities()

virtual std::vector<int32_t> stmi::Device::getCapabilities ( ) const

pure virtualnoexcept

Returns the ids of all the device's capabilities.

Returns

The set of capability ids.

Implemented in stmi::testing::FakeDevice< CAPA >, stmi::testing::FakeDevice< stmi::testing::FakeTouchCapability >, stmi::testing::FakeDevice< stmi::testing::FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeJoystickCapability >, stmi::testing::FakeDevice< FakeJoystickCapability >, stmi::testing::FakeDevice< FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeKeyCapability >, stmi::testing::FakeDevice< FakeKeyCapability >, and stmi::testing::FakeDevice< FakeTouchCapability >.

getCapability() [1/3]

template<typename TCapa >

bool stmi::Device::getCapability ( shared_ptr< TCapa > &  refCapa ) const

inlinenoexcept

Request a registered capability from this device.

Parameters

refCapa

[out] The registered Capability subclass or null if not supported by device.

Returns

Whether the device has the requested capability.

getCapability() [2/3]

virtual shared_ptr<Capability> stmi::Device::getCapability ( const Capability::Class &  oClass ) const

pure virtualnoexcept

Requests the instance of a capability class.

If the device doesn't have the capability null is returned.

Parameters

oClass

The requested registered class.

Returns

The capability or null.

Implemented in stmi::testing::FakeDevice< CAPA >, stmi::testing::FakeDevice< stmi::testing::FakeTouchCapability >, stmi::testing::FakeDevice< stmi::testing::FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeJoystickCapability >, stmi::testing::FakeDevice< FakeJoystickCapability >, stmi::testing::FakeDevice< FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeKeyCapability >, stmi::testing::FakeDevice< FakeKeyCapability >, and stmi::testing::FakeDevice< FakeTouchCapability >.

getCapability() [3/3]

virtual shared_ptr<Capability> stmi::Device::getCapability ( int32_t  nCapabilityId ) const

pure virtualnoexcept

Returns the capability with the given id, or null if not found.

Implemented in stmi::testing::FakeDevice< CAPA >, stmi::testing::FakeDevice< stmi::testing::FakeTouchCapability >, stmi::testing::FakeDevice< stmi::testing::FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeJoystickCapability >, stmi::testing::FakeDevice< FakeJoystickCapability >, stmi::testing::FakeDevice< FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeKeyCapability >, stmi::testing::FakeDevice< FakeKeyCapability >, and stmi::testing::FakeDevice< FakeTouchCapability >.

getCapabilityClasses()

virtual std::vector<Capability::Class> stmi::Device::getCapabilityClasses ( ) const

pure virtualnoexcept

The capability classes supported by this device.

Returns

The set of registered capability classes.

Implemented in stmi::testing::FakeDevice< CAPA >, stmi::testing::FakeDevice< stmi::testing::FakeTouchCapability >, stmi::testing::FakeDevice< stmi::testing::FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeJoystickCapability >, stmi::testing::FakeDevice< FakeJoystickCapability >, stmi::testing::FakeDevice< FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeKeyCapability >, stmi::testing::FakeDevice< FakeKeyCapability >, and stmi::testing::FakeDevice< FakeTouchCapability >.

getDeviceManager()

virtual shared_ptr<DeviceManager> stmi::Device::getDeviceManager ( ) const

pure virtualnoexcept

The device manager that manages the device.

As a convention Device instances should hold a weak_ptr to their manager to avoid reference cycles.

Returns

The device manager or null if the device is no longer attached to its manager.

Implemented in stmi::testing::FakeDevice< CAPA >, stmi::testing::FakeDevice< stmi::testing::FakeTouchCapability >, stmi::testing::FakeDevice< stmi::testing::FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeJoystickCapability >, stmi::testing::FakeDevice< FakeJoystickCapability >, stmi::testing::FakeDevice< FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeKeyCapability >, stmi::testing::FakeDevice< FakeKeyCapability >, stmi::testing::FakeDevice< FakeTouchCapability >, and stmi::BasicDevice< ODM >.

getId()

int32_t stmi::Device::getId ( ) const

inlinenoexcept

The device id.

Returns

The unique id of the device.

getName()

virtual std::string stmi::Device::getName ( ) const

pure virtualnoexcept

Returns

Name of the device. Not necessarily unique among devices.

Implemented in stmi::testing::FakeDevice< CAPA >, stmi::testing::FakeDevice< stmi::testing::FakeTouchCapability >, stmi::testing::FakeDevice< stmi::testing::FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeJoystickCapability >, stmi::testing::FakeDevice< FakeJoystickCapability >, stmi::testing::FakeDevice< FakePointerCapability >, stmi::testing::FakeDevice< stmi::testing::FakeKeyCapability >, stmi::testing::FakeDevice< FakeKeyCapability >, stmi::testing::FakeDevice< FakeTouchCapability >, and stmi::BasicDevice< ODM >.