< Home

< Table of Contents

REFERENCE MANUAL

HPS.CaptureActivationEvent Class Reference
Inheritance diagram for HPS.CaptureActivationEvent:
HPS.Event

Public Member Functions

 CaptureActivationEvent ()
 The default constructor creates an empty CaptureActivationEvent object. More...
 
 CaptureActivationEvent (HPS.Capture in_capture, HPS.View in_view)
 
 CaptureActivationEvent (HPS.Event in_event)
 This constructor converts an Event Object to a CaptureActivationEvent object. More...
 
 CaptureActivationEvent (HPS.CaptureActivationEvent in_that)
 
override HPS.Event Clone ()
 Allocates and returns a copy of this CaptureActivationEvent. More...
 
override void Dispose ()
 
- Public Member Functions inherited from HPS.Event
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 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
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...
 

Protected Member Functions

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

Properties

HPS.Capture capture [get, set]
 
HPS.View view [get, set]
 

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
 

Constructor & Destructor Documentation

HPS.CaptureActivationEvent.CaptureActivationEvent ( )

The default constructor creates an empty CaptureActivationEvent object.

HPS.CaptureActivationEvent.CaptureActivationEvent ( HPS.Event  in_event)

This constructor converts an Event Object to a CaptureActivationEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

override HPS.Event HPS.CaptureActivationEvent.Clone ( )
virtual

Allocates and returns a copy of this CaptureActivationEvent.

Returns
A copy of this CaptureActivationEvent.

Implements HPS.Event.


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