All the functions listed here are used to manipulate the Event Tree which is used to stored dynamic information and data like scheduler events, server alarms, ...
Description - INTERNAL DOCUMENTATION
Signature
nxa.LinkXEventToTemplate (eventWid, templateName)
This function is used to link a template to an XEvent.
Parameters
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| eventWid | M | ID of the event to which the template shall be applied | |
| templateName | M | Name of the template |
Return
None.
Description - INTERNAL DOCUMENTATION
Signature
nxa.LinkXEventBranchToTemplate (eventWid, templateName)
This function is used to link a template to a branch.
Parameters
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| eventWid | M | ID of the branch to which the template shall be applied | |
| templateName | M | Name of the template |
Return
None.
Description - INTERNAL DOCUMENTATION
Signature
nxa.SetXProperties (eventWid, propName1, propValue1, ...)
This function is used to change a property of an event within the event tree.
Parameters
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| eventWid | M | ID of the event to which the property belongs to | |
| propName1 | M | Name of property 1 | |
| propValue1 | M | Value of property 1 | |
| ... |
Return
None.
Description - INTERNAL DOCUMENTATION
Signature
nxa.nxa.NewXBranch(STRING vName, WID vMajorBranch) (name, majorBranch)
This function is used to create a new branch within the event tree.
Parameters
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| name | M | name of new branch | |
| majorBranch | M | WID of major branch |
Return
None.
Description - INTERNAL DOCUMENTATION
Signature
nxa.NewXEvent (type, name, description, majorBranch)
This function is used to change a property of an event within the event tree.
Parameters
| Name | Type | Mandatory/Optional | Description |
|---|---|---|---|
| type | M | event type.Timer = 1, Cyclical = 2, Reactor = 3, Scene = 4, Calendar = 5, Alarm = 6, Trending = 7, Device = 8, User = 9 | |
| name | M | name of new event | |
| description | M | description of new event | |
| majorBranch | M | WID of major branch |
Return
None.