JoeBuilder Class¶

class NXOpen.Features.JoeBuilder¶

Bases: NXOpen.Features.FeatureBuilder

Builds a Joe feature

To create a new instance of this class, use NXOpen.DebugSession.CreateJoeBuilder()

Default values.

Property	Value
LineWidthTest.LineWidthSettings.Width	Normal
LineWidthTest.LineWidthSettings.WidthOption	Assigned
Toggle	False
ValueTest.Color	5

New in version NX5.0.0.

Properties¶

Property	Description
AngularDimension	Returns the angular dimension
BooleanOperation	Returns the boolean operation
DateTest	Returns the date and time
Dimension	Returns the length
DisableSelections	Returns or sets the flag that if true, section, selection, and other selections are disabled
DiscreetType	Returns or sets the discreet type
DoubleLinearDimension	Returns the double linear dimension
EnumTest	Returns the enum test
Expression	Returns the expression
Integer	Returns or sets the integer
LineWidthTest	Returns the line width
List	Returns the list
Name	Returns or sets the name
OnPathDim	Returns
ParentFeatureInternal	Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag	Returns or sets the patch solution flag
PatchSurfaceFilename	Returns or sets the patch surface filename
Path	Returns
Point	Returns or sets the location
RadiusDimension	Returns the radius dimension
Section	Returns the section
Seldimlist	Returns the seldimlist
Selection	Returns the selected object
StringTest	Returns the string test
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
Toggle	Returns or sets the toggle
Tolerance	Returns or sets the tolerance
TwoSidedAngular	Returns the two-sided angular dimension
TwoSidedLinear	Returns the two-sided linear dimension
ValueTest	Returns the value test

Methods¶

Method	Description
ActionButton	Do an action
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
Destroy	Deletes the builder, and cleans up any objects created by the builder.
DoSevereException	Tests doing a severe exception
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature	Returns the feature currently being edited by this builder.
GetLines	The lines of text
GetNonItiLines	Non-iti lines of text
GetObject	Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit	Re-suppress an internal parent feature (a slave feature) after it has been edited.
NewListItem	Creates a new list item
SetLines
SetNonItiLines
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit	Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal	Set the internal parent feature of the feature being edited to external
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

JoeBuilderDiscreetTypes Enumeration

Enumeration of discreet types

Property Detail¶

AngularDimension¶

JoeBuilder.AngularDimension¶

Returns the angular dimension

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

Getter Method

Signature AngularDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

BooleanOperation¶

JoeBuilder.BooleanOperation¶

Returns the boolean operation

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

Getter Method

Signature BooleanOperation

Returns:
Return type:	`NXOpen.GeometricUtilities.BooleanOperation`

New in version NX5.0.0.

License requirements: None.

DateTest¶

JoeBuilder.DateTest¶

Returns the date and time

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

Getter Method

Signature DateTest

Returns:
Return type:	`NXOpen.DateTest`

New in version NX8.0.0.

License requirements: None.

Dimension¶

JoeBuilder.Dimension¶

Returns the length

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

Getter Method

Signature Dimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

DisableSelections¶

JoeBuilder.DisableSelections¶

Returns or sets the flag that if true, section, selection, and other selections are disabled

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

Getter Method

Signature DisableSelections

Returns:
Return type:	bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature DisableSelections

Parameters:	disableSelections (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DiscreetType¶

JoeBuilder.DiscreetType¶

Returns or sets the discreet type

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

Getter Method

Signature DiscreetType

Returns:
Return type:	`NXOpen.Features.JoeBuilderDiscreetTypes`

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature DiscreetType

Parameters:	discreetType (`NXOpen.Features.JoeBuilderDiscreetTypes`) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoubleLinearDimension¶

JoeBuilder.DoubleLinearDimension¶

Returns the double linear dimension

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

Getter Method

Signature DoubleLinearDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

EnumTest¶

JoeBuilder.EnumTest¶

Returns the enum test

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

Getter Method

Signature EnumTest

Returns:
Return type:	`NXOpen.GeometricUtilities.EnumTest`

New in version NX5.0.0.

License requirements: None.

Expression¶

JoeBuilder.Expression¶

Returns the expression

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

Getter Method

Signature Expression

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

Integer¶

JoeBuilder.Integer¶

Returns or sets the integer

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

Getter Method

Signature Integer

Returns:
Return type:	int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Integer

Parameters:	integer (int) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

LineWidthTest¶

JoeBuilder.LineWidthTest¶

Returns the line width

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

Getter Method

Signature LineWidthTest

Returns:
Return type:	`NXOpen.LineWidthTestBuilder`

New in version NX8.0.0.

License requirements: None.

List¶

JoeBuilder.List¶

Returns the list

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

Getter Method

Signature List

Returns:
Return type:	`NXOpen.Features.JoeListItemList`

New in version NX5.0.0.

License requirements: None.

Name¶

JoeBuilder.Name¶

Returns or sets the name

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

Getter Method

Signature Name

Returns:
Return type:	str

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:	name (str) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

OnPathDim¶

JoeBuilder.OnPathDim¶

Returns

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

Getter Method

Signature OnPathDim

Returns:
Return type:	`NXOpen.GeometricUtilities.OnPathDimensionBuilder`

New in version NX5.0.0.

License requirements: None.

Path¶

JoeBuilder.Path¶

Returns

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

Getter Method

Signature Path

Returns:
Return type:	`NXOpen.SelectObject`

New in version NX5.0.0.

License requirements: None.

Point¶

JoeBuilder.Point¶

Returns or sets the location

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

Getter Method

Signature Point

Returns:
Return type:	`NXOpen.Point`

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Point

Parameters:	location (`NXOpen.Point`) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

RadiusDimension¶

JoeBuilder.RadiusDimension¶

Returns the radius dimension

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

Getter Method

Signature RadiusDimension

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

Section¶

JoeBuilder.Section¶

Returns the section

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

Getter Method

Signature Section

Returns:
Return type:	`NXOpen.Section`

New in version NX5.0.0.

License requirements: None.

Seldimlist¶

JoeBuilder.Seldimlist¶

Returns the seldimlist

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

Getter Method

Signature Seldimlist

Returns:
Return type:	`NXOpen.ExpressionCollectorSetList`

New in version NX5.0.0.

License requirements: None.

Selection¶

JoeBuilder.Selection¶

Returns the selected object

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

Getter Method

Signature Selection

Returns:
Return type:	`NXOpen.SelectObjectList`

New in version NX5.0.0.

License requirements: None.

StringTest¶

JoeBuilder.StringTest¶

Returns the string test

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

Getter Method

Signature StringTest

Returns:
Return type:	`NXOpen.GeometricUtilities.StringTestBuilder`

New in version NX5.0.0.

License requirements: None.

Toggle¶

JoeBuilder.Toggle¶

Returns or sets the toggle

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

Getter Method

Signature Toggle

Returns:
Return type:	bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Toggle

Parameters:	convex (bool) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Tolerance¶

JoeBuilder.Tolerance¶

Returns or sets the tolerance

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

Getter Method

Signature Tolerance

Returns:
Return type:	float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Tolerance

Parameters:	tolerance (float) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

TwoSidedAngular¶

JoeBuilder.TwoSidedAngular¶

Returns the two-sided angular dimension

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

Getter Method

Signature TwoSidedAngular

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

TwoSidedLinear¶

JoeBuilder.TwoSidedLinear¶

Returns the two-sided linear dimension

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

Getter Method

Signature TwoSidedLinear

Returns:
Return type:	`NXOpen.Expression`

New in version NX5.0.0.

License requirements: None.

ValueTest¶

JoeBuilder.ValueTest¶

Returns the value test

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

Getter Method

Signature ValueTest

Returns:
Return type:	`NXOpen.GeometricUtilities.ValueTestBuilder`

New in version NX5.0.0.

License requirements: None.

Method Detail¶

ActionButton¶

JoeBuilder.ActionButton¶

Do an action

Signature ActionButton()

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoSevereException¶

JoeBuilder.DoSevereException¶

Tests doing a severe exception

Signature DoSevereException()

New in version NX6.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

GetLines¶

JoeBuilder.GetLines¶

The lines of text

Signature GetLines()

Returns:
Return type:	list of str

New in version NX5.0.0.

License requirements: None.

GetNonItiLines¶

JoeBuilder.GetNonItiLines¶

Non-iti lines of text

Signature GetNonItiLines()

Returns:
Return type:	list of str

New in version NX5.0.0.

License requirements: None.

NewListItem¶

JoeBuilder.NewListItem¶

Creates a new list item

Signature NewListItem(value, name, position)

Parameters:	value (float) – initial value in part units name (str) – name position (int) – position
Returns:
Return type:	`NXOpen.Features.JoeListItem`

New in version NX5.0.0.

License requirements: None.

SetLines¶

JoeBuilder.SetLines¶

Signature SetLines(lines)

Parameters:	lines (list of str) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetNonItiLines¶

JoeBuilder.SetNonItiLines¶

Signature SetNonItiLines(lines)

Parameters:	lines (list of str) –

New in version NX5.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Validate¶

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