FlangeTaskBuilder Class

class NXOpen.Die.FlangeTaskBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a Flange Task feature builder.

This sub feature is created via the main feature builder.

New in version NX4.0.0.

Properties

Property Description
AngleTolerance Returns or sets the angle tolerance of the flange task
CamDirection Returns or sets the cam direction of the flange task
CamType Returns or sets the cam type of the flange task
DisplayRotatedItems Returns or sets the display rotated items setting of the flange task.
DistanceTolerance Returns or sets the distance tolerance of the flange task
FinishOperation Returns or sets the finish operation of the flange task
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
PierceAndExtrude Returns or sets the pierce and extrude setting of the flange task.
PierceType Returns or sets the pierce type of the flange task
PointInRegion Returns or sets the keep point in the region of the flange task
SpringbackAngle Returns or sets the springback angle of the flange task
SpringbackType Returns or sets the springback type of the flange 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 flange 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.
GetAssociativeObjects Gets the associative objects of the flange task
GetCameraLayerAndXmlp Gets the camera layer settings and xmlp data
GetCameraNames Gets the names of the camera
GetCameraViews Gets the camera views of the flange task
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetDetails Gets the detailed description of the flange 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 flange task
GetShapeDetail Gets the shape detail of the flange task for profiles
HideInternalParentFeatureAfterEdit Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetAssociativeObjects Sets the associative objects of the flange task
SetCameraLayerAndXmlp Sets the camera layer settings and xmlp data
SetCameraNames Sets the names of the camera
SetCameraViews Sets the camera views of the flange task
SetDetails Sets the detailed description of the flange 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 flange task
SetShapeDetail Sets the shape detail of the flange task for profiles
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

FlangeTaskBuilderCamTypes Enumeration Settings for the cam type of the flange task.
FlangeTaskBuilderPierceTypes Enumeration Settings for the pierce type of the flange task.
FlangeTaskBuilderSpringbackTypes Enumeration Settings for the springback type of the flange task.

Property Detail

AngleTolerance

FlangeTaskBuilder.AngleTolerance

Returns or sets the angle tolerance of the flange 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

FlangeTaskBuilder.CamDirection

Returns or sets the cam direction of the flange 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”)

CamType

FlangeTaskBuilder.CamType

Returns or sets the cam type of the flange task

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

Getter Method

Signature CamType

Returns:
Return type:NXOpen.Die.FlangeTaskBuilderCamTypes

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature CamType

Parameters:camType (NXOpen.Die.FlangeTaskBuilderCamTypes) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

DisplayRotatedItems

FlangeTaskBuilder.DisplayRotatedItems

Returns or sets the display rotated items setting of the flange task.

True indicates that the reference point and cam direction objects should be created and displayed in the die face feature.

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

Getter Method

Signature DisplayRotatedItems

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature DisplayRotatedItems

Parameters:displaySetting (bool) –

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

DistanceTolerance

FlangeTaskBuilder.DistanceTolerance

Returns or sets the distance tolerance of the flange 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

FlangeTaskBuilder.FinishOperation

Returns or sets the finish operation of the flange task

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

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”)

PierceAndExtrude

FlangeTaskBuilder.PierceAndExtrude

Returns or sets the pierce and extrude setting of the flange task.

True indicates that the flange task is a pierce and extrude type.

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

Getter Method

Signature PierceAndExtrude

Returns:
Return type:bool

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature PierceAndExtrude

Parameters:pierceAndExtrude (bool) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

PierceType

FlangeTaskBuilder.PierceType

Returns or sets the pierce type of the flange task

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

Getter Method

Signature PierceType

Returns:
Return type:NXOpen.Die.FlangeTaskBuilderPierceTypes

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature PierceType

Parameters:pierceType (NXOpen.Die.FlangeTaskBuilderPierceTypes) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

PointInRegion

FlangeTaskBuilder.PointInRegion

Returns or sets the keep point in the region of the flange 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”)

SpringbackAngle

FlangeTaskBuilder.SpringbackAngle

Returns or sets the springback angle of the flange task

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

Getter Method

Signature SpringbackAngle

Returns:expression string
Return type:str

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature SpringbackAngle

Parameters:springbackAngle (str) – expression string

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SpringbackType

FlangeTaskBuilder.SpringbackType

Returns or sets the springback type of the flange task

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

Getter Method

Signature SpringbackType

Returns:
Return type:NXOpen.Die.FlangeTaskBuilderSpringbackTypes

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature SpringbackType

Parameters:springbackType (NXOpen.Die.FlangeTaskBuilderSpringbackTypes) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

TippedProduct

FlangeTaskBuilder.TippedProduct

Returns or sets the tipped product of the flange task

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

Getter Method

Signature TippedProduct

Returns:The tip of the operation where the flange

task resides. :rtype: NXOpen.Features.Feature

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature TippedProduct

Parameters:tippedProduct (NXOpen.Features.Feature) – The tip of the operation where the flange task resides.

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

Method Detail

GetAssociativeObjects

FlangeTaskBuilder.GetAssociativeObjects

Gets the associative objects of the flange task

Signature GetAssociativeObjects()

Returns:
Return type:list of NXOpen.DisplayableObject

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetCameraLayerAndXmlp

FlangeTaskBuilder.GetCameraLayerAndXmlp

Gets the camera layer settings and xmlp data

Signature GetCameraLayerAndXmlp()

Returns:a tuple
Return type:A tuple consisting of (layerSettings, xmlpData) layerSettings is a list of str. 1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on. xmlpData is a list of str. xmlp data

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetCameraNames

FlangeTaskBuilder.GetCameraNames

Gets the names of the camera

Signature GetCameraNames()

Returns:each string contains the name of a camera object
Return type:list of str

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetCameraViews

FlangeTaskBuilder.GetCameraViews

Gets the camera views of the flange task

Signature GetCameraViews()

Returns:
Return type:list of NXOpen.View

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetDetails

FlangeTaskBuilder.GetDetails

Gets the detailed description of the flange task

Signature GetDetails()

Returns:detail strings
Return type:list of str

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetRegionBounds

FlangeTaskBuilder.GetRegionBounds

Gets the region bounds of the flange task

Signature GetRegionBounds()

Returns:a tuple
Return type:A tuple consisting of (profileEntries, direction). profileEntries is a list of NXOpen.IProfile. Profile entries that make up the boundary of the flange task direction is a NXOpen.Die.DirectionOption. Profile direction

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetShapeDetail

FlangeTaskBuilder.GetShapeDetail

Gets the shape detail of the form task for bodies

Signature GetShapeDetail()

Returns:bodies
Return type:list of NXOpen.Body

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetAssociativeObjects

FlangeTaskBuilder.SetAssociativeObjects

Sets the associative objects of the flange task

Signature SetAssociativeObjects(objects)

Parameters:objects (list of NXOpen.DisplayableObject) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetCameraLayerAndXmlp

FlangeTaskBuilder.SetCameraLayerAndXmlp

Sets the camera layer settings and xmlp data

Signature SetCameraLayerAndXmlp(layerSettings, xmlpData)

Parameters:
  • layerSettings (list of str) – 1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on.
  • xmlpData (list of str) – xmlp data

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetCameraNames

FlangeTaskBuilder.SetCameraNames

Sets the names of the camera

Signature SetCameraNames(strings)

Parameters:strings (list of str) – each string contains the name of a camera object

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetCameraViews

FlangeTaskBuilder.SetCameraViews

Sets the camera views of the flange task

Signature SetCameraViews(objects)

Parameters:objects (list of NXOpen.View) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetDetails

FlangeTaskBuilder.SetDetails

Sets the detailed description of the flange task

Signature SetDetails(strings)

Parameters:strings (list of str) – detail strings

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetRegionBounds

FlangeTaskBuilder.SetRegionBounds

Sets the region bounds of the flange task

Signature SetRegionBounds(direction, profileEntries)

Parameters:

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetShapeDetail

FlangeTaskBuilder.SetShapeDetail

Overloaded method SetShapeDetail

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

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

Sets the shape detail of the flange task for profiles

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 for bodies

Signature SetShapeDetail(bodies)

Parameters:bodies (list of NXOpen.Body) – bodies

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Validate

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