Activate/Store/Skip/Delete/Recreate
- Last UpdatedNov 27, 2023
- 2 minute read
|
pan_activate(ListOfPanels) |
||
|
Activate a number of panels |
||
|
Input Parameters: |
||
|
ListOfPanels |
list of strings |
The names of the panels to be activated. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_ModelNotFound |
The panel was not found. |
|
|
kcs_ModelLocked |
The panel was locked by another user. |
|
|
pan_skip(ListOfPanels) |
||
|
Skip the panels indicated by "ListOfPanels". Each panel in "ListOfPanels" must one of the currently activated panels. An empty list means all currently activated panels. |
||
|
Input Parameters: |
||
|
ListOfPanels |
list of strings |
The names of the panels to be skipped. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_ModelNotFound |
The panel is not active or does not exist |
|
|
pan_store(ListOfPanels) |
||
|
Store the panels indicated by "ListOfPanels". Each panel in "ListOfPanels" must one of the currently activated panels, otherwise it will be ignored. An empty list means all currently activated panels. |
||
|
Input Parameters: |
||
|
ListOfPanels |
list of strings |
The names of the panels to be stored. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_ModelNotFound |
The panel is not active or does not exist |
|
|
pan_delete(ListOfPanels) |
||
|
Delete the panels indicated by "ListOfPanels". Each panel in "ListOfPanels" must one of the currently activated panels. An empty list means all currently activated panels. |
||
|
Input Parameters: |
||
|
ListOfPanels |
list of strings |
The names of the panels to be stored. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_NoModelIsCurrent |
The panel is not active or does not exist |
|
|
pan_list_active( ) |
||
|
Get a list of all currently activated panels |
||
|
Input Parameters: |
||
|
none |
||
|
Returned value: |
||
|
[0]PanelNames |
list of strings |
The names of the panels that are currently activated. |
|
Exceptions: |
||
|
none |
||
|
pan_recreate(<ListOfPanels>) |
||
|
Recreate panels from list in topological order. The panels must be activated. If no parameter is given then all activated panels will be recreated.. |
||
|
Input Parameters: |
||
|
ListOfPanels |
list of strings |
Optional list of names of the panels to be recreated. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_NoModelIsCurrent |
Panel is not active |
|