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

Used to create or edit a NXOpen.Weld.DatumSurface or NXOpen.Weld.DatumPin feature. More...

Inheritance diagram for NXOpen.Weld.DatumCommonBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.Weld.DatumPinBuilder NXOpen.Weld.DatumSurfaceBuilder

Public Types

enum  ControlMethodTypes { PrincipalAxis, UseSectionPlane }
 Settings for the method used to define the control direction. More...
 
enum  CreationDirectionMethods { Default, Opposite }
 Settings to define the creation direction. More...
 
enum  CustomTypes {
  Default, Custom1, Custom2, Custom3,
  Custom4, Custom5, Custom6, Custom7
}
 The custom type of the datum specified for creation. More...
 
enum  SolidTypes { Sphere, Cylinder, Cone }
 Settings for defining the solid type to create for the datum object. More...
 

Public Member Functions

unsafe void UpdateWithDerivedDatum ()
 Initialize the builder with the inputs from an existing datum. 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.Assemblies.SelectComponentList 
AdditionalReferences [get]
 Returns the additional references. More...
 
unsafe
NXOpen.Weld.CharacteristicsBuilder 
Characteristics [get]
 Returns the characteristics. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.ControlMethodTypes 
ControlMethod [get, set]
 Returns or sets the control method. More...
 
unsafe bool CreateDirectionVector [get, set]
 Returns or sets the option to control if a reference datum axis should be output with this feature. More...
 
unsafe bool CreatePlane [get, set]
 Returns or sets the option to control if a reference datum plane should be output with the this feature. More...
 
unsafe bool CreatePoint [get, set]
 Returns or sets the option to control if a reference point should be output with this feature. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.CreationDirectionMethods 
CreationDirection [get, set]
 Returns or sets the creation direction. More...
 
unsafe double CustomAboveLength [get, set]
 Returns or sets the length above the datum reference point. More...
 
unsafe double CustomRadius [get, set]
 Returns or sets the radius of the solid sphere, cylinder or cone created. More...
 
unsafe double CustomTotalLength [get, set]
 Returns or sets the total length of the cylinder or cone along the direction axis. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.CustomTypes 
CustomType [get, set]
 Returns or sets the custom datum type. More...
 
unsafe string CustomTypeName [get, set]
 Returns or sets the custom name used to create the datum. More...
 
unsafe bool Derived [get, set]
 Returns or sets the indicator if this should be marked as a derived from another datum. More...
 
unsafe NXOpen.Axis DirectionAxis [get, set]
 Returns or sets the direction axis. More...
 
unsafe double DirectionLength [get, set]
 Returns or sets the length of the datum axis vector created. More...
 
unsafe double ModelingTolerance [get, set]
 Returns or sets the modeling distance tolerance. More...
 
unsafe double PlaneHeight [get, set]
 Returns or sets the plane height along the direction axis. More...
 
unsafe double PlaneWidth [get, set]
 Returns or sets the plane width perpendicular to the direction axis. More...
 
unsafe bool PrincipalAxisX [get, set]
 Returns or sets the principal axis x. More...
 
unsafe bool PrincipalAxisY [get, set]
 Returns or sets the principal axis y. More...
 
unsafe bool PrincipalAxisZ [get, set]
 Returns or sets the principal axis z. More...
 
unsafe bool ProjectAlongDirection [get, set]
 Returns or sets the project along direction. More...
 
unsafe NXOpen.Direction SectionPlaneNormal [get, set]
 Returns or sets the section plane normal. More...
 
unsafe
NXOpen.Weld.DatumCommonBuilder.SolidTypes 
SolidType [get, set]
 Returns or sets the solid body type specified. 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

Used to create or edit a NXOpen.Weld.DatumSurface or NXOpen.Weld.DatumPin feature.

This is an abstract class and cannot be directly instantiated

Created in NX8.5.0

Member Enumeration Documentation

Settings for the method used to define the control direction.

Enumerator
PrincipalAxis 

A principal axis.

Absolute X,Y, or Z

UseSectionPlane 

Not a principal axis, use Section Plane

Settings to define the creation direction.

Enumerator
Default 

Use the default construction method

Opposite 

Reverse the construction orientation

The custom type of the datum specified for creation.

Enumerator
Default 

A datum surface or pin specified in the customer defaults by the Default type.

Custom1 

A datum surface or pin specified in the customer defaults by the Custom1 type.

Custom2 

A datum surface or pin specified in the customer defaults by the Custom2 type.

Custom3 

A datum surface or pin specified in the customer defaults by the Custom3 type.

Custom4 

A datum surface or pin specified in the customer defaults by the Custom4 type.

Custom5 

A datum surface or pin specified in the customer defaults by the Custom5 type.

Custom6 

A datum surface or pin specified in the customer defaults by the Custom6 type.

Custom7 

A datum surface or pin specified in the customer defaults by the Custom7 type.

Settings for defining the solid type to create for the datum object.

Enumerator
Sphere 

Datum solid will be a sphere

Cylinder 

Datum solid will be a cylinder

Cone 

Datum solid will be a cone

Member Function Documentation

unsafe void NXOpen.Weld.DatumCommonBuilder.UpdateWithDerivedDatum ( )
inline

Initialize the builder with the inputs from an existing datum.

The builder type and derived datum type must be the same.

Created in NX8.5.0

License requirements: ugweld ("UG WELD")

Property Documentation

unsafe NXOpen.Assemblies.SelectComponentList NXOpen.Weld.DatumCommonBuilder.AdditionalReferences
get

Returns the additional references.

Use to define addtion parts the datum connects.

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Weld.CharacteristicsBuilder NXOpen.Weld.DatumCommonBuilder.Characteristics
get

Returns the characteristics.

Used to specify additional attributes.

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Weld.DatumCommonBuilder.ControlMethodTypes NXOpen.Weld.DatumCommonBuilder.ControlMethod
getset

Returns or sets the control method.

The method for fixing the datum orientation.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.CreateDirectionVector
getset

Returns or sets the option to control if a reference datum axis should be output with this feature.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.CreatePlane
getset

Returns or sets the option to control if a reference datum plane should be output with the this feature.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.CreatePoint
getset

Returns or sets the option to control if a reference point should be output with this feature.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Weld.DatumCommonBuilder.CreationDirectionMethods NXOpen.Weld.DatumCommonBuilder.CreationDirection
getset

Returns or sets the creation direction.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.CustomAboveLength
getset

Returns or sets the length above the datum reference point.

This is used if a cylinder or cone are created.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.CustomRadius
getset

Returns or sets the radius of the solid sphere, cylinder or cone created.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.CustomTotalLength
getset

Returns or sets the total length of the cylinder or cone along the direction axis.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Weld.DatumCommonBuilder.CustomTypes NXOpen.Weld.DatumCommonBuilder.CustomType
getset

Returns or sets the custom datum type.

This cooresponds to an entry in the customer defaults.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe string NXOpen.Weld.DatumCommonBuilder.CustomTypeName
getset

Returns or sets the custom name used to create the datum.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.Derived
getset

Returns or sets the indicator if this should be marked as a derived from another datum.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Axis NXOpen.Weld.DatumCommonBuilder.DirectionAxis
getset

Returns or sets the direction axis.

This defines the datum origin and specifed axis.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.DirectionLength
getset

Returns or sets the length of the datum axis vector created.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.ModelingTolerance
getset

Returns or sets the modeling distance tolerance.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.PlaneHeight
getset

Returns or sets the plane height along the direction axis.

Controls the boundary of a datum plane.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe double NXOpen.Weld.DatumCommonBuilder.PlaneWidth
getset

Returns or sets the plane width perpendicular to the direction axis.

Controls the boundary of a datum plane.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.PrincipalAxisX
getset

Returns or sets the principal axis x.

Used to specify datum is controlling the x axis.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.PrincipalAxisY
getset

Returns or sets the principal axis y.

Used to specify the datum is controlling the y axis.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.PrincipalAxisZ
getset

Returns or sets the principal axis z.

Used to specify the datum is controlling the z axis.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.DatumCommonBuilder.ProjectAlongDirection
getset

Returns or sets the project along direction.

Two coordiantes can be specified and the third obtained from projection.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Direction NXOpen.Weld.DatumCommonBuilder.SectionPlaneNormal
getset

Returns or sets the section plane normal.

This is sometimes referred to as the clamping plane.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Weld.DatumCommonBuilder.SolidTypes NXOpen.Weld.DatumCommonBuilder.SolidType
getset

Returns or sets the solid body type specified.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ugweld ("UG WELD")


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