HPS.ImportStatusEvent Class Reference
The ImportStatusEvent class is the event that can be used by importers to let the user know what they are currently working on More...
Inheritance diagram for HPS.ImportStatusEvent:

Public Member Functions | |
override HPS.Event | Clone () |
Allocates and returns a copy of this ImportStatusEvent. More... | |
override void | Dispose () |
ImportStatusEvent () | |
The default constructor creates a ImportStatusEvent. More... | |
ImportStatusEvent (string in_message) | |
ImportStatusEvent (HPS.Event in_event) | |
This constructor converts an EventObject to an ImportStatusEvent object. More... | |
ImportStatusEvent (HPS.ImportStatusEvent in_that) | |
delegate IntPtr | ImportStatusEventDelegate_0 (IntPtr cPtr) |
delegate bool | ImportStatusEventDelegate_1 (IntPtr cPtr, IntPtr in_that_event) |
delegate IntPtr | ImportStatusEventDelegate_2 (IntPtr cPtr) |
![]() | |
virtual bool | Drop (HPS.Event in_that_event) |
This optional function is used to determine if the current event can be dropped based on the following event in the queue. More... | |
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 (IntPtr cPtr) |
delegate bool | EventDelegate_1 (IntPtr cPtr, IntPtr in_that_event) |
delegate IntPtr | EventDelegate_2 (IntPtr cPtr) |
virtual 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... | |
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... | |
Properties | |
string | import_status_message [get, set] |
Additional Inherited Members | |
![]() | |
enum | Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 } |
Event Status - returned from a notifier to give the status of the event. More... | |
![]() | |
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 ImportStatusEvent class is the event that can be used by importers to let the user know what they are currently working on
Constructor & Destructor Documentation
|
inline |
The default constructor creates a ImportStatusEvent.
|
inline |
This constructor converts an EventObject to an ImportStatusEvent object.
- Parameters
-
in_event The EventObject to be converted.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this ImportStatusEvent.
- Returns
- A copy of this ImportStatusEvent.
Implements HPS.Event.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ImportStatusEvent.cs