The connector dimensioning mode type
To create a mode of this type, use the pw::Application.begin command with the mode Dimension specified, like this:
set dimensioner [pw::Application begin Dimension]
pw:: | The connector dimensioning mode type |
Instance Actions | |
isBalanced | This action checks if the dimensions are currently balanced. |
canReset | This action checks if the dimensions can be reset to a previous balanced state. |
reset | This action sets the dimensions back to the last balanced state. |
balance | This action tries to balance the current dimensions. |
getGroupCount | This action gets the number of connector dimensioning groups. |
getGroup | This action gets the connectors of a dimensioning group using the group index or a connector. |
getGroups | This action gets the connectors of all of the dimensioning groups. |
getUnbalancedConnectors | This action gets a list of the connectors that are unbalanced. |
getUnbalancedDomains | This action gets a list of the domains that are unbalanced. |
getAffectedConnectors | This action gets a list of the connectors that are affected by the dimensioning. |
getAffectedDomains | This action gets a list of the domains that are affected by the dimensioning. |
$dim isBalanced
This action checks if the dimensions are currently balanced.
This action has no parameters.
This action returns a boolean, true if dimensions are balanced.
$dim canReset
This action checks if the dimensions can be reset to a previous balanced state.
This action has no parameters.
This action returns a boolean, true if dimensions can be reset.
$dim balance ?-resetGeneralDistributions?
This action tries to balance the current dimensions.
-resetGeneralDistributions | This optional flag, if present, will clear any general distribution functions on the connectors that are redimensioned as a result of the balancing operation. |
This action returns nothing.
This command sets the dimension of all of the connectors in a group equal to the dimension of the most recently modified connector, and then balances domains by adjusting the dimensions of connectors.
$dim getGroupCount
This action gets the number of connector dimensioning groups.
This action has no parameters.
This action returns the integer number of gropus.
$dim getGroup < index | con >
This action gets the connectors of a dimensioning group using the group index or a connector.
index | This parameter is the integer group to get the connectors. |
con | This parameter is the connectors of the group that this pw::Connector is in. |
This action returns a list of pw::Connector objects.
$dim getGroups
This action gets the connectors of all of the dimensioning groups.
The action has no parameters.
This action returns a list of lists of pw::Connector objects.
$dim getUnbalancedConnectors ?-initial? ?-modified? ?-balanced?
This action gets a list of the connectors that are unbalanced.
-initial | This optional flag is the notification to get unbalanced connectors with dimensions the same as the initial or last balanced system. |
-modified | This optional flag is the notification to get unbalanced connectors with dimensions that have been explicitly modified. |
-balanced | This optional flag is the notification to get unbalanced connectors with dimensions that have been modified by use of the balance command. |
This action returns a list of pw::Connector objects.
$dim getUnbalancedDomains
This action gets a list of the domains that are unbalanced.
This action has no parameters.
This action returns a list of pw::Domain objects.
$dim getAffectedConnectors
This action gets a list of the connectors that are affected by the dimensioning.
This action has no parameters.
This action returns a list of pw::Connector objects.
$dim getAffectedDomains
This action gets a list of the domains that are affected by the dimensioning.
This action has no parameters.
This action returns a list of pw::Domain objects.
This action checks if the dimensions are currently balanced.
$dim isBalanced
This action checks if the dimensions can be reset to a previous balanced state.
$dim canReset
This action sets the dimensions back to the last balanced state.
$dim reset
This action tries to balance the current dimensions.
$dim balance ?-resetGeneralDistributions?
This action gets the number of connector dimensioning groups.
$dim getGroupCount
This action gets the connectors of a dimensioning group using the group index or a connector.
$dim getGroup < index | con >
This action gets the connectors of all of the dimensioning groups.
$dim getGroups
This action gets a list of the connectors that are unbalanced.
$dim getUnbalancedConnectors ?-initial? ?-modified? ?-balanced?
This action gets a list of the domains that are unbalanced.
$dim getUnbalancedDomains
This action gets a list of the connectors that are affected by the dimensioning.
$dim getAffectedConnectors
This action gets a list of the domains that are affected by the dimensioning.
$dim getAffectedDomains
This action begins a mode in the application.
pw::Application begin ?-mode_specific_flags? mode ?entities?