InformationEvent

class HPS.InformationEvent : public HPS.Event

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

Public Functions

override HPS.Event Clone ()

Allocates and returns a copy of this InformationEvent.

Return

A copy of this InformationEvent.

override void Dispose ()

bool Equals (HPS.InformationEvent in_that)

Check if the source object is equivalent to this object.

Param in_that

The source object to compare to this object.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

InformationEvent ()

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

InformationEvent (HPS.Event in_event)

This constructor converts an EventObject to a InformationEvent object.

Param in_event

The EventObject to be converted.

InformationEvent (HPS.InformationEvent in_that)

InformationEvent (string in_message)

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

Param in_message

A message describing the nature of the information.

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

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

Param in_message

A message describing the nature of the information.

Param in_code

A code describing the nature of the information.

Properties

HPS.Info.Code code { get; set; }

string message { get; set; }

Public Static Functions

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

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