Overview

Sample Code

Programming Guide

API Reference

Support

HPS.TimerTickEvent Class Reference

The TimerTickEvent class is the event that will be triggered for each timer tick. More...

Inheritance diagram for HPS.TimerTickEvent:
HPS.Event

Public Member Functions

override HPS.Event Clone ()
 Allocates and returns a copy of this TimerEvent. More...
 
override void Dispose ()
 
override bool Drop (HPS.Event in_that_event)
 Determines if this TimerTickEvent can be drop in favor of the following time tick event. More...
 
override IntPtr Freshen ()
 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. More...
 
 TimerTickEvent ()
 The default constructor creates a TimerTickEvent object. More...
 
 TimerTickEvent (HPS.Event in_event)
 This constructor converts an EventObject to a TimerTickEvent object. More...
 
 TimerTickEvent (HPS.TimerTickEvent in_that)
 
- Public Member Functions inherited from HPS.Event
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event ()
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event (HPS.Event in_that)
 
delegate IntPtr EventDelegate_0 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
IntPtr GetChannel ()
 Returns the channel ID assigned to an event. More...
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 Returns the time an event was injected into the event queue. More...
 
bool IsConsumable ()
 Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The TimerTickEvent class is the event that will be triggered for each timer tick.

Constructor & Destructor Documentation

HPS.TimerTickEvent.TimerTickEvent ( )
inline

The default constructor creates a TimerTickEvent object.

HPS.TimerTickEvent.TimerTickEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a TimerTickEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

override HPS.Event HPS.TimerTickEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this TimerEvent.

Returns
A copy of this TimerEvent.

Implements HPS.Event.

override bool HPS.TimerTickEvent.Drop ( HPS.Event  in_that_event)
inlinevirtual

Determines if this TimerTickEvent can be drop in favor of the following time tick event.

Parameters
in_that_eventEvent to compare with this TimerTickEvent.
Returns
true is this event can be dropped.

Reimplemented from HPS.Event.

override IntPtr HPS.TimerTickEvent.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 from HPS.Event.


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