stmm-input-doc  0.17.0
Public Member Functions | List of all members
stmi::BasicDeviceManager::ListenerExtraData Class Reference

Base class to store extra listener data. More...

Public Member Functions

 ListenerExtraData () noexcept
 Empty default constructor. More...
 
virtual ~ListenerExtraData () noexcept=default
 
virtual void reset () noexcept
 Resets the extra data. More...
 

Detailed Description

Base class to store extra listener data.

Subclass this class to attach additional data to the listener. The subclass is constructed within BasicDeviceManager and must have a public constructor with no parameters. The lifetime of an instance is the same as the ListenerData object it is associated with.

Constructor & Destructor Documentation

◆ ListenerExtraData()

stmi::BasicDeviceManager::ListenerExtraData::ListenerExtraData ( )
inlinenoexcept

Empty default constructor.

◆ ~ListenerExtraData()

virtual stmi::BasicDeviceManager::ListenerExtraData::~ListenerExtraData ( )
virtualdefaultnoexcept

Member Function Documentation

◆ reset()

virtual void stmi::BasicDeviceManager::ListenerExtraData::reset ( )
inlinevirtualnoexcept

Resets the extra data.

Called by BasicDeviceManager::resetExtraDataOfAllListeners(). Override this function to clear the custom data in a subclass of ListenerExtraData.