CharacteristicsBuilder Class

class NXOpen.Weld.CharacteristicsBuilder

Bases: NXOpen.Builder

This builder allows you to define the attribute values to be set on the output of the weld feature.

To create a new instance of this class, use NXOpen.Weld.WeldManager.CreateCharacteristicsBuilder()

New in version NX7.5.0.

Properties

Property Description
InheritObject Returns the selection object containing data that is used to define the attribute values.
Selected Returns or sets the selected characteristic value.
SelectionList Returns the list of potential attributes and objects selected for this weld feature.
Tag Returns the Tag for this object.

Methods

Method Description
ApplyAttributes Apply the selected attributes to the objects.
ApplyAttributesToSelected Apply the selected attributes to the objects that were selected.
AreAttributesDefault Returns true if the characteristics builder contains all attributes with default values.
ChangeFeatureType Change the type of feature defining the attributes.
Commit Commits any edits that have been applied to the builder.
CopyAttributesFromObject Copy the attributes that are on the object to the selection.
CopyAttributesFromObjectForPaint Copies the attributes that are on the object to the selection for paint.
CopyNonActiveAttributesFromObject Copy the non active attributes that are on the object to the selection.
CreateSelectionSet Create a new selection set and add it to the list.
Destroy Deletes the builder, and cleans up any objects created by the builder.
DoesObjectHaveAttributes Copy the attributes that are on the object to the selection and returns a flag indicating whether the object actually has attributes.
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.
HasActiveValues Returns true if the characteristics builder has any active values.
InheritAttributesFromObject Inherit the attributes that are on the object to the selection.
RemoveAllAttributes Remove all attributes from the objects.
RemoveInheritedAttributes Remove any attributes that are inherited from other objects (for example, edges).
SetAllAttributesChanged Sets all attributes to be changed.
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.

Enumerations

CharacteristicsBuilderType Enumeration The custom type of the datum specified for creation.

Property Detail

InheritObject

CharacteristicsBuilder.InheritObject

Returns the selection object containing data that is used to define the attribute values.

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

Getter Method

Signature InheritObject

Returns:
Return type:NXOpen.SelectNXObject

New in version NX7.5.0.

License requirements: None.

Selected

CharacteristicsBuilder.Selected

Returns or sets the selected characteristic value.

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

Getter Method

Signature Selected

Returns:
Return type:NXOpen.Weld.CharacteristicsValueBuilder

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Selected

Parameters:valueBuilder (NXOpen.Weld.CharacteristicsValueBuilder) –

New in version NX7.5.0.

License requirements: None.

SelectionList

CharacteristicsBuilder.SelectionList

Returns the list of potential attributes and objects selected for this weld feature.

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

Getter Method

Signature SelectionList

Returns:
Return type:NXOpen.NXObjectList

New in version NX7.5.0.

License requirements: None.

Method Detail

ApplyAttributes

CharacteristicsBuilder.ApplyAttributes

Apply the selected attributes to the objects.

Signature ApplyAttributes(objects)

Parameters:objects (list of NXOpen.NXObject) – The objects to apply the attributes to.

New in version NX7.5.0.

License requirements: None.

ApplyAttributesToSelected

CharacteristicsBuilder.ApplyAttributesToSelected

Apply the selected attributes to the objects that were selected.

Signature ApplyAttributesToSelected()

New in version NX7.5.0.

License requirements: None.

AreAttributesDefault

CharacteristicsBuilder.AreAttributesDefault

Overloaded method AreAttributesDefault

  • AreAttributesDefault(weldType)
  • AreAttributesDefault(charxType)

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

Returns true if the characteristics builder contains all attributes with default values.

Signature AreAttributesDefault(weldType)

Parameters:weldType (int) – The type of welding feature being processed, see uf_weld_types.h.
Returns:
Return type:bool

New in version NX8.0.0.

Deprecated since version NX9.0.0: Use overloaded function with enum instead.

License requirements: None.

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

Returns true if the characteristics builder contains all attributes with default values.

Signature AreAttributesDefault(charxType)

Parameters:charxType (NXOpen.Weld.CharacteristicsBuilderType) – The type of characteristics being processed
Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

ChangeFeatureType

CharacteristicsBuilder.ChangeFeatureType

Overloaded method ChangeFeatureType

  • ChangeFeatureType(weldType)
  • ChangeFeatureType(charxType)

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

Change the type of feature defining the attributes. Note after calling this method, the WeldJA::CharacteristicsValueBuilder objects previously retrieved will be invalid. You need to reaccess them if you want to make any changes to them.

Signature ChangeFeatureType(weldType)

Parameters:weldType (int) – The type of welding feature being processed, see uf_weld_types.h.

New in version NX7.5.0.

Deprecated since version NX9.0.0: Use overloaded function with enum instead.

License requirements: None.

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

Change the type of feature defining the attributes. Note after calling this method, the WeldJA::CharacteristicsValueBuilder objects previously retrieved will be invalid. You need to reaccess them if you want to make any changes to them.

Signature ChangeFeatureType(charxType)

Parameters:charxType (NXOpen.Weld.CharacteristicsBuilderType) – The type of characteristics being processed

New in version NX9.0.0.

License requirements: None.

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

CopyAttributesFromObject

CharacteristicsBuilder.CopyAttributesFromObject

Copy the attributes that are on the object to the selection.

Signature CopyAttributesFromObject(object)

Parameters:object (NXOpen.NXObject) – The object from which to copy the attributes.

New in version NX8.0.0.

License requirements: None.

CopyAttributesFromObjectForPaint

CharacteristicsBuilder.CopyAttributesFromObjectForPaint

Copies the attributes that are on the object to the selection for paint.

Signature CopyAttributesFromObjectForPaint(objectTag)

Parameters:objectTag (NXOpen.NXObject) – The object from which to copy the attributes.

New in version NX10.0.0.

License requirements: None.

CopyNonActiveAttributesFromObject

CharacteristicsBuilder.CopyNonActiveAttributesFromObject

Copy the non active attributes that are on the object to the selection.

Signature CopyNonActiveAttributesFromObject(object)

Parameters:object (NXOpen.NXObject) – The object from which to copy the attributes.

New in version NX8.0.0.

License requirements: None.

CreateSelectionSet

CharacteristicsBuilder.CreateSelectionSet

Overloaded method CreateSelectionSet

  • CreateSelectionSet(weldType, data)
  • CreateSelectionSet(charxType, data)

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

Create a new selection set and add it to the list.

Signature CreateSelectionSet(weldType, data)

Parameters:
  • weldType (int) – The type of welding feature being processed, see uf_weld_types.h.
  • data (NXOpen.NXObject) – An object to retrieve the current attribute settings.
Returns:
Return type:

NXOpen.Weld.CharacteristicsSelectionBuilder

New in version NX7.5.0.

Deprecated since version NX9.0.0: Use overloaded function with enum instead.

License requirements: None.

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

Create a new selection set and add it to the list.

Signature CreateSelectionSet(charxType, data)

Parameters:
Returns:
Return type:

NXOpen.Weld.CharacteristicsSelectionBuilder

New in version NX9.0.0.

License requirements: None.

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

DoesObjectHaveAttributes

CharacteristicsBuilder.DoesObjectHaveAttributes

Copy the attributes that are on the object to the selection and returns a flag indicating whether the object actually has attributes.

Signature DoesObjectHaveAttributes(object)

Parameters:object (NXOpen.NXObject) – The object from which to copy the attributes.
Returns:
Return type:bool

New in version NX8.0.1.

License requirements: None.

HasActiveValues

CharacteristicsBuilder.HasActiveValues

Returns true if the characteristics builder has any active values.

Signature HasActiveValues()

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

InheritAttributesFromObject

CharacteristicsBuilder.InheritAttributesFromObject

Inherit the attributes that are on the object to the selection.

Signature InheritAttributesFromObject(object)

Parameters:object (NXOpen.NXObject) – The object from which to inherit the attributes.

New in version NX8.5.0.

License requirements: None.

RemoveAllAttributes

CharacteristicsBuilder.RemoveAllAttributes

Remove all attributes from the objects.

Signature RemoveAllAttributes(objects)

Parameters:objects (list of NXOpen.NXObject) – The objects to remove the attributes from.

New in version NX8.0.0.

License requirements: None.

RemoveInheritedAttributes

CharacteristicsBuilder.RemoveInheritedAttributes

Remove any attributes that are inherited from other objects (for example, edges).

These will be attributes that are not required and are not in a category.

Signature RemoveInheritedAttributes()

New in version NX8.0.1.

License requirements: None.

SetAllAttributesChanged

CharacteristicsBuilder.SetAllAttributesChanged

Overloaded method SetAllAttributesChanged

  • SetAllAttributesChanged()
  • SetAllAttributesChanged(status)

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

Sets all attributes to be changed.

Signature SetAllAttributesChanged()

New in version NX8.5.0.

License requirements: None.

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

Sets all attributes changed value to the status value.

Signature SetAllAttributesChanged(status)

Parameters:status (bool) – The value to set changed value. true means attribute has been changed, false means attribute has not been changed

New in version NX9.0.0.

License requirements: None.

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

Validate

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