Inheritance diagram for HPS.InformationEvent:
HPS.Event

Public Member Functions

override HPS.Event Clone ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.InformationEvent in_that)
 
override int GetHashCode ()
 
 InformationEvent ()
 
 InformationEvent (string in_message)
 
 InformationEvent (string in_message, HPS.Info.Code in_code)
 
 InformationEvent (HPS.Event in_event)
 
 InformationEvent (HPS.InformationEvent in_that)
 
- Public Member Functions inherited from HPS.Event
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 ()
 

Static Public Member Functions

static bool operator!= (HPS.InformationEvent a, HPS.InformationEvent b)
 
static bool operator== (HPS.InformationEvent a, HPS.InformationEvent b)
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Properties

HPS.Info.Code code [get, set]
 
string message [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 
- Static Protected Member Functions inherited from HPS.Event
static void DtorCallback (IntPtr p)
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Event
static Dictionary< IntPtr, EventcachedObjects = new Dictionary<IntPtr, Event>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The InformationEvent class is the event that will be generated if an asynchronous informational message occurs.

Constructor & Destructor Documentation

◆ InformationEvent() [1/4]

HPS.InformationEvent.InformationEvent ( )
inline

The default constructor creates a InformationEvent object with an empty message and code of Unknown.

◆ InformationEvent() [2/4]

HPS.InformationEvent.InformationEvent ( string  in_message)
inline

This constructor creates a InformationEvent object with a specified information and code of Unknown.

Parameters
in_messageA message describing the nature of the information.

◆ InformationEvent() [3/4]

HPS.InformationEvent.InformationEvent ( string  in_message,
HPS.Info.Code  in_code 
)
inline

This constructor creates a InformationEvent object with a specified information and code.

Parameters
in_messageA message describing the nature of the information.
in_codeA code describing the nature of the information.

◆ InformationEvent() [4/4]

HPS.InformationEvent.InformationEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a InformationEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

◆ Clone()

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

Allocates and returns a copy of this InformationEvent.

Returns
A copy of this InformationEvent.

Implements HPS.Event.

◆ Equals()

virtual bool HPS.InformationEvent.Equals ( HPS.InformationEvent  in_that)
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.InformationEvent.cs