MachineReliefBuilder Class

class NXOpen.Die.MachineReliefBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a builder that is used to create or edit a NXOpen.Die.MachineRelief feature.

The builder may generate a Cam Definition, Machine Relief, or Wall Thickness.

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

Default values.

Property	Value
BaseOffset.Value	0 (millimeters part), 0 (inches part)
BeltFaceThickness.Value	20 (millimeters part), 0.8 (inches part)
End.InputType	SelectLocation
JogWall	0
MainProfileType	Exterior
Offset.Value	20 (millimeters part), 0.8 (inches part)
ProfileOffset.Value	30 (millimeters part), 1.2 (inches part)
Relief.Value	20 (millimeters part), 0.8 (inches part)
ReliefOffset.Value	5 (millimeters part), 0.2 (inches part)
TopOffset.Value	1000 (millimeters part), 40 (inches part)
TrimOffset.Value	5 (millimeters part), 0.2 (inches part)
TrimSheetOffset.Value	0 (millimeters part), 0 (inches part)
TrimSheetType	Sheet
WallOffset.Value	10 (millimeters part), 0.4 (inches part)
WallThickness.Value	45 (millimeters part), 1.8 (inches part)

New in version NX7.5.0.

Properties

Property	Description
AngleTolerance	Returns or sets the angle tolerance.
BaseOffset	Returns the expression containing the offset value to apply to the base definition before trimming the base of the tool solids.
BaseOrientation	Returns the base orientation of the target solid.
BeltAttributes	Returns the attribute title, value and face color to apply to the belt faces.
BeltFaceThickness	Returns the expression containing the value to apply for the belt face on the cam definition.
CamDirection	Returns the direction of the cam for trimming.
DistanceTolerance	Returns or sets the distance tolerance.
End	Returns the location for the end of the segment definition.
InsideWallProfile	Returns the wall profile defining the inside of the main wall used for the cam definition.
JogWall	Returns or sets the indicator defining if the wall should be jogged (or changed) to accommodate the cam definition.
MainProfile	Returns the primary profile for the machine relief casting.
MainProfileType	Returns or sets the value specifying the main profile for the Thicken operation.
Offset	Returns the expression containing the value to apply for the thicken operation to create the tool solid.
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
ProfileOffset	Returns the expression containing the value to apply to the profile to create the primary head solid for the cam definition.
Relief	Returns the expression containing the value to apply for the machine relief operation to create the tool solid.
ReliefOffset	Returns the expression containing the value of the relief around the primary head solid for the cam definition if a wall is created.
Start	Returns the location for the start of the segment definition.
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
SwitchTrimSide	Returns or sets the indicator if the trim side should be switched from the default for the sheet metal.
Tag	Returns the Tag for this object.
Target	Returns the target solid to add or subtract material too.
TopOffset	Returns the expression containing the offset value from the base to define the top extent of the internal builds.
TrimOffset	Returns the expression containing the clearance value to apply at the start and the end of the cam definition to define the primary head solid.
TrimSheet	Returns the sheet body selection for the trim sheet.
TrimSheetFace	Returns the face selections to define the trim sheet.
TrimSheetOffset	Returns the expression containing the offset value to apply to the trim sheet to construct the tool solids.
TrimSheetType	Returns or sets the indicator for how the trim sheet is specified.
Type	Returns or sets the value defining the type of build to perform for this tool.
WallOffset	Returns the expression containing the offset to apply to the wall to create the wall area for the cam definition.
WallThickness	Returns the expression containing the thickness value of the wall for the cam definition.

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

MachineReliefBuilderMainProfileTypes Enumeration	Specifies that the profile is for an exterior or interior profile.
MachineReliefBuilderTrimSheetTypes Enumeration	Specifies what the trimming surface is defined by.
MachineReliefBuilderTypes Enumeration	Identifies the type of structure to be added, or subtracted, to the casting.

Property Detail

AngleTolerance

MachineReliefBuilder.AngleTolerance

Returns or sets the angle tolerance.

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

Getter Method

Signature AngleTolerance

Returns: Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature AngleTolerance

Parameters:angleTolerance (float) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

BaseOffset

MachineReliefBuilder.BaseOffset

Returns the expression containing the offset value to apply to the base definition before trimming the base of the tool solids.

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

Getter Method

Signature BaseOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

BaseOrientation

MachineReliefBuilder.BaseOrientation

Returns the base orientation of the target solid.

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

Getter Method

Signature BaseOrientation

Returns: Return type:NXOpen.Die.DiePlaneBuilder

New in version NX7.5.0.

License requirements: None.

BeltAttributes

MachineReliefBuilder.BeltAttributes

Returns the attribute title, value and face color to apply to the belt faces.

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

Getter Method

Signature BeltAttributes

Returns: Return type:NXOpen.Die.DieAttributesBuilder

New in version NX7.5.0.

License requirements: None.

BeltFaceThickness

MachineReliefBuilder.BeltFaceThickness

Returns the expression containing the value to apply for the belt face on the cam definition.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature BeltFaceThickness

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

CamDirection

MachineReliefBuilder.CamDirection

Returns the direction of the cam for trimming.

Only valid when type is Die.MachineReliefBuilderTypes.Cam or Die.MachineReliefBuilderTypes.Relief.

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

Getter Method

Signature CamDirection

Returns: Return type:NXOpen.Die.DieDirectionBuilder

New in version NX7.5.0.

License requirements: None.

DistanceTolerance

MachineReliefBuilder.DistanceTolerance

Returns or sets the distance tolerance.

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

Getter Method

Signature DistanceTolerance

Returns: Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature DistanceTolerance

Parameters:distanceTolerance (float) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

End

MachineReliefBuilder.End

Returns the location for the end of the segment definition.

The default is the end of the segment if an open profile is selected.

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

Getter Method

Signature End

Returns: Return type:NXOpen.Die.DieLocationBuilder

New in version NX7.5.0.

License requirements: None.

InsideWallProfile

MachineReliefBuilder.InsideWallProfile

Returns the wall profile defining the inside of the main wall used for the cam definition.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature InsideWallProfile

Returns: Return type:NXOpen.Section

New in version NX7.5.0.

License requirements: None.

JogWall

MachineReliefBuilder.JogWall

Returns or sets the indicator defining if the wall should be jogged (or changed) to accommodate the cam definition.

TRUE indicates that the wal should be jogged.

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

Getter Method

Signature JogWall

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature JogWall

Parameters:jogWall (bool) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

MainProfile

MachineReliefBuilder.MainProfile

Returns the primary profile for the machine relief casting.

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

Getter Method

Signature MainProfile

Returns: Return type:NXOpen.Section

New in version NX7.5.0.

License requirements: None.

MainProfileType

MachineReliefBuilder.MainProfileType

Returns or sets the value specifying the main profile for the Thicken operation.

Only valid when type is Die.MachineReliefBuilderTypes.Thicken.

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

Getter Method

Signature MainProfileType

Returns: Return type:NXOpen.Die.MachineReliefBuilderMainProfileTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MainProfileType

Parameters:mainProfileType (NXOpen.Die.MachineReliefBuilderMainProfileTypes) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

Offset

MachineReliefBuilder.Offset

Returns the expression containing the value to apply for the thicken operation to create the tool solid.

Only valid when type is Die.MachineReliefBuilderTypes.Relief or Die.MachineReliefBuilderTypes.Thicken.

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

Getter Method

Signature Offset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

ProfileOffset

MachineReliefBuilder.ProfileOffset

Returns the expression containing the value to apply to the profile to create the primary head solid for the cam definition.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature ProfileOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

Relief

MachineReliefBuilder.Relief

Returns the expression containing the value to apply for the machine relief operation to create the tool solid.

Only valid when type is Die.MachineReliefBuilderTypes.Relief or Die.MachineReliefBuilderTypes.Thicken.

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

Getter Method

Signature Relief

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

ReliefOffset

MachineReliefBuilder.ReliefOffset

Returns the expression containing the value of the relief around the primary head solid for the cam definition if a wall is created.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature ReliefOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

Start

MachineReliefBuilder.Start

Returns the location for the start of the segment definition.

The default is the start of the segment if an open profile is selected.

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

Getter Method

Signature Start

Returns: Return type:NXOpen.Die.DieLocationBuilder

New in version NX7.5.0.

License requirements: None.

SwitchTrimSide

MachineReliefBuilder.SwitchTrimSide

Returns or sets the indicator if the trim side should be switched from the default for the sheet metal.

TRUE indicates that the trim side should be reversed.

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

Getter Method

Signature SwitchTrimSide

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SwitchTrimSide

Parameters:switchTrimSide (bool) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

Target

MachineReliefBuilder.Target

Returns the target solid to add or subtract material too.

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

Getter Method

Signature Target

Returns: Return type:NXOpen.SelectBody

New in version NX7.5.0.

License requirements: None.

TopOffset

MachineReliefBuilder.TopOffset

Returns the expression containing the offset value from the base to define the top extent of the internal builds.

This value will be defined internally if a target is selected.

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

Getter Method

Signature TopOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

TrimOffset

MachineReliefBuilder.TrimOffset

Returns the expression containing the clearance value to apply at the start and the end of the cam definition to define the primary head solid.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature TrimOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

TrimSheet

MachineReliefBuilder.TrimSheet

Returns the sheet body selection for the trim sheet.

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

Getter Method

Signature TrimSheet

Returns: Return type:NXOpen.SelectBody

New in version NX7.5.0.

License requirements: None.

TrimSheetFace

MachineReliefBuilder.TrimSheetFace

Returns the face selections to define the trim sheet.

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

Getter Method

Signature TrimSheetFace

Returns: Return type:NXOpen.ScCollector

New in version NX7.5.0.

License requirements: None.

TrimSheetOffset

MachineReliefBuilder.TrimSheetOffset

Returns the expression containing the offset value to apply to the trim sheet to construct the tool solids.

Only valid when type is Die.MachineReliefBuilderTypes.Relief or Die.MachineReliefBuilderTypes.Thicken.

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

Getter Method

Signature TrimSheetOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

TrimSheetType

MachineReliefBuilder.TrimSheetType

Returns or sets the indicator for how the trim sheet is specified.

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

Getter Method

Signature TrimSheetType

Returns: Return type:NXOpen.Die.MachineReliefBuilderTrimSheetTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature TrimSheetType

Parameters:trimSheetType (NXOpen.Die.MachineReliefBuilderTrimSheetTypes) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

Type

MachineReliefBuilder.Type

Returns or sets the value defining the type of build to perform for this tool.

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

Getter Method

Signature Type

Returns: Return type:NXOpen.Die.MachineReliefBuilderTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Die.MachineReliefBuilderTypes) –

New in version NX7.5.0.

License requirements: ug_die_design (“Die Design”)

WallOffset

MachineReliefBuilder.WallOffset

Returns the expression containing the offset to apply to the wall to create the wall area for the cam definition.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature WallOffset

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

WallThickness

MachineReliefBuilder.WallThickness

Returns the expression containing the thickness value of the wall for the cam definition.

Only valid when type is Die.MachineReliefBuilderTypes.Cam.

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

Getter Method

Signature WallThickness

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: None.

Method Detail

Validate

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