cMessage Class |
This class encapsulates a message that is passed from the Core to an Interface via the cMessagePublisher-cMessageHandler system
Inheritance HierarchyNamespace: EwECore
Assembly: EwECore (in EwECore.dll) Version: 6.6.15981.0 (6.6.15981.0)
SyntaxThe cMessage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | cMessage |
Create a default maintenance message.
|
| cMessage(String, eMessageType, eCoreComponentType, eMessageImportance, eDataTypes) |
Create a message.
|
Properties| Name | Description | |
|---|---|---|
 | DataType | |
| Hyperlink |
Get/set the hyperlink for this message.
|
| Importance | |
| Message | |
| Source | |
| Suppressable | |
| Suppressed | |
| Type | |
| Variables | Get the variables associated with
this message. |
Methods| Name | Description | |
|---|---|---|
| AddVariable |
Add a cVariableStatus object to the list of variables that this message applies to.
|
| Equals |
Helper method, compares this message to another object.
(Overrides ObjectEquals(Object).) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasVariable(cVariableStatus) |
Returns whether a message has a given variable attached.
|
| HasVariable(eVarNameFlags) |
Returns whether a message has a given variable attached.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Overrides ObjectToString.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |
Remarks
A message object is created by the Core and passed to cMessagePublisher.SendMessage(cMessage)
where it is handled by which ever cMessageHandler object can handle this type of message.
A message object can contain a list of variables that relate to the message
i.e. If cMessage.Type = eMessageType.EE then cMessage.Variables will contain a list of cVariableStatus objects that represent variables that have an EE > 1.
See Also