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

Represents a NXOpen::Die::KeywayBuilder builder
To create a new instance of this class, use NXOpen::Die::DieCollection::Keyway
Default values. More...

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

Public Types

enum  LocationType { LocationTypePositiveX, LocationTypeNegativeX, LocationTypePositiveY, LocationTypeNegativeY }
 Keyway location direction relative to the die centerline coordinate system. More...
 
enum  Types { TypesRectangular, TypesCircular }
 Keyway runoff types. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance
Created in NX6.0.0. More...
 
NXOpen::SectionBaseFlange ()
 Returns the closed loop section representing the base flange
Created in NX6.0.0. More...
 
NXOpen::Die::DiePlaneBuilderBaseOrientation ()
 Returns the bottom orientation plane of the keyway pad
Created in NX6.0.0. More...
 
bool CreateWithPad ()
 Returns the value, true or false) to decide if the pad should be created for the keyway
Created in NX6.0.0. More...
 
NXOpen::ExpressionDeckThickness ()
 Returns the expression for the deck thickness
Created in NX6.0.0. More...
 
NXOpen::SelectCartesianCoordinateSystemDieCenterlineCoordinateSystem ()
 Returns the die centerline coordinate system for orienting the keyway
Created in NX6.0.0. More...
 
double DistanceTolerance ()
 Returns the distance tolerance
Created in NX6.0.0. More...
 
NXOpen::SectionInteriorProfile ()
 Returns the closed loop section representing the interior profile of the casting
Created in NX6.0.0. More...
 
NXOpen::Die::KeywayBuilder::LocationType Location ()
 Returns the location for the keyway
Created in NX6.0.0. More...
 
NXOpen::ExpressionMinimumRibHeight ()
 Returns the expression for the minimum rib height
Created in NX6.0.0. More...
 
NXOpen::ExpressionOffset ()
 Returns the amount to offset the keyway perpendicular to the slot orientation
Created in NX6.0.0. More...
 
NXOpen::Die::DieAttributesBuilderPadAttributes ()
 Returns the pad attributes
Created in NX6.0.0. More...
 
NXOpen::ExpressionPadHeight ()
 Returns the expression for the pad height
Created in NX6.0.0. More...
 
NXOpen::ExpressionPadWidth ()
 Returns the expression for the pad width
Created in NX6.0.0. More...
 
NXOpen::ExpressionPlacementOffset ()
 Returns the amount to offset the base orientation
Created in NX6.0.0. More...
 
NXOpen::ExpressionRunoffDepth ()
 Returns the expression for the runoff depth
Created in NX6.0.0. More...
 
NXOpen::ExpressionRunoffLength ()
 Returns the expression for the runoff length
Created in NX6.0.0. More...
 
NXOpen::ExpressionRunoffRadius ()
 Returns the expression for the runoff radius
Created in NX6.0.0. More...
 
NXOpen::ExpressionRunoffWidth ()
 Returns the expression for the runoff width
Created in NX6.0.0. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance
Created in NX6.0.0. More...
 
void SetCreateWithPad (bool createWithPad)
 Sets the value, true or false) to decide if the pad should be created for the keyway
Created in NX6.0.0. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance
Created in NX6.0.0. More...
 
void SetLocation (NXOpen::Die::KeywayBuilder::LocationType location)
 Sets the location for the keyway
Created in NX6.0.0. More...
 
void SetType (NXOpen::Die::KeywayBuilder::Types type)
 Sets the type of the keyway runoff
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectSheetMetal ()
 Returns the sheet metal being formed by the casting. More...
 
NXOpen::Die::DieAttributesBuilderSlotAttributes ()
 Returns the slot attributes
Created in NX6.0.0. More...
 
NXOpen::ExpressionSlotDepth ()
 Returns the expression for the slot depth
Created in NX6.0.0. More...
 
NXOpen::ExpressionSlotLength ()
 Returns the expression for the slot length
Created in NX6.0.0. More...
 
NXOpen::ExpressionSlotWidth ()
 Returns the expression for the slot width
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectTarget ()
 Returns the target solid the keyway will be united with
Created in NX6.0.0. More...
 
NXOpen::Die::KeywayBuilder::Types Type ()
 Returns the type of the keyway runoff
Created in NX6.0.0. 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 NXOpen::Die::KeywayBuilder builder
To create a new instance of this class, use NXOpen::Die::DieCollection::Keyway
Default values.

Property Value

AngleTolerance

0.5

CreateWithPad

1

DeckThickness.Value

0 (millimeters part), 0 (inches part)

DistanceTolerance

0.0254 (millimeters part), 0.001 (inches part)

Location

PositiveX

MinimumRibHeight.Value

200 (millimeters part), 8 (inches part)

Offset.Value

0 (millimeters part), 0 (inches part)

PadHeight.Value

65 (millimeters part), 2.6 (inches part)

PadWidth.Value

60 (millimeters part), 2.4 (inches part)

PlacementOffset.Value

0 (millimeters part), 0 (inches part)

RunoffDepth.Value

40 (millimeters part), 1.6 (inches part)

RunoffLength.Value

60 (millimeters part), 2.4 (inches part)

RunoffRadius.Value

30 (millimeters part), 1.2 (inches part)

RunoffWidth.Value

16 (millimeters part), 0.625 (inches part)

SlotDepth.Value

20 (millimeters part), 0.8 (inches part)

SlotLength.Value

100 (millimeters part), 4 (inches part)

SlotWidth.Value

25 (millimeters part), 1 (inches part)


Created in NX6.0.0.

Member Enumeration Documentation

Keyway location direction relative to the die centerline coordinate system.

Enumerator
LocationTypePositiveX 

+X relative to the center of the coordinate system

LocationTypeNegativeX 

-X relative to the center of the coordinate system

LocationTypePositiveY 

+Y relative to the center of the coordinate system

LocationTypeNegativeY 

-Y relative to the center of the coordinate system

Keyway runoff types.

Enumerator
TypesRectangular 

tool runoff is perpendicular to slot

TypesCircular 

tool runoff is created using a plunge cut at the end of the slot

Member Function Documentation

double NXOpen::Die::KeywayBuilder::AngleTolerance ( )

Returns the angle tolerance
Created in NX6.0.0.



License requirements : None

NXOpen::Section* NXOpen::Die::KeywayBuilder::BaseFlange ( )

Returns the closed loop section representing the base flange
Created in NX6.0.0.



License requirements : None

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

Returns the bottom orientation plane of the keyway pad
Created in NX6.0.0.



License requirements : None

bool NXOpen::Die::KeywayBuilder::CreateWithPad ( )

Returns the value, true or false) to decide if the pad should be created for the keyway
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::DeckThickness ( )

Returns the expression for the deck thickness
Created in NX6.0.0.



License requirements : None

NXOpen::SelectCartesianCoordinateSystem* NXOpen::Die::KeywayBuilder::DieCenterlineCoordinateSystem ( )

Returns the die centerline coordinate system for orienting the keyway
Created in NX6.0.0.



License requirements : None

double NXOpen::Die::KeywayBuilder::DistanceTolerance ( )

Returns the distance tolerance
Created in NX6.0.0.



License requirements : None

NXOpen::Section* NXOpen::Die::KeywayBuilder::InteriorProfile ( )

Returns the closed loop section representing the interior profile of the casting
Created in NX6.0.0.



License requirements : None

NXOpen::Die::KeywayBuilder::LocationType NXOpen::Die::KeywayBuilder::Location ( )

Returns the location for the keyway
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::MinimumRibHeight ( )

Returns the expression for the minimum rib height
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::Offset ( )

Returns the amount to offset the keyway perpendicular to the slot orientation
Created in NX6.0.0.



License requirements : None

NXOpen::Die::DieAttributesBuilder* NXOpen::Die::KeywayBuilder::PadAttributes ( )

Returns the pad attributes
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::PadHeight ( )

Returns the expression for the pad height
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::PadWidth ( )

Returns the expression for the pad width
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::PlacementOffset ( )

Returns the amount to offset the base orientation
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::RunoffDepth ( )

Returns the expression for the runoff depth
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::RunoffLength ( )

Returns the expression for the runoff length
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::RunoffRadius ( )

Returns the expression for the runoff radius
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::RunoffWidth ( )

Returns the expression for the runoff width
Created in NX6.0.0.



License requirements : None

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

Sets the angle tolerance
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
angleToleranceangletolerance
void NXOpen::Die::KeywayBuilder::SetCreateWithPad ( bool  createWithPad)

Sets the value, true or false) to decide if the pad should be created for the keyway
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
createWithPadcreatewithpad
void NXOpen::Die::KeywayBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Die::KeywayBuilder::SetLocation ( NXOpen::Die::KeywayBuilder::LocationType  location)

Sets the location for the keyway
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
locationlocation
void NXOpen::Die::KeywayBuilder::SetType ( NXOpen::Die::KeywayBuilder::Types  type)

Sets the type of the keyway runoff
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
typetype
NXOpen::SelectNXObject* NXOpen::Die::KeywayBuilder::SheetMetal ( )

Returns the sheet metal being formed by the casting.

Used to measure the height.
Created in NX6.0.0.

License requirements : None

NXOpen::Die::DieAttributesBuilder* NXOpen::Die::KeywayBuilder::SlotAttributes ( )

Returns the slot attributes
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::SlotDepth ( )

Returns the expression for the slot depth
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::SlotLength ( )

Returns the expression for the slot length
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Die::KeywayBuilder::SlotWidth ( )

Returns the expression for the slot width
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Die::KeywayBuilder::Target ( )

Returns the target solid the keyway will be united with
Created in NX6.0.0.



License requirements : None

NXOpen::Die::KeywayBuilder::Types NXOpen::Die::KeywayBuilder::Type ( )

Returns the type of the keyway runoff
Created in NX6.0.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.