Page Comparison

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> nxa.LinkXEventToTemplate (eventWid, templateName) <p>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 of the event to which the template shall be applied</td></tr>
<tr><td></td><td>templateName</td><td>M</td><td>Name of the template</td></tr> </tbody>
</table>
<h1>Return</h1> None.
</file>
<file name="nxa.LinkXEventBranchToTemplate">
<h1>Description - INTERNAL DOCUMENTATION</h1>
<h1>Signature</h1> nxa.LinkXEventBranchToTemplate (eventWid, templateName) <p>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 of the branch to which the template shall be applied</td></tr>
<tr><td></td><td>templateName</td><td>M</td><td>Name of the template</td></tr>
</tbody>
</table>
<h1>Return</h1> None.
</file>
<file name="nxa.SetXProperties">
<h1>Description - INTERNAL DOCUMENTATION</h1>
<h1>Signature</h1> nxa.SetXProperties (eventWid, propName1, propValue1, ...) <p>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 of the event to which the property belongs to</td></tr>
<tr><td></td><td>propName1</td><td>M</td><td>Name of property 1</td></tr>
<tr><td></td><td>propValue1</td><td>M</td><td>Value of property 1</td></tr>
<tr><td></td><td>...</td></tr>
</tbody>
</table>
<h1>Return</h1>
None.
</file>
<file name="nxa.nxa.NewXBranch(STRING vName, WID vMajorBranch)">
<h1>Description - INTERNAL DOCUMENTATION</h1>
<h1>Signature</h1> nxa.nxa.NewXBranch(STRING vName, WID vMajorBranch) (name, majorBranch) <p>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> nxa.NewXEvent (type, name, description, majorBranch) <p>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 type.Timer = 1, Cyclical = 2, Reactor
= 3, Scene = 4, Calendar = 5, Alarm = 6, Trending = 7, Device = 8, User = 9</td></tr>
<tr><td></td><td>name</td><td>M</td><td>name of new event</td></tr>
<tr><td></td><td>description</td><td>M</td><td>description of new event</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>