HPS::DriverEventHandler Class Reference

#include <hps.h>

Inheritance diagram for HPS::DriverEventHandler:
HPS::Object

Public Member Functions

DriverEventHandler (DriverEventHandler const &that)
 
virtual void Handle (DriverEvent const *in_event)
 
HPS::Type ObjectType () const override
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::DriverEventHandler
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The DriverEventHandler class is the base class for driver event handlers. Custom driver event handlers should inherit from this.

Member Function Documentation

◆ Handle()

virtual void HPS::DriverEventHandler::Handle ( DriverEvent const *  in_event)
inlinevirtual

Function that gets triggered if this DriverEventHandler receives an event it is subscribed to. This should be overridden by subclasses of DriverEventHandler to perform any custom behavior. This will be called on the driver updater thread.

Parameters
in_eventEvent which was triggered.

◆ ObjectType()

HPS::Type HPS::DriverEventHandler::ObjectType ( ) const
inlineoverridevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.


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