HPS.Event Class Reference

Inheritance diagram for HPS.Event:

Classes
class	EventUnknown

Public Types
enum	Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }

Public Member Functions
abstract HPS.Event	Clone ()
virtual void	Dispose ()
virtual bool	Drop (HPS.Event in_that_event)
delegate void	DtorDelegate (IntPtr cPtr)
	Event (IntPtr in_channel)
	Event ()
	Event (HPS.Event in_that)
virtual IntPtr	Freshen ()
IntPtr	GetChannel ()
IntPtr	GetClassID ()
double	GetTimeStamp ()
bool	IsConsumable ()

Protected Member Functions
virtual void	deleteCptr ()
virtual bool	DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
virtual IntPtr	GetNonDirectorClassID ()
virtual bool	IsUserDerived ()

Static Protected Member Functions
static void	DtorCallback (IntPtr p)

Protected Attributes
bool	cMemOwn
HandleRef	cptr

Static Protected Attributes
static Dictionary< IntPtr, Event >	cachedObjects = new Dictionary<IntPtr, Event>()
static ReaderWriterLockSlim	mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)

Detailed Description

The Event class is the common base class of all events. An event can be an error, input event, or a custom event. Events occur asynchronously and are processed in order from an event queue.

Member Enumeration Documentation

Status

enum HPS.Event.Status : uint

strong

Event Status - returned from a notifier to give the status of the event.

Enumerator
InProgress	Event is still in progress.
Completed	Event has completed.
Failed	Event failed.

Constructor & Destructor Documentation

Event() [1/2]

HPS.Event.Event ( IntPtr  in_channel )

inline

A constructor for generating events from built-in or custom event ID's.

Event() [2/2]

HPS.Event.Event ( )

inline

A constructor for generating events from built-in or custom event ID's.

Member Function Documentation

Clone()

abstract HPS.Event HPS.Event.Clone ( )

pure virtual

This function is used to copy custom events classes. Users that create custom event classes must override this function to provide the proper copying behavior.

Implemented in HPS.Exchange.CommonMeasurementOperator.MeasurementDeletedEvent, HPS.Exchange.CommonMeasurementOperator.MeasurementInsertedEvent, HPS.Stream.ImportCompletedEvent, HPS.Stream.ExportStartedEvent, HPS.HCA.RequestIdEvent, HPS.HandlesOperator.GeometryTransformedEvent, HPS.MeasurementOperator.MeasurementEvent, HPS.MarkupOperator.MarkupInsertedEvent, HPS.AnnotationOperator.AnnotationInsertedEvent, HPS.MouseEvent, HPS.KeyboardEvent, HPS.TouchEvent, HPS.ComponentHighlightEvent, HPS.TextInputEvent, HPS.HighlightEvent, HPS.ErrorEvent, HPS.InformationEvent, HPS.WarningEvent, HPS.ViewDetachedEvent, HPS.ComponentIsolatedEvent, HPS.CameraChangedEvent, HPS.StandAloneWindowEvent, HPS.FilterActivationEvent, HPS.ComponentHiddenEvent, HPS.ComponentResetEvent, HPS.ComponentShownEvent, HPS.SmoothTransitionCompleteEvent, HPS.ImportStatusEvent, HPS.CaptureActivationEvent, HPS.LayoutDetachedEvent, HPS.ModelDetachedEvent, HPS.UpdateCompletedEvent, HPS.CanvasDeletedEvent, HPS.LayoutDeletedEvent, HPS.ModelDeletedEvent, HPS.ViewDeletedEvent, HPS.InputEvent, HPS.HideKeyboardEvent, HPS.ShowKeyboardEvent, HPS.TimerTickEvent, and HPS.FocusLostEvent.

Drop()

virtual bool HPS.Event.Drop ( HPS.Event  in_that_event )

inlinevirtual

This optional function is used to determine if the current event can be dropped based on the following event in the queue.

Reimplemented in HPS.Stream.ImportCompletedEvent, HPS.Stream.ExportStartedEvent, HPS.MouseEvent, HPS.TouchEvent, HPS.SmoothTransitionCompleteEvent, HPS.TimerTickEvent, and HPS.CameraChangedEvent.

Freshen()

virtual IntPtr HPS.Event.Freshen ( )

inlinevirtual

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Returns

A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented in HPS.Stream.ImportCompletedEvent, HPS.Stream.ExportStartedEvent, HPS.MouseEvent, HPS.TimerTickEvent, and HPS.CameraChangedEvent.

GetChannel()

IntPtr HPS.Event.GetChannel ( )

inline

Returns the channel ID assigned to an event.

GetTimeStamp()

double HPS.Event.GetTimeStamp ( )

inline

Returns the time an event was injected into the event queue.

IsConsumable()

bool HPS.Event.IsConsumable ( )

inline

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.

---

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

• internals/hps_core/source/cs/HPS.Event.cs