Public Member Functions | Protected Member Functions | List of all members
HPS.DriverEventHandler Class Reference

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

Inheritance diagram for HPS.DriverEventHandler:
HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
 DriverEventHandler (HPS.DriverEventHandler that)
 
virtual void Handle (HPS.DriverEvent in_event)
 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. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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

Member Function Documentation

virtual void HPS.DriverEventHandler.Handle ( HPS.DriverEvent  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_event<ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref> which was triggered.
override HPS.Type HPS.DriverEventHandler.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying 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: