EditCharacteristicsBuilder Class

class NXOpen.Routing.EditCharacteristicsBuilder

Bases: NXOpen.Builder

Builder to edit required and optional characteristics of Routing.Stock or Assemblies.Component as defined in the application view file.

To create a new instance of this class, use NXOpen.Routing.RouteManager.CreateEditCharacteristicsBuilder()

New in version NX7.5.0.

Properties

Property	Description
ReferenceObject	Returns the reference object to obtain the characteristic values
RouteObjectCollector	Returns the routing objects to edit characteristics.
RoutingLevel	Returns or sets the Routing Level associated with selected objects.
Tag	Returns the Tag for this object.

Methods

Method	Description
ApplyReferenceObjectCharx	Apply characteristics of the reference object to the selected objects.
ClearValues	Clear the characteristic values of the selected objects.
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.
GetOptionalCharacteristicsToEdit	Returns the editable Routing.CharacteristicList that contains optional characteristics common to all the selected objects.
GetRequiredCharacteristicsToEdit	Returns the editable Routing.CharacteristicList that contains required characteristics common to all the selected objects.
ResetValues	Reset the characteristic values of the selected objects.
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

ReferenceObject

EditCharacteristicsBuilder.ReferenceObject

Returns the reference object to obtain the characteristic values

-------------------------------------

Getter Method

Signature ReferenceObject

Returns: Return type:NXOpen.SelectNXObject

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

RouteObjectCollector

EditCharacteristicsBuilder.RouteObjectCollector

Returns the routing objects to edit characteristics.

The objects should be either Routing.Stock or Assemblies.Component

-------------------------------------

Getter Method

Signature RouteObjectCollector

Returns: Return type:NXOpen.Routing.RouteObjectCollector

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

RoutingLevel

EditCharacteristicsBuilder.RoutingLevel

Returns or sets the Routing Level associated with selected objects.

-------------------------------------

Getter Method

Signature RoutingLevel

Returns: Return type:str

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

-------------------------------------

Setter Method

Signature RoutingLevel

Parameters:routeLevel (str) –

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

Method Detail

ApplyReferenceObjectCharx

EditCharacteristicsBuilder.ApplyReferenceObjectCharx

Apply characteristics of the reference object to the selected objects.

Signature ApplyReferenceObjectCharx(refObject)

Parameters:refObject (NXOpen.NXObject) –

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

ClearValues

EditCharacteristicsBuilder.ClearValues

Clear the characteristic values of the selected objects.

Signature ClearValues()

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

GetOptionalCharacteristicsToEdit

EditCharacteristicsBuilder.GetOptionalCharacteristicsToEdit

Returns the editable Routing.CharacteristicList that contains optional characteristics common to all the selected objects.

Signature GetOptionalCharacteristicsToEdit()

Returns:The characteristics to edit. Return type:NXOpen.Routing.CharacteristicList

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

GetRequiredCharacteristicsToEdit

EditCharacteristicsBuilder.GetRequiredCharacteristicsToEdit

Returns the editable Routing.CharacteristicList that contains required characteristics common to all the selected objects.

Signature GetRequiredCharacteristicsToEdit()

Returns:The characteristics to edit. Return type:NXOpen.Routing.CharacteristicList

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

ResetValues

EditCharacteristicsBuilder.ResetValues

Reset the characteristic values of the selected objects.

Signature ResetValues()

New in version NX7.5.0.

License requirements: routing_base (“Routing Basic”)

Validate

EditCharacteristicsBuilder.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.