Copy/Move/Split/Topology
- Last UpdatedNov 27, 2023
- 2 minute read
These are functions that operates on the panel object level. You can copy or move whole panels, split panels and get topology information about the panel.
|
pan_copy(ListOfPanels, CopyPanOptions) |
||
|
Copy some of the currently activated panels. The new panels will also be activated. |
||
|
Input Parameters: |
||
|
ListOfPanels |
string or list or strings |
List of panels to copy. It can be a single panel name or a list of names. Every panel in the list must be among the activates ones otherwise an exception is return (kcs_NoModelIsCurrent). |
|
CopyPanOptions |
Instance of KcsCopyPanOptions |
Detailed information about the copy operation |
|
Returned value: |
||
|
[None |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_NoModelIsCurrent |
One or more of the selected panels are not activated. |
|
|
pan_move(ListOfPanels, MovePanOptions) |
||
|
Move all currently selected panels |
||
|
Input Parameters: |
||
|
ListOfPanels |
string or list or strings |
List of panels to copy. It can be a single panel name or a list of names. Every panel in the list must be among the activates ones otherwise an exception is return (kcs_NoModelIsCurrent). |
|
MovePanOptions |
KcsMovePanOptions. |
Instance of KcsMovePanOptions. Detailed information about the move operation. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_NoModelIsCurrent |
One or more of the selected panels are not activated. |
|
|
pan_split(ListOfPanels, SplitPanOptions) |
||
|
Split all the currently activated panels. |
||
|
Input Parameters: |
||
|
ListOfPanels |
string or list or strings |
List of panels to copy. It can be a single panel name or a list of names. Every panel in the list must be among the activates ones otherwise an exception is return (kcs_NoModelIsCurrent). |
|
SplitPanOptions |
Instance of KcsSplitPanOptions |
This object contains all the detailed information for the split operation. |
|
Returned value: |
||
|
none |
||
|
Exceptions: |
||
|
kcs_Error |
General error. |
|
|
pan_topology(Model, Act) |
||
|
Calculate the dependencies to/from a given model object. |
||
|
Input Parameters: |
||
|
Model |
Instance of KCSModel |
The model object The "Root" object. |
|
Act |
string |
Activity indicating how to calculate the dependencies: "Dependent primary" - List all objects that depends on "Model". Only search one level. "Dependent all" - List all objects that depends on "Model". Search all levels. "Defining" - List all object that defines "Model" (that means, a list of all objects that "Model" depends on) |
|
Returned value: |
||
|
[0]TopoList |
List of instances of KcsModel |
The list of all model objects that depend on or defines "Model". |
|
Exceptions: |
||
|
kcs_ArgumentError |
Invalid input parameters |
|
|
kcs_Error |
Topology calculation failed. |
|