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

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

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

Public Types

enum  Types { TypesSection, TypesFace, TypesSheetBody }
 Specifies what type of base geometry to build the finger clearance notch from. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance. More...
 
NXOpen::Die::DieAttributesBuilderAttributes ()
 Returns the attribute title, value and face color to apply to the notch faces. More...
 
NXOpen::Die::DiePlaneBuilderBaseOrientation ()
 Returns the plane defining the base of the target solid. More...
 
NXOpen::Die::DieDirectionBuilderClearanceDirection ()
 Returns the direction (pointing away from the solid) in which to clear material from the target solid. More...
 
NXOpen::ExpressionDepth ()
 Returns the expression containing the value for the clearance to provide into the target solid. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
NXOpen::ExpressionExtrudeWidth ()
 Returns the expression containing the value to use to extrude the section. More...
 
NXOpen::SelectNXObjectListGeometry ()
 Returns the geometry to use as the definition of the notch. More...
 
bool ReverseDirection ()
 Returns the value to apply, for the purpose of reversing, to the derived clearance direction if a face or sheet body is specified. More...
 
NXOpen::SectionSection ()
 Returns the open section constructed from curves, edges, or a sketch. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the value to apply, for the purpose of reversing, to the derived clearance direction if a face or sheet body is specified. More...
 
void SetType (NXOpen::Die::FingerClearanceNotchBuilder::Types type)
 Sets the indicator specifying the type of input data that defines how to build the notch. More...
 
NXOpen::SelectBodyTarget ()
 Returns the target solid the finger clearance notch will be subtracted from. More...
 
NXOpen::Die::FingerClearanceNotchBuilder::Types Type ()
 Returns the indicator specifying the type of input data that defines how to build the notch. More...
 
NXOpen::ExpressionWidth ()
 Returns the expression containing the value for the clearance to provide on either side of the notch. 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::FingerClearanceNotch feature.


To create a new instance of this class, use NXOpen::Die::DieCollection::CreateFingerClearanceNotchBuilder
Default values.

Property Value

Depth.Value

5 (millimeters part), 0.2 (inches part)

ExtrudeWidth.Value

0 (millimeters part), 0 (inches part)

Width.Value

5 (millimeters part), 0.2 (inches part)


Created in NX7.5.0.

Member Enumeration Documentation

Specifies what type of base geometry to build the finger clearance notch from.

Enumerator
TypesSection 

Build from an open section profile.

TypesFace 

Build from either a single face or a set of connected faces.

TypesSheetBody 

Build from either a sheet body or a solid body.

Member Function Documentation

double NXOpen::Die::FingerClearanceNotchBuilder::AngleTolerance ( )

Returns the angle tolerance.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieAttributesBuilder* NXOpen::Die::FingerClearanceNotchBuilder::Attributes ( )

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


Created in NX7.5.0.

License requirements : None

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

Returns the plane defining the base of the target solid.

Used to orient the extrude and clearance directions.
Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieDirectionBuilder* NXOpen::Die::FingerClearanceNotchBuilder::ClearanceDirection ( )

Returns the direction (pointing away from the solid) in which to clear material from the target solid.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::FingerClearanceNotchBuilder::Depth ( )

Returns the expression containing the value for the clearance to provide into the target solid.


Created in NX7.5.0.

License requirements : None

double NXOpen::Die::FingerClearanceNotchBuilder::DistanceTolerance ( )

Returns the distance tolerance.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::FingerClearanceNotchBuilder::ExtrudeWidth ( )

Returns the expression containing the value to use to extrude the section.

The extrusion direction is specified by the cross product of the base orientation and the clearance direction.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Die::FingerClearanceNotchBuilder::Geometry ( )

Returns the geometry to use as the definition of the notch.

A single face or multiple connected faces can be specified, or a single sheet or body may be specified. Only valid when type is Die::FingerClearanceNotchBuilder::TypesFace or Die::FingerClearanceNotchBuilder::TypesSheetBody .
Created in NX7.5.0.

License requirements : None

bool NXOpen::Die::FingerClearanceNotchBuilder::ReverseDirection ( )

Returns the value to apply, for the purpose of reversing, to the derived clearance direction if a face or sheet body is specified.

If TRUE, then the derived direction will be flipped.
Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::Die::FingerClearanceNotchBuilder::Section ( )

Returns the open section constructed from curves, edges, or a sketch.

Only valid when type is Die::FingerClearanceNotchBuilder::TypesSection .
Created in NX7.5.0.

License requirements : None

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

Sets the angle tolerance.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

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

Sets the distance tolerance.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Die::FingerClearanceNotchBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the value to apply, for the purpose of reversing, to the derived clearance direction if a face or sheet body is specified.

If TRUE, then the derived direction will be flipped.
Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
reverseDirectionreversedirection
void NXOpen::Die::FingerClearanceNotchBuilder::SetType ( NXOpen::Die::FingerClearanceNotchBuilder::Types  type)

Sets the indicator specifying the type of input data that defines how to build the notch.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
typetype
NXOpen::SelectBody* NXOpen::Die::FingerClearanceNotchBuilder::Target ( )

Returns the target solid the finger clearance notch will be subtracted from.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::FingerClearanceNotchBuilder::Types NXOpen::Die::FingerClearanceNotchBuilder::Type ( )

Returns the indicator specifying the type of input data that defines how to build the notch.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::FingerClearanceNotchBuilder::Width ( )

Returns the expression containing the value for the clearance to provide on either side of the notch.


Created in NX7.5.0.

License requirements : None


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