FormTaskBuilder Class

class NXOpen.Die.FormTaskBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a Form Task feature builder.

To create a new instance of this class, use NXOpen.Die.DieCollection.FormTask()

New in version NX4.0.0.

Properties

Property Description
AngleTolerance Returns or sets the angle tolerance of the form task.
CamDirection Returns or sets the cam direction of the form task.
DistanceTolerance Returns or sets the distance tolerance of the form task.
FinishOperation Returns or sets the finish operation switch of the form task, if true the form task is a finish operation, if false it is not.
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
PointInRegion Returns or sets the point in region of the form task.
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
TippedProduct Returns or sets the tipped product of the form task.

Methods

Method Description
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.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetDetails Gets the details of the form task.
GetFeature Returns the feature currently being edited by this builder.
GetObject Returns the object currently being edited by this builder.
GetRegionBounds Gets the region bounds of the form task.
GetShapeDetail Gets the shape detail of the form task as a profile.
HideInternalParentFeatureAfterEdit Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetDetails Sets the details of the form task.
SetParentFeatureInternal Set the parent features which would be internal or slaves to the feature being created or commited
SetRegionBounds Sets the region bounds of the form task.
SetShapeDetail Sets the shape detail of the form task using a profile.
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.

Property Detail

AngleTolerance

FormTaskBuilder.AngleTolerance

Returns or sets the angle tolerance of the form task.

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

Getter Method

Signature AngleTolerance

Returns:
Return type:float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature AngleTolerance

Parameters:angleTolerance (float) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

CamDirection

FormTaskBuilder.CamDirection

Returns or sets the cam direction of the form task.

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

Getter Method

Signature CamDirection

Returns:
Return type:NXOpen.ILocation

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature CamDirection

Parameters:camDirection (NXOpen.ILocation) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

DistanceTolerance

FormTaskBuilder.DistanceTolerance

Returns or sets the distance tolerance of the form task.

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

Getter Method

Signature DistanceTolerance

Returns:
Return type:float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature DistanceTolerance

Parameters:distanceTolerance (float) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

FinishOperation

FormTaskBuilder.FinishOperation

Returns or sets the finish operation switch of the form task, if true the form task is a finish operation, if false it is not.

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

Getter Method

Signature FinishOperation

Returns:
Return type:bool

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature FinishOperation

Parameters:finishOperation (bool) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

PointInRegion

FormTaskBuilder.PointInRegion

Returns or sets the point in region of the form task.

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

Getter Method

Signature PointInRegion

Returns:
Return type:NXOpen.Point

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature PointInRegion

Parameters:pointInRegion (NXOpen.Point) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

TippedProduct

FormTaskBuilder.TippedProduct

Returns or sets the tipped product of the form task.

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

Getter Method

Signature TippedProduct

Returns:
Return type:NXOpen.Features.Feature

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature TippedProduct

Parameters:tippedProduct (NXOpen.Features.Feature) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

Method Detail

GetDetails

FormTaskBuilder.GetDetails

Gets the details of the form task.

Signature GetDetails()

Returns:Detail strings.
Return type:list of str

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetRegionBounds

FormTaskBuilder.GetRegionBounds

Gets the region bounds of the form task.

Signature GetRegionBounds()

Returns:a tuple
Return type:A tuple consisting of (profileEntries, direction). profileEntries is a list of NXOpen.IProfile. The profile entries, will be curves, edges, faces, sketches or curve features. direction is a NXOpen.Die.DirectionOption. Profile direction.

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetShapeDetail

FormTaskBuilder.GetShapeDetail

Gets the shape detail of the form task.

Signature GetShapeDetail()

Returns:Sheet bodies defining the unfinished shape.
Return type:list of NXOpen.Body

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetDetails

FormTaskBuilder.SetDetails

Sets the details of the form task.

Signature SetDetails(strings)

Parameters:strings (list of str) – Detail strings.

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetRegionBounds

FormTaskBuilder.SetRegionBounds

Sets the region bounds of the form task.

Signature SetRegionBounds(direction, profileEntries)

Parameters:

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetShapeDetail

FormTaskBuilder.SetShapeDetail

Overloaded method SetShapeDetail

  • SetShapeDetail(direction, profileEntries)
  • SetShapeDetail(bodies)

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

Sets the shape detail of the form task using a profile.

Signature SetShapeDetail(direction, profileEntries)

Parameters:

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Sets the shape detail of the form task.

Signature SetShapeDetail(bodies)

Parameters:bodies (list of NXOpen.Body) – Sheet bodies defining the unfinished shape.

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Validate

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