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.KeywayChildBuilder Class Reference

Represents a Die Keyway Child sub feature. More...

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

Public Types

enum  LocationOption { PositiveX, NegativeX, PositiveY, NegativeY }
 Settings for the location of the keyway. More...
 
enum  RunoffTypeOption { Rectangular, Circular }
 Settings for the runoff type of the keyway. More...
 

Public Member Functions

unsafe void GetPadAttributes (out string title, out string value, out int color)
 Gets the pad attributes, note existance of attributes depends on usage in main feature. More...
 
unsafe void GetSlotAttributes (out string title, out string value, out int color)
 Gets the slot attributes, note existance of attributes depends on usage in main feature. More...
 
unsafe void SetPadAttributes (string title, string value, int color)
 Sets the pad attributes, note existance of attributes depends on usage in main feature. More...
 
unsafe void SetSlotAttributes (string title, string value, int color)
 Sets the slot attributes, note existance of attributes depends on usage in main feature. 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.Die.DieBuildStatusOption 
BuildStatus [get]
 Returns the build status of the keyway. More...
 
unsafe double Depth [get, set]
 Returns or sets the depth of the keyway. More...
 
unsafe bool DesignStatus [get, set]
 Returns or sets the design status of the keyway, if true the keyway will be built into the model, if false it will not. More...
 
unsafe bool DisplayStatus [get, set]
 Returns or sets the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed. More...
 
unsafe double Length [get, set]
 Returns or sets the length of the keyway. More...
 
unsafe
NXOpen.Die.KeywayChildBuilder.LocationOption 
Location [get, set]
 Returns or sets the location of the keyway. More...
 
unsafe double MinimumRibHeight [get, set]
 Returns or sets the minimum rib height of the keyway. More...
 
unsafe double Offset [get, set]
 Returns or sets the offset of the keyway. More...
 
unsafe double PadHeight [get, set]
 Returns or sets the pad height of the keyway. More...
 
unsafe double PadWidth [get, set]
 Returns or sets the pad width of the keyway. More...
 
unsafe double PlacementOffset [get, set]
 Returns or sets the placement offset of the keyway. More...
 
unsafe NXOpen.IOrientation Plane [get, set]
 Returns or sets the plane of the keyway. More...
 
unsafe bool ReverseOrientation [get, set]
 Returns or sets the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not. More...
 
unsafe double RunoffDepth [get, set]
 Returns or sets the runoff depth of the keyway. More...
 
unsafe double RunoffDiameter [get, set]
 Returns or sets the runoff diameter of the keyway. More...
 
unsafe double RunoffLength [get, set]
 Returns or sets the runoff length of the keyway. More...
 
unsafe
NXOpen.Die.KeywayChildBuilder.RunoffTypeOption 
RunoffType [get, set]
 Returns or sets the runoff type of the keyway. More...
 
unsafe double RunoffWidth [get, set]
 Returns or sets the runoff width of the keyway. More...
 
unsafe double Width [get, set]
 Returns or sets the width of the keyway. 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 Die Keyway Child sub feature.

This sub feature is created via the main feature builder.

Created in NX4.0.0

Member Enumeration Documentation

Settings for the location of the keyway.

Enumerator
PositiveX 

Keyway built in positive x direction.

NegativeX 

Keyway built in negative x direction.

PositiveY 

Keyway built in positive y direction.

NegativeY 

Keyway built in negative y direction.

Settings for the runoff type of the keyway.

Enumerator
Rectangular 

Rectangular runoff.

Circular 

Circular runoff.

Member Function Documentation

unsafe void NXOpen.Die.KeywayChildBuilder.GetPadAttributes ( out string  title,
out string  value,
out int  color 
)
inline

Gets the pad 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 pad faces.
unsafe void NXOpen.Die.KeywayChildBuilder.GetSlotAttributes ( out string  title,
out string  value,
out int  color 
)
inline

Gets the slot 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 slot faces.
unsafe void NXOpen.Die.KeywayChildBuilder.SetPadAttributes ( string  title,
string  value,
int  color 
)
inline

Sets the pad 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 pad faces.
unsafe void NXOpen.Die.KeywayChildBuilder.SetSlotAttributes ( string  title,
string  value,
int  color 
)
inline

Sets the slot 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 slot faces.

Property Documentation

unsafe NXOpen.Die.DieBuildStatusOption NXOpen.Die.KeywayChildBuilder.BuildStatus
get

Returns the build status of the keyway.

Created in NX4.0.0

License requirements: ug_die_design ("Die Design")

unsafe double NXOpen.Die.KeywayChildBuilder.Depth
getset

Returns or sets the depth of the keyway.

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.KeywayChildBuilder.DesignStatus
getset

Returns or sets the design status of the keyway, if true the keyway will be built into the model, if false it will not.

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.KeywayChildBuilder.DisplayStatus
getset

Returns or sets the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed.

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 double NXOpen.Die.KeywayChildBuilder.Length
getset

Returns or sets the length of the keyway.

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.Die.KeywayChildBuilder.LocationOption NXOpen.Die.KeywayChildBuilder.Location
getset

Returns or sets the location of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.MinimumRibHeight
getset

Returns or sets the minimum rib height of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.Offset
getset

Returns or sets the offset of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.PadHeight
getset

Returns or sets the pad height of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.PadWidth
getset

Returns or sets the pad width of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.PlacementOffset
getset

Returns or sets the placement offset of the keyway.

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.IOrientation NXOpen.Die.KeywayChildBuilder.Plane
getset

Returns or sets the plane of the keyway.

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.KeywayChildBuilder.ReverseOrientation
getset

Returns or sets the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.

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 double NXOpen.Die.KeywayChildBuilder.RunoffDepth
getset

Returns or sets the runoff depth of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.RunoffDiameter
getset

Returns or sets the runoff diameter of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.RunoffLength
getset

Returns or sets the runoff length of the keyway.

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.Die.KeywayChildBuilder.RunoffTypeOption NXOpen.Die.KeywayChildBuilder.RunoffType
getset

Returns or sets the runoff type of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.RunoffWidth
getset

Returns or sets the runoff width of the keyway.

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 double NXOpen.Die.KeywayChildBuilder.Width
getset

Returns or sets the width of the keyway.

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")


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