NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Die.PierceHoleChildBuilder Class Reference

Represents a Pierce Hole Child sub feature. More...

Inheritance diagram for NXOpen.Die.PierceHoleChildBuilder:
NXOpen.Features.FeatureBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ShapeTypeOption { Circular, Rectangular, Curve }
 Settings for the shape type of the pierce hole. More...
 

Public Member Functions

unsafe void GetBreakerHoleAttributes (out string title, out string value, out int color, out string diameterTitle)
 Gets the breaker hole attributes, note existance of attributes depends on usage in main feature More...
 
unsafe NXOpen.IProfile[] GetBreakerHoleShape (out NXOpen.Die.DirectionOption direction)
 Gets the breaker hole shape of the pierce hole More...
 
unsafe void GetHoleAttributes (out string title, out string value, out int color, out string diameterTitle)
 Gets the hole attributes, note existance of attributes depends on usage in main feature More...
 
unsafe NXOpen.ILocation[] GetPierceHoleLocation ()
 Gets the locations of the pierce hole More...
 
unsafe NXOpen.IProfile[] GetPierceHoleShape (out NXOpen.Die.DirectionOption direction)
 Gets the shape of the pierce hole More...
 
unsafe void GetSlugHoleAttributes (out string title, out string value, out int color, out string diameterTitle)
 Gets the slug hole attributes, note existance of attributes depends on usage in main feature More...
 
unsafe NXOpen.IProfile[] GetSlugHoleShape (out NXOpen.Die.DirectionOption direction)
 Gets the slug hole shape of the pierce hole More...
 
unsafe void SetBreakerHoleAttributes (string title, string value, int color, string diameterTitle)
 Sets the breaker hole attributes, note existance of attributes depends on usage in main feature More...
 
unsafe void SetBreakerHoleDepth (string breakerHoleDepth)
  More...
 
unsafe void SetBreakerHoleFactor (string breakerHoleFactor)
  More...
 
unsafe void SetBreakerHoleOffset (string breakerHoleOffset)
  More...
 
unsafe void SetBreakerHoleShape (NXOpen.Die.DirectionOption direction, NXOpen.IProfile[] profileEntries)
 Sets the breaker hole shape of the pierce hole More...
 
unsafe void SetDepth (string depth)
  More...
 
unsafe void SetDiameter (string diameter)
  More...
 
unsafe void SetDieClearance (string dieClearance)
  More...
 
unsafe void SetHoleAttributes (string title, string value, int color, string diameterTitle)
 Sets the hole attributes, note existance of attributes depends on usage in main feature More...
 
unsafe void SetLength (string length)
  More...
 
unsafe void SetPierceHoleLocation (NXOpen.ILocation[] pierceHoleLocations)
 Sets the locations of the pierce hole More...
 
unsafe void SetPierceHoleShape (NXOpen.Die.DirectionOption direction, NXOpen.IProfile[] profileEntries)
 Sets the shape of the pierce hole More...
 
unsafe void SetProfileBlendRadius (string profileBlendRadius)
  More...
 
unsafe void SetSlugHoleAttributes (string title, string value, int color, string diameterTitle)
 Sets the slug hole attributes, note existance of attributes depends on usage in main feature More...
 
unsafe void SetSlugHoleDiameterIncrement (string slugHoleDiameterIncrement)
  More...
 
unsafe void SetSlugHoleOffset (string slugHoleOffset)
  More...
 
unsafe void SetSlugHoleShape (NXOpen.Die.DirectionOption direction, NXOpen.IProfile[] profileEntries)
 Sets the slug hole shape of the pierce hole More...
 
unsafe void SetWidth (string width)
  More...
 
unsafe void TranslatePierceHoleLocation (NXOpen.Vector3d translateDist)
 Translates the center of the die pierce hole by the specified amount. More...
 
- Public Member Functions inherited from NXOpen.Features.FeatureBuilder
unsafe NXOpen.Features.Feature CommitFeature ()
 Commits the feature parameters and creates the feature More...
 
unsafe NXOpen.Features.Feature GetFeature ()
 Returns the feature currently being edited by this builder. More...
 
unsafe void HideInternalParentFeatureAfterEdit (NXOpen.Features.Feature parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
unsafe void SetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited More...
 
unsafe void ShowInternalParentFeatureForEdit (NXOpen.Features.Feature parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
unsafe void UnsetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the internal parent feature of the feature being edited to external More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Expression BreakerHoleDepth [get]
 Returns the breaker hole depth of the pierce hole More...
 
unsafe NXOpen.ILocation BreakerHoleDirection [get, set]
 Returns or sets the breaker hole direction of the pierce hole More...
 
unsafe NXOpen.Expression BreakerHoleFactor [get]
 Returns the breaker hole factor of the pierce hole More...
 
unsafe NXOpen.ILocation BreakerHoleLocation [get, set]
 Returns or sets the location of breaker holes for the pierce hole More...
 
unsafe NXOpen.Expression BreakerHoleOffset [get]
 Returns the breaker hole offset of the pierce hole More...
 
unsafe
NXOpen.Die.DieBuildStatusOption 
BuildStatus [get]
 Returns the build status of the pierce hole More...
 
unsafe bool CircularSlugHole [get, set]
 Returns or sets the circular slug hole switch of the pierce hole More...
 
unsafe NXOpen.Expression Depth [get]
 Returns the depth of the pierce hole More...
 
unsafe bool DesignStatus [get, set]
 Returns or sets the design status of the pierce hole More...
 
unsafe NXOpen.Expression Diameter [get]
 Returns the diameter of the pierce hole More...
 
unsafe NXOpen.Expression DieClearance [get]
 Returns the die clearance of the pierce hole More...
 
unsafe bool DisplayHoles [get, set]
 Returns or sets the display holes option of the pierce hole More...
 
unsafe bool DisplayStatus [get, set]
 Returns or sets the display status of the pierce hole More...
 
unsafe NXOpen.Expression Length [get]
 Returns the length of the pierce hole More...
 
unsafe NXOpen.ILocation PierceHoleDirection [get, set]
 Returns or sets the pierce hole direction More...
 
unsafe NXOpen.Expression ProfileBlendRadius [get]
 Returns the profile blend radius of the pierce hole More...
 
unsafe
NXOpen.Die.PierceHoleChildBuilder.ShapeTypeOption 
ShapeType [get, set]
 Returns or sets the pierce hole shape type More...
 
unsafe NXOpen.Expression SlugHoleDiameterIncrement [get]
 Returns the slug hole diameter increment of the pierce hole More...
 
unsafe NXOpen.Expression SlugHoleOffset [get]
 Returns the slug hole offset of the pierce hole More...
 
unsafe NXOpen.Expression Width [get]
 Returns the width of the pierce hole More...
 
- Properties inherited from NXOpen.Features.FeatureBuilder
unsafe bool ParentFeatureInternal [get, set]
 Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a Pierce Hole Child sub feature.

This sub feature is created via the main feature builder.

Created in NX4.0.0

Member Enumeration Documentation

Settings for the shape type of the pierce hole.

Enumerator
Circular 

circular hole

Rectangular 

rectangular hole

Curve 

curve defined hole

Member Function Documentation

unsafe void NXOpen.Die.PierceHoleChildBuilder.GetBreakerHoleAttributes ( out string  title,
out string  value,
out int  color,
out string  diameterTitle 
)
inline

Gets the breaker hole attributes, note existance of attributes depends on usage in main feature

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
titletitle for attribute
valuevalue of attribute
colorcolor of hole faces
diameterTitletitle for diameter attribute
unsafe NXOpen.IProfile [] NXOpen.Die.PierceHoleChildBuilder.GetBreakerHoleShape ( out NXOpen.Die.DirectionOption  direction)
inline

Gets the breaker hole shape of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
directionprofile direction
Returns
profile entries
unsafe void NXOpen.Die.PierceHoleChildBuilder.GetHoleAttributes ( out string  title,
out string  value,
out int  color,
out string  diameterTitle 
)
inline

Gets the hole attributes, note existance of attributes depends on usage in main feature

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
titletitle for attribute
valuevalue of attribute
colorcolor of hole faces
diameterTitletitle for diameter attribute
unsafe NXOpen.ILocation [] NXOpen.Die.PierceHoleChildBuilder.GetPierceHoleLocation ( )
inline

Gets the locations of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Returns
pierce hole location
unsafe NXOpen.IProfile [] NXOpen.Die.PierceHoleChildBuilder.GetPierceHoleShape ( out NXOpen.Die.DirectionOption  direction)
inline

Gets the shape of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
directionprofile direction
Returns
profile entries
unsafe void NXOpen.Die.PierceHoleChildBuilder.GetSlugHoleAttributes ( out string  title,
out string  value,
out int  color,
out string  diameterTitle 
)
inline

Gets the slug hole attributes, note existance of attributes depends on usage in main feature

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
titletitle for attribute
valuevalue of attribute
colorcolor of hole faces
diameterTitletitle for diameter attribute
unsafe NXOpen.IProfile [] NXOpen.Die.PierceHoleChildBuilder.GetSlugHoleShape ( out NXOpen.Die.DirectionOption  direction)
inline

Gets the slug hole shape of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
directionprofile direction
Returns
profile entries
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetBreakerHoleAttributes ( string  title,
string  value,
int  color,
string  diameterTitle 
)
inline

Sets the breaker hole attributes, note existance of attributes depends on usage in main feature

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
titletitle for attribute
valuevalue of attribute
colorcolor of hole faces
diameterTitletitle for diameter attribute
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetBreakerHoleDepth ( string  breakerHoleDepth)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
breakerHoleDepth
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetBreakerHoleFactor ( string  breakerHoleFactor)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
breakerHoleFactor
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetBreakerHoleOffset ( string  breakerHoleOffset)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
breakerHoleOffset
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetBreakerHoleShape ( NXOpen.Die.DirectionOption  direction,
NXOpen.IProfile[]  profileEntries 
)
inline

Sets the breaker hole shape of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
directionprofile direction
profileEntriesprofile entries
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetDepth ( string  depth)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
depth
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetDiameter ( string  diameter)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
diameter
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetDieClearance ( string  dieClearance)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
dieClearance
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetHoleAttributes ( string  title,
string  value,
int  color,
string  diameterTitle 
)
inline

Sets the hole attributes, note existance of attributes depends on usage in main feature

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
titletitle for attribute
valuevalue of attribute
colorcolor of hole faces
diameterTitletitle for diameter attribute
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetLength ( string  length)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
length
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetPierceHoleLocation ( NXOpen.ILocation[]  pierceHoleLocations)
inline

Sets the locations of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
pierceHoleLocationspierce hole location
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetPierceHoleShape ( NXOpen.Die.DirectionOption  direction,
NXOpen.IProfile[]  profileEntries 
)
inline

Sets the shape of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
directionprofile direction
profileEntriesprofile entries
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetProfileBlendRadius ( string  profileBlendRadius)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
profileBlendRadiusprofile blend radius
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetSlugHoleAttributes ( string  title,
string  value,
int  color,
string  diameterTitle 
)
inline

Sets the slug hole attributes, note existance of attributes depends on usage in main feature

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
titletitle for attribute
valuevalue of attribute
colorcolor of hole faces
diameterTitletitle for diameter attribute
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetSlugHoleDiameterIncrement ( string  slugHoleDiameterIncrement)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
slugHoleDiameterIncrement
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetSlugHoleOffset ( string  slugHoleOffset)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
slugHoleOffset
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetSlugHoleShape ( NXOpen.Die.DirectionOption  direction,
NXOpen.IProfile[]  profileEntries 
)
inline

Sets the slug hole shape of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
directionprofile direction
profileEntriesprofile entries
unsafe void NXOpen.Die.PierceHoleChildBuilder.SetWidth ( string  width)
inline

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

Parameters
width
unsafe void NXOpen.Die.PierceHoleChildBuilder.TranslatePierceHoleLocation ( NXOpen.Vector3d  translateDist)
inline

Translates the center of the die pierce hole by the specified amount.

Created in NX5.0.0

License requirements: ug_die_design ("Die Design")

Parameters
translateDistA scaled vector indicating the distance to translate

Property Documentation

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.BreakerHoleDepth
get

Returns the breaker hole depth of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.ILocation NXOpen.Die.PierceHoleChildBuilder.BreakerHoleDirection
getset

Returns or sets the breaker hole direction of the pierce hole

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.BreakerHoleFactor
get

Returns the breaker hole factor of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.ILocation NXOpen.Die.PierceHoleChildBuilder.BreakerHoleLocation
getset

Returns or sets the location of breaker holes for the pierce hole

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.BreakerHoleOffset
get

Returns the breaker hole offset of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.Die.DieBuildStatusOption NXOpen.Die.PierceHoleChildBuilder.BuildStatus
get

Returns the build status of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe bool NXOpen.Die.PierceHoleChildBuilder.CircularSlugHole
getset

Returns or sets the circular slug hole switch of the pierce hole

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.Depth
get

Returns the depth of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe bool NXOpen.Die.PierceHoleChildBuilder.DesignStatus
getset

Returns or sets the design status of the pierce hole

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.Diameter
get

Returns the diameter of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.DieClearance
get

Returns the die clearance of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe bool NXOpen.Die.PierceHoleChildBuilder.DisplayHoles
getset

Returns or sets the display holes option of the pierce hole

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe bool NXOpen.Die.PierceHoleChildBuilder.DisplayStatus
getset

Returns or sets the display status of the pierce hole

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.Length
get

Returns the length of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.ILocation NXOpen.Die.PierceHoleChildBuilder.PierceHoleDirection
getset

Returns or sets the pierce hole direction

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.ProfileBlendRadius
get

Returns the profile blend radius of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.Die.PierceHoleChildBuilder.ShapeTypeOption NXOpen.Die.PierceHoleChildBuilder.ShapeType
getset

Returns or sets the pierce hole shape type

Created in NX4.0.0

License requirements to get this property: ug_die_design ("Die Design")

License requirements to set this property: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.SlugHoleDiameterIncrement
get

Returns the slug hole diameter increment of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.SlugHoleOffset
get

Returns the slug hole offset of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe NXOpen.Expression NXOpen.Die.PierceHoleChildBuilder.Width
get

Returns the width of the pierce hole

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")


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