Move Collections by Minimizing Relationships    

Performs a relationship fit (minimization) moving the specified collections.

 

Input Arguments

 

0

String Ref List

Collections To Move

A list of the collections to move.

1

Relationship Ref List

Relationships to Minimize

List of relationships to use.

2

Boolean

Perform “Direct”

Controls if direct is used.

3

Fit Degree-Of-Freedom Options

Motion to allow

Sets the DoF to use in the optimization.

4

Boolean

Use Fit Dialog

Controls if the fit dialog is displayed.

5

Double

Convergence Threshold

The convergence threshold defines when the optimization is considered complete.

 

Return Arguments

None.

 

Returned Status

 

SUCCESS

The relationship optimization was completed successfully.

FAILURE

The specified relationship was not found.

 

Remarks

The relationship list sets the use status for the relationships in the dialog if displayed. Currently degrees of freedom set here in (A3) set the same condition for all specified collections.

The Convergence Threshold is used to determine when to stop the optimization process. If an optimization iteration “n” fails to improve the square of the objective function (obj) by the square of convergence threshold amount (CT), then the optimization termination criteria is satisfied. So termination occurs when

objn-12 - objn2 < CT2

Some optimizations may satisfy their relationships’ tolerances many iterations before the objective function improve- ment is sufficiently small enough compared to the default convergence threshold. In these cases, the convergence threshold can be increased to reduce the time it takes to optimize. This threshold should be evaluated against the precision required in moving the collections.