CompensateRoughDataBuilder Class

class NXOpen.Die.CompensateRoughDataBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Die.CompensateRoughDataBuilder.

This class is used to edit and create a Compensate Rough Curve or Compensate Rough Sheet feature.

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

Default values.

Property Value
AngleTolerance 0.5
Approximation Coarse
DistanceTolerance 0.0254 (millimeters part), 0.001 (inches part)
JoinOutputCurves 0
MaximumGap 5.0 (millimeters part), 0.2 (inches part)
ModifyInputSheet 0

New in version NX6.0.0.

Properties

Property Description
AngleTolerance Returns or sets the angle tolerance.
Approximation Returns or sets the approximation desired.
CurveCollector Returns the curve collector containing the curves that will be approximated.
DistanceTolerance Returns or sets the distance tolerance.
JoinOutputCurves Returns or sets the join output curves setting, true indicates that the output curves will be joined into a single curve.
MaximumGap Returns or sets the maximum gap.
ModifyInputSheet Returns or sets the modify input sheet setting.
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
ProjectToFaces Returns the faces to project the output curves onto.
SheetBodies Returns the sheet bodies that will be approximated.
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
Type Returns or sets the type of input data being supplied.

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.
GetFeature Returns the feature currently being edited by this builder.
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.
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

CompensateRoughDataBuilderApproximationType Enumeration Settings for the amount of approximation to perform.
CompensateRoughDataBuilderTypes Enumeration Settings for the type of data being compensated.

Property Detail

AngleTolerance

CompensateRoughDataBuilder.AngleTolerance

Returns or sets the angle tolerance.

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

Getter Method

Signature AngleTolerance

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature AngleTolerance

Parameters:angleTolerance (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Approximation

CompensateRoughDataBuilder.Approximation

Returns or sets the approximation desired.

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

Getter Method

Signature Approximation

Returns:
Return type:NXOpen.Die.CompensateRoughDataBuilderApproximationType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Approximation

Parameters:approximation (NXOpen.Die.CompensateRoughDataBuilderApproximationType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

CurveCollector

CompensateRoughDataBuilder.CurveCollector

Returns the curve collector containing the curves that will be approximated.

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

Getter Method

Signature CurveCollector

Returns:
Return type:NXOpen.Section

New in version NX6.0.0.

License requirements: None.

DistanceTolerance

CompensateRoughDataBuilder.DistanceTolerance

Returns or sets the distance tolerance.

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

Getter Method

Signature DistanceTolerance

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DistanceTolerance

Parameters:distanceTolerance (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

JoinOutputCurves

CompensateRoughDataBuilder.JoinOutputCurves

Returns or sets the join output curves setting, true indicates that the output curves will be joined into a single curve.

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

Getter Method

Signature JoinOutputCurves

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature JoinOutputCurves

Parameters:joinOutputCurves (bool) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

MaximumGap

CompensateRoughDataBuilder.MaximumGap

Returns or sets the maximum gap.

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

Getter Method

Signature MaximumGap

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MaximumGap

Parameters:maximumGap (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ModifyInputSheet

CompensateRoughDataBuilder.ModifyInputSheet

Returns or sets the modify input sheet setting.

If true the input sheet will be modified, otherwise a new sheet will be created.

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

Getter Method

Signature ModifyInputSheet

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ModifyInputSheet

Parameters:modifyInputSheet (bool) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ProjectToFaces

CompensateRoughDataBuilder.ProjectToFaces

Returns the faces to project the output curves onto.

If faces are selected then the output curves will be projected normal to these faces.

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

Getter Method

Signature ProjectToFaces

Returns:
Return type:NXOpen.ScCollector

New in version NX6.0.0.

License requirements: None.

SheetBodies

CompensateRoughDataBuilder.SheetBodies

Returns the sheet bodies that will be approximated.

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

Getter Method

Signature SheetBodies

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

Type

CompensateRoughDataBuilder.Type

Returns or sets the type of input data being supplied.

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

Getter Method

Signature Type

Returns:
Return type:NXOpen.Die.CompensateRoughDataBuilderTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Die.CompensateRoughDataBuilderTypes) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Method Detail

Validate

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