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, ... <file name="nxa.LinkXEventToTemplate">
<h1>Description - INTERNAL DOCUMENTATION</h1>
<h1>Signature</h1>
Description - INTERNAL DOCUMENTATION
Signature
nxa.LinkXEventToTemplate (eventWid, templateName) <p>This
This function is used to link a template to an XEvent. </p>
<h1>Parameters</h1>
<table>
<colgroup> <col/> <col/> <col/> <col/> </colgroup>
<tbody>
<tr>
<th>Name</th>
<th>Type</th>
<th>Mandatory/Optional</th> <th>Description</th>
</tr>
<tr><td></td><td>eventWid</td><td>M</td><td>ID
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) <p>This
This function is used to link a template to a branch. </p>
<h1>Parameters</h1>
<table>
<colgroup> <col/> <col/> <col/> <col/> </colgroup>
<tbody>
<tr>
<th>Name</th>
<th>Type</th>
<th>Mandatory/Optional</th>
<th>Description</th>
</tr>
<tr><td></td><td>eventWid</td><td>M</td><td>ID
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, ...) <p>This
This function is used to change a property of an event within the event tree.</p>
<h1>Parameters</h1>
<table>
<colgroup> <col/> <col/> <col/> <col/> </colgroup>
<tbody>
<tr>
<th>Name</th>
<th>Type</th>
<th>Mandatory/Optional</th>
<th>Description</th>
</tr>
<tr><td></td><td>eventWid</td><td>M</td><td>ID
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) <p>This
This function is used to create a new branch within the event tree.</p>
<h1>Parameters</h1>
<table>
<colgroup> <col/> <col/> <col/> <col/> </colgroup>
<tbody>
<tr>
<th>Name</th>
<th>Type</th>
<th>Mandatory/Optional</th>
<th>Description</th>
</tr>
<tr><td></td><td>name</td><td>M</td><td>name of new branch</td></tr>
<tr><td></td><td>majorBranch</td><td>M</td><td>WID of major branch</td></tr>
</tbody>
</table>
<h1>Return</h1> None.
</file>
<file name="nxa.NewXEvent">
<h1>Description - INTERNAL DOCUMENTATION</h1>
<h1>Signature</h1>
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) <p>This
This function is used to change a property of an event within the event tree.</p>
<h1>Parameters</h1>
<table>
<colgroup> <col/> <col/> <col/> <col/> </colgroup>
<tbody>
<tr>
<th>Name</th>
<th>Type</th>
<th>Mandatory/Optional</th> <th>Description</th>
</tr>
<tr><td></td><td>type</td><td>M</td><td>event
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.