Difference between revisions of "Extensions.EventHandling.IsMonitorChangeEvent"
Jump to navigation
Jump to search
(Created page with "Category:EventHandling == Classification == {{ClassificationActivity | IsMonitorChangeEvent | Checks whether an event monitor change event source or '''ThresholdExceededEv...") |
|||
| Line 17: | Line 17: | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
{{TableRowPropertie1| Event | [[Event]] | [[Term]] | - | [1] | The event, whose type is checked.}} | {{TableRowPropertie1| Event | [[Event]] | [[Term]] | - | [1] | The event, whose type is checked.}} | ||
| + | {{TableRowPropertie2| Variable | - | [[Variable]] | - | [0..1] | It is checked if the optional variable is the reason for the event.}} | ||
|} | |} | ||
Revision as of 08:11, 31 July 2014
Contents
Classification
| Name | IsMonitorChangeEvent |
| Short Description | Checks whether an event monitor change event source or ThresholdExceededEventSource comes |
| Class | Term |
| Extension | OTX EventHandling extension |
| Group | Event source property related terms |
| Exceptions | - |
| Checker Rules | Event_Chk002 |
| Standard Compliant | Yes |
Pseudo-Code Syntax
Boolean IsMonitorChangeEvent(Event myEvent, Variable myVariable);Description
The OTX IsMonitorChangeEvent term returns TRUE back when the event if and only from MonitorChangeEventSource or ThresholdExceededEventSource comes. In the case of an optional variable is specified, the expression is TRUE return, if and only if the event was triggered, because this particular variable changes. If the specified variable is not the reason for this is FALSE returned.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Boolean | Returns TRUE if the event of a MonitorChangeEventSource or ThresholdExceededEventSource comes. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Event | Event | Term | - | [1] | The event, whose type is checked. |
| Variable | - | Variable | - | [0..1] | It is checked if the optional variable is the reason for the event. |
Examples
Boolean result = IsMonitorChangeEvent(myEvent, myVariable);