NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Die::MachineReliefBuilder Class Reference

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

Inheritance diagram for NXOpen::Die::MachineReliefBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MainProfileTypes { MainProfileTypesExterior, MainProfileTypesInterior }
 Specifies that the profile is for an exterior or interior profile. More...
 
enum  TrimSheetTypes { TrimSheetTypesSheet, TrimSheetTypesFace }
 Specifies what the trimming surface is defined by. More...
 
enum  Types { TypesCam, TypesRelief, TypesThicken }
 Identifies the type of structure to be added, or subtracted, to the casting. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance. More...
 
NXOpen::ExpressionBaseOffset ()
 Returns the expression containing the offset value to apply to the base definition before trimming the base of the tool solids. More...
 
NXOpen::Die::DiePlaneBuilderBaseOrientation ()
 Returns the base orientation of the target solid. More...
 
NXOpen::Die::DieAttributesBuilderBeltAttributes ()
 Returns the attribute title, value and face color to apply to the belt faces. More...
 
NXOpen::ExpressionBeltFaceThickness ()
 Returns the expression containing the value to apply for the belt face on the cam definition. More...
 
NXOpen::Die::DieDirectionBuilderCamDirection ()
 Returns the direction of the cam for trimming. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
NXOpen::Die::DieLocationBuilderEnd ()
 Returns the location for the end of the segment definition. More...
 
NXOpen::SectionInsideWallProfile ()
 Returns the wall profile defining the inside of the main wall used for the cam definition. More...
 
bool JogWall ()
 Returns the indicator defining if the wall should be jogged (or changed) to accommodate the cam definition. More...
 
NXOpen::SectionMainProfile ()
 Returns the primary profile for the machine relief casting. More...
 
NXOpen::Die::MachineReliefBuilder::MainProfileTypes MainProfileType ()
 Returns the value specifying the main profile for the Thicken operation. More...
 
NXOpen::ExpressionOffset ()
 Returns the expression containing the value to apply for the thicken operation to create the tool solid. More...
 
NXOpen::ExpressionProfileOffset ()
 Returns the expression containing the value to apply to the profile to create the primary head solid for the cam definition. More...
 
NXOpen::ExpressionRelief ()
 Returns the expression containing the value to apply for the machine relief operation to create the tool solid. More...
 
NXOpen::ExpressionReliefOffset ()
 Returns the expression containing the value of the relief around the primary head solid for the cam definition if a wall is created. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetJogWall (bool jogWall)
 Sets the indicator defining if the wall should be jogged (or changed) to accommodate the cam definition. More...
 
void SetMainProfileType (NXOpen::Die::MachineReliefBuilder::MainProfileTypes mainProfileType)
 Sets the value specifying the main profile for the Thicken operation. More...
 
void SetSwitchTrimSide (bool switchTrimSide)
 Sets the indicator if the trim side should be switched from the default for the sheet metal. More...
 
void SetTrimSheetType (NXOpen::Die::MachineReliefBuilder::TrimSheetTypes trimSheetType)
 Sets the indicator for how the trim sheet is specified. More...
 
void SetType (NXOpen::Die::MachineReliefBuilder::Types type)
 Sets the value defining the type of build to perform for this tool. More...
 
NXOpen::Die::DieLocationBuilderStart ()
 Returns the location for the start of the segment definition. More...
 
bool SwitchTrimSide ()
 Returns the indicator if the trim side should be switched from the default for the sheet metal. More...
 
NXOpen::SelectBodyTarget ()
 Returns the target solid to add or subtract material too. More...
 
NXOpen::ExpressionTopOffset ()
 Returns the expression containing the offset value from the base to define the top extent of the internal builds. More...
 
NXOpen::ExpressionTrimOffset ()
 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. More...
 
NXOpen::SelectBodyTrimSheet ()
 Returns the sheet body selection for the trim sheet. More...
 
NXOpen::ScCollectorTrimSheetFace ()
 Returns the face selections to define the trim sheet. More...
 
NXOpen::ExpressionTrimSheetOffset ()
 Returns the expression containing the offset value to apply to the trim sheet to construct the tool solids. More...
 
NXOpen::Die::MachineReliefBuilder::TrimSheetTypes TrimSheetType ()
 Returns the indicator for how the trim sheet is specified. More...
 
NXOpen::Die::MachineReliefBuilder::Types Type ()
 Returns the value defining the type of build to perform for this tool. More...
 
NXOpen::ExpressionWallOffset ()
 Returns the expression containing the offset to apply to the wall to create the wall area for the cam definition. More...
 
NXOpen::ExpressionWallThickness ()
 Returns the expression containing the thickness value of the wall for the cam definition. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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)


Created in NX7.5.0.

Member Enumeration Documentation

Specifies that the profile is for an exterior or interior profile.

This is necessary when the target supplies the profile

Enumerator
MainProfileTypesExterior 

Profile is for the exterior surface of the main wall.

MainProfileTypesInterior 

Profile is for the interior surface of the main wall.

Specifies what the trimming surface is defined by.

Enumerator
TrimSheetTypesSheet 

Trimming surface is a sheet body.

TrimSheetTypesFace 

Trimming surface is a face, or faces to be sewed together.

Identifies the type of structure to be added, or subtracted, to the casting.

Enumerator
TypesCam 

Add casting material for the trim, or flange, steel mating surface.

TypesRelief 

Remove casting material to allow for clearance between two mating objects (such as the upper and lower castings).

TypesThicken 

Add casting material to thicken an existing wall.

Member Function Documentation

double NXOpen::Die::MachineReliefBuilder::AngleTolerance ( )

Returns the angle tolerance.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::MachineReliefBuilder::BaseOffset ( )

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


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DiePlaneBuilder* NXOpen::Die::MachineReliefBuilder::BaseOrientation ( )

Returns the base orientation of the target solid.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieAttributesBuilder* NXOpen::Die::MachineReliefBuilder::BeltAttributes ( )

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


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::MachineReliefBuilder::BeltFaceThickness ( )

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

Only valid when type is Die::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieDirectionBuilder* NXOpen::Die::MachineReliefBuilder::CamDirection ( )

Returns the direction of the cam for trimming.

Only valid when type is Die::MachineReliefBuilder::TypesCam or Die::MachineReliefBuilder::TypesRelief .
Created in NX7.5.0.

License requirements : None

double NXOpen::Die::MachineReliefBuilder::DistanceTolerance ( )

Returns the distance tolerance.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieLocationBuilder* NXOpen::Die::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.
Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::Die::MachineReliefBuilder::InsideWallProfile ( )

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

Only valid when type is Die::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None

bool NXOpen::Die::MachineReliefBuilder::JogWall ( )

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

TRUE indicates that the wal should be jogged.
Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::Die::MachineReliefBuilder::MainProfile ( )

Returns the primary profile for the machine relief casting.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::MachineReliefBuilder::MainProfileTypes NXOpen::Die::MachineReliefBuilder::MainProfileType ( )

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

Only valid when type is Die::MachineReliefBuilder::TypesThicken .
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesRelief or Die::MachineReliefBuilder::TypesThicken .
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesRelief or Die::MachineReliefBuilder::TypesThicken .
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None

void NXOpen::Die::MachineReliefBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
angleToleranceangletolerance
void NXOpen::Die::MachineReliefBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Die::MachineReliefBuilder::SetJogWall ( bool  jogWall)

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.
Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
jogWalljogwall
void NXOpen::Die::MachineReliefBuilder::SetMainProfileType ( NXOpen::Die::MachineReliefBuilder::MainProfileTypes  mainProfileType)

Sets the value specifying the main profile for the Thicken operation.

Only valid when type is Die::MachineReliefBuilder::TypesThicken .
Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
mainProfileTypemainprofiletype
void NXOpen::Die::MachineReliefBuilder::SetSwitchTrimSide ( bool  switchTrimSide)

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.
Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
switchTrimSideswitchtrimside
void NXOpen::Die::MachineReliefBuilder::SetTrimSheetType ( NXOpen::Die::MachineReliefBuilder::TrimSheetTypes  trimSheetType)

Sets the indicator for how the trim sheet is specified.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
trimSheetTypetrimsheettype
void NXOpen::Die::MachineReliefBuilder::SetType ( NXOpen::Die::MachineReliefBuilder::Types  type)

Sets the value defining the type of build to perform for this tool.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
typetype
NXOpen::Die::DieLocationBuilder* NXOpen::Die::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.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Die::MachineReliefBuilder::SwitchTrimSide ( )

Returns 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.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Die::MachineReliefBuilder::Target ( )

Returns the target solid to add or subtract material too.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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.
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Die::MachineReliefBuilder::TrimSheet ( )

Returns the sheet body selection for the trim sheet.


Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Die::MachineReliefBuilder::TrimSheetFace ( )

Returns the face selections to define the trim sheet.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesRelief or Die::MachineReliefBuilder::TypesThicken .
Created in NX7.5.0.

License requirements : None

NXOpen::Die::MachineReliefBuilder::TrimSheetTypes NXOpen::Die::MachineReliefBuilder::TrimSheetType ( )

Returns the indicator for how the trim sheet is specified.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::MachineReliefBuilder::Types NXOpen::Die::MachineReliefBuilder::Type ( )

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


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::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::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::MachineReliefBuilder::WallThickness ( )

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

Only valid when type is Die::MachineReliefBuilder::TypesCam .
Created in NX7.5.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.