HPS.TimerTickEvent Class Reference
Inheritance diagram for HPS.TimerTickEvent:

Public Member Functions | |
override HPS.Event | Clone () |
override void | Dispose () |
override bool | Drop (HPS.Event in_that_event) |
override IntPtr | Freshen () |
TimerTickEvent () | |
TimerTickEvent (HPS.Event in_event) | |
TimerTickEvent (HPS.TimerTickEvent in_that) | |
![]() | |
delegate void | DtorDelegate (IntPtr cPtr) |
Event (IntPtr in_channel) | |
Event () | |
Event (HPS.Event in_that) | |
IntPtr | GetChannel () |
IntPtr | GetClassID () |
double | GetTimeStamp () |
bool | IsConsumable () |
Additional Inherited Members | |
![]() | |
enum | Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 } |
![]() | |
static void | DtorCallback (IntPtr p) |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
![]() | |
static Dictionary< IntPtr, Event > | cachedObjects = new Dictionary<IntPtr, Event>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Detailed Description
The TimerTickEvent class is the event that will be triggered for each timer tick.
Constructor & Destructor Documentation
◆ TimerTickEvent() [1/2]
|
inline |
The default constructor creates a TimerTickEvent object.
◆ TimerTickEvent() [2/2]
|
inline |
This constructor converts an EventObject to a TimerTickEvent object.
- Parameters
-
in_event The EventObject to be converted.
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Allocates and returns a copy of this TimerEvent.
- Returns
- A copy of this TimerEvent.
Implements HPS.Event.
◆ Drop()
|
inlinevirtual |
Determines if this TimerTickEvent can be drop in favor of the following time tick event.
- Parameters
-
in_that_event Event to compare with this TimerTickEvent.
- Returns
- true if this event can be dropped, false otherwise.
Reimplemented from 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 from HPS.Event.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TimerTickEvent.cs