WeldPreferenceBuilder Class¶

class NXOpen.Weld.WeldPreferenceBuilder¶

Bases: NXOpen.Builder

Represents a NXOpen.Weld.WeldPreferenceBuilder builder

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

Default values.

Property	Value
CurrentGroupIDColorIndex	None
DatumIdLowerRange	1
DatumIdUpperRange	1000
DatumObjectLayer	255
MeasurementIdLowerRange	1
MeasurementIdUpperRange	1000
MeasurementObjectLayer	255
WeldArcGridLineEndCapDisp	0.1
WeldArcGridLineTopDisp	0.66
WeldConstLayer	231
WeldIdLowerRange	1
WeldIdUpperRange	1000
WeldObjectLayer	255
WeldSymbolDecimalPlaces	3

New in version NX6.0.0.

Properties¶

Property	Description
CurrentGroupIDColorIndex	Returns or sets the group idcolor assigned
DatumIdLowerRange	Returns or sets the datum id lower range
DatumIdUpperRange	Returns or sets the datum id upper range
DatumNamePrefix	Returns or sets the datum name prefix
DatumObjectColor	Returns or sets the datum object color
DatumObjectLayer	Returns or sets the datum object layer
DatumPartNumber	Returns or sets the datum part number
MeasurementIdLowerRange	Returns or sets the measurement id lower range
MeasurementIdUpperRange	Returns or sets the measurement id upper range
MeasurementNamePrefix	Returns or sets the measurement name prefix
MeasurementObjectColor	Returns or sets the measurement object color
MeasurementObjectLayer	Returns or sets the measurement object layer
MeasurementPartNumber	Returns or sets the measurement part number
Tag	Returns the Tag for this object.
WeldArcGridLineEndCapDisp	Returns or sets the weld arc grid line end cap disp
WeldArcGridLineTopDisp	Returns or sets the weld arc grid line top disp
WeldAssoColor	Returns or sets the weld asso color
WeldConstLayer	Returns or sets the weld const layer
WeldFixedColor	Returns or sets the weld fixed color
WeldGroupIdLowerRange	Returns or sets the weld group id lower range
WeldGroupIdUpperRange	Returns or sets the weld group id upper range
WeldIdLowerRange	Returns or sets the weld id lower range
WeldIdUpperRange	Returns or sets the weld id upper range
WeldNamePrefix	Returns or sets the weld name prefix
WeldObjectLayer	Returns or sets the weld object layer
WeldPartNumber	Returns or sets the weld part number
WeldRetainedColor	Returns or sets the weld retained color
WeldSymbolDecimalPlaces	Returns or sets the weld sym dec places

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.
GetDatumSelectedPrefix	The datum selected prefix
GetDatumSelectedSuffix	The datum selected suffix
GetMeasurementSelectedPrefix	The measurement selected prefix
GetMeasurementSelectedSuffix	The measurement selected suffix
GetObject	Returns the object currently being edited by this builder.
SetDatumSelectedPrefix	The datum selected prefix
SetDatumSelectedSuffix	Selected datum suffix
SetMeasurementSelectedPrefix	The measurement selected prefix
SetMeasurementSelectedSuffix	Selected measurement suffix
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¶

CurrentGroupIDColorIndex¶

WeldPreferenceBuilder.CurrentGroupIDColorIndex¶

Returns or sets the group idcolor assigned

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

Getter Method

Signature CurrentGroupIDColorIndex

Returns:
Return type:	`NXOpen.Weld.WeldGroupIdColor`

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CurrentGroupIDColorIndex

Parameters:	currentGroupIDColorIndex (`NXOpen.Weld.WeldGroupIdColor`) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

DatumIdLowerRange¶

WeldPreferenceBuilder.DatumIdLowerRange¶

Returns or sets the datum id lower range

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

Getter Method

Signature DatumIdLowerRange

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DatumIdLowerRange

Parameters:	datumIdLowerRange (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

DatumIdUpperRange¶

WeldPreferenceBuilder.DatumIdUpperRange¶

Returns or sets the datum id upper range

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

Getter Method

Signature DatumIdUpperRange

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DatumIdUpperRange

Parameters:	datumIdUpperRange (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

DatumNamePrefix¶

WeldPreferenceBuilder.DatumNamePrefix¶

Returns or sets the datum name prefix

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

Getter Method

Signature DatumNamePrefix

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DatumNamePrefix

Parameters:	datumNamePrefix (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

DatumObjectColor¶

WeldPreferenceBuilder.DatumObjectColor¶

Returns or sets the datum object color

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

Getter Method

Signature DatumObjectColor

Returns:
Return type:	Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DatumObjectColor

Parameters:	datumObjectColor (Id) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

DatumObjectLayer¶

WeldPreferenceBuilder.DatumObjectLayer¶

Returns or sets the datum object layer

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

Getter Method

Signature DatumObjectLayer

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DatumObjectLayer

Parameters:	datumObjectLayer (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

DatumPartNumber¶

WeldPreferenceBuilder.DatumPartNumber¶

Returns or sets the datum part number

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

Getter Method

Signature DatumPartNumber

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DatumPartNumber

Parameters:	datumPartNumber (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

MeasurementIdLowerRange¶

WeldPreferenceBuilder.MeasurementIdLowerRange¶

Returns or sets the measurement id lower range

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

Getter Method

Signature MeasurementIdLowerRange

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MeasurementIdLowerRange

Parameters:	measurementIdLowerRange (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

MeasurementIdUpperRange¶

WeldPreferenceBuilder.MeasurementIdUpperRange¶

Returns or sets the measurement id upper range

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

Getter Method

Signature MeasurementIdUpperRange

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MeasurementIdUpperRange

Parameters:	measurementIdUpperRange (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

MeasurementNamePrefix¶

WeldPreferenceBuilder.MeasurementNamePrefix¶

Returns or sets the measurement name prefix

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

Getter Method

Signature MeasurementNamePrefix

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MeasurementNamePrefix

Parameters:	measurementNamePrefix (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

MeasurementObjectColor¶

WeldPreferenceBuilder.MeasurementObjectColor¶

Returns or sets the measurement object color

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

Getter Method

Signature MeasurementObjectColor

Returns:
Return type:	Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MeasurementObjectColor

Parameters:	measurementObjectColor (Id) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

MeasurementObjectLayer¶

WeldPreferenceBuilder.MeasurementObjectLayer¶

Returns or sets the measurement object layer

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

Getter Method

Signature MeasurementObjectLayer

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MeasurementObjectLayer

Parameters:	measurementObjectLayer (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

MeasurementPartNumber¶

WeldPreferenceBuilder.MeasurementPartNumber¶

Returns or sets the measurement part number

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

Getter Method

Signature MeasurementPartNumber

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MeasurementPartNumber

Parameters:	measurementPartNumber (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldArcGridLineEndCapDisp¶

WeldPreferenceBuilder.WeldArcGridLineEndCapDisp¶

Returns or sets the weld arc grid line end cap disp

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

Getter Method

Signature WeldArcGridLineEndCapDisp

Returns:
Return type:	float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldArcGridLineEndCapDisp

Parameters:	weldArcGridLineEndCapDisp (float) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldArcGridLineTopDisp¶

WeldPreferenceBuilder.WeldArcGridLineTopDisp¶

Returns or sets the weld arc grid line top disp

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

Getter Method

Signature WeldArcGridLineTopDisp

Returns:
Return type:	float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldArcGridLineTopDisp

Parameters:	weldArcGridLineTopDisp (float) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldAssoColor¶

WeldPreferenceBuilder.WeldAssoColor¶

Returns or sets the weld asso color

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

Getter Method

Signature WeldAssoColor

Returns:
Return type:	Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldAssoColor

Parameters:	weldAssoColor (Id) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldConstLayer¶

WeldPreferenceBuilder.WeldConstLayer¶

Returns or sets the weld const layer

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

Getter Method

Signature WeldConstLayer

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldConstLayer

Parameters:	weldConstLayer (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldFixedColor¶

WeldPreferenceBuilder.WeldFixedColor¶

Returns or sets the weld fixed color

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

Getter Method

Signature WeldFixedColor

Returns:
Return type:	Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldFixedColor

Parameters:	weldFixedColor (Id) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldGroupIdLowerRange¶

WeldPreferenceBuilder.WeldGroupIdLowerRange¶

Returns or sets the weld group id lower range

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

Getter Method

Signature WeldGroupIdLowerRange

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldGroupIdLowerRange

Parameters:	weldGroupIdLowerRange (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldGroupIdUpperRange¶

WeldPreferenceBuilder.WeldGroupIdUpperRange¶

Returns or sets the weld group id upper range

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

Getter Method

Signature WeldGroupIdUpperRange

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldGroupIdUpperRange

Parameters:	weldGroupIdUpperRange (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldIdLowerRange¶

WeldPreferenceBuilder.WeldIdLowerRange¶

Returns or sets the weld id lower range

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

Getter Method

Signature WeldIdLowerRange

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldIdLowerRange

Parameters:	weldIdLowerRange (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldIdUpperRange¶

WeldPreferenceBuilder.WeldIdUpperRange¶

Returns or sets the weld id upper range

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

Getter Method

Signature WeldIdUpperRange

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldIdUpperRange

Parameters:	weldIdUpperRange (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldNamePrefix¶

WeldPreferenceBuilder.WeldNamePrefix¶

Returns or sets the weld name prefix

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

Getter Method

Signature WeldNamePrefix

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldNamePrefix

Parameters:	weldNamePrefix (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldObjectLayer¶

WeldPreferenceBuilder.WeldObjectLayer¶

Returns or sets the weld object layer

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

Getter Method

Signature WeldObjectLayer

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldObjectLayer

Parameters:	weldObjectLayer (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldPartNumber¶

WeldPreferenceBuilder.WeldPartNumber¶

Returns or sets the weld part number

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

Getter Method

Signature WeldPartNumber

Returns:
Return type:	str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldPartNumber

Parameters:	weldPartNumber (str) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldRetainedColor¶

WeldPreferenceBuilder.WeldRetainedColor¶

Returns or sets the weld retained color

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

Getter Method

Signature WeldRetainedColor

Returns:
Return type:	Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldRetainedColor

Parameters:	weldRetainedColor (Id) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

WeldSymbolDecimalPlaces¶

WeldPreferenceBuilder.WeldSymbolDecimalPlaces¶

Returns or sets the weld sym dec places

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

Getter Method

Signature WeldSymbolDecimalPlaces

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature WeldSymbolDecimalPlaces

Parameters:	weldSymbolDecimalPlaces (int) –

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

Method Detail¶

GetDatumSelectedPrefix¶

WeldPreferenceBuilder.GetDatumSelectedPrefix¶

The datum selected prefix

Signature GetDatumSelectedPrefix()

Returns:	Selected datum prefix
Return type:	list of str

New in version NX6.0.0.

License requirements: None.

GetDatumSelectedSuffix¶

WeldPreferenceBuilder.GetDatumSelectedSuffix¶

The datum selected suffix

Signature GetDatumSelectedSuffix()

Returns:	Selected datum suffix
Return type:	list of str

New in version NX6.0.0.

License requirements: None.

GetMeasurementSelectedPrefix¶

WeldPreferenceBuilder.GetMeasurementSelectedPrefix¶

The measurement selected prefix

Signature GetMeasurementSelectedPrefix()

Returns:	Selected measurement prefix
Return type:	list of str

New in version NX6.0.0.

License requirements: None.

GetMeasurementSelectedSuffix¶

WeldPreferenceBuilder.GetMeasurementSelectedSuffix¶

The measurement selected suffix

Signature GetMeasurementSelectedSuffix()

Returns:	Selected measurement suffix
Return type:	list of str

New in version NX6.0.0.

License requirements: None.

SetDatumSelectedPrefix¶

WeldPreferenceBuilder.SetDatumSelectedPrefix¶

The datum selected prefix

Signature SetDatumSelectedPrefix(datumSelectedPrefix)

Parameters:	datumSelectedPrefix (list of str) – Selected datum prefix

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

SetDatumSelectedSuffix¶

WeldPreferenceBuilder.SetDatumSelectedSuffix¶

Selected datum suffix

Signature SetDatumSelectedSuffix(datumSelectedSuffix)

Parameters:	datumSelectedSuffix (list of str) – Selected datum suffix

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

SetMeasurementSelectedPrefix¶

WeldPreferenceBuilder.SetMeasurementSelectedPrefix¶

The measurement selected prefix

Signature SetMeasurementSelectedPrefix(measurementSelectedPrefix)

Parameters:	measurementSelectedPrefix (list of str) – Selected measurement prefix

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

SetMeasurementSelectedSuffix¶

WeldPreferenceBuilder.SetMeasurementSelectedSuffix¶

Selected measurement suffix

Signature SetMeasurementSelectedSuffix(measurementSelectedSuffix)

Parameters:	measurementSelectedSuffix (list of str) – Selected measurement suffix

New in version NX6.0.0.

License requirements: ugweld (“UG WELD”)

Validate¶

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