RoutingMeasureDistanceBuilder Class¶
-
class
NXOpen.Routing.
RoutingMeasureDistanceBuilder
¶ Bases:
NXOpen.MeasureDistanceBuilder
Represents a
NXOpen.Routing.RoutingMeasureDistanceBuilder
Creator not available in KF because transient objects are not supported.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AnnotationMode | Returns or sets the annotation mode |
DiameterObjects | Returns the diameter objects |
DistanceCollector1 | Returns the first collector of objects for distance between two collectors |
DistanceCollector2 | Returns the second collector of objects for distance between two collectors |
InfoWindow | Returns or sets the info window |
IsExact | Returns or sets the exact flag |
LengthCollector | Returns the length collector of objects |
LengthObjects | Returns the length objects |
Mtype | Returns or sets the mtype |
Object1 | Returns the object1 |
Object2 | Returns the object2 |
ProjectionVector | Returns or sets the projection vector |
RadiusObjects | Returns the radius objects |
RequirementMode | Returns or sets the requirement mode |
RoutingSelection | Returns or sets the NXOpen.Routing.RouteObjectCollector |
Set1 | Returns the set1 |
Set2 | Returns the set2 |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetRoutingObjects | The routing objects used for path length @return the routing objects used for path length |
SetRoutingObjects | The routing objects used for path length |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
RoutingSelection¶
-
RoutingMeasureDistanceBuilder.
RoutingSelection
¶ Returns or sets the
NXOpen.Routing.RouteObjectCollector
-------------------------------------
Getter Method
Signature
RoutingSelection()
Returns: Return type: NXOpen.Routing.RouteObjectCollector
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RoutingSelection(selectionBuilder)
Parameters: selectionBuilder ( NXOpen.Routing.RouteObjectCollector
) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
GetRoutingObjects¶
-
RoutingMeasureDistanceBuilder.
GetRoutingObjects
¶ The routing objects used for path length
Signature
GetRoutingObjects()
Returns: the routing objects used for path length Return type: list of NXOpen.NXObject
New in version NX6.0.0.
License requirements: None.
SetRoutingObjects¶
-
RoutingMeasureDistanceBuilder.
SetRoutingObjects
¶ The routing objects used for path length
Signature
SetRoutingObjects(routingObjects)
Parameters: routingObjects (list of NXOpen.NXObject
) – the routing objects to set for path lengthNew in version NX6.0.0.
License requirements: None.
Validate¶
-
RoutingMeasureDistanceBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.