DatumCommonBuilder Class

class NXOpen.Weld.DatumCommonBuilder

Bases: NXOpen.Builder

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

This is an abstract class and cannot be directly instantiated

New in version NX8.5.0.

Properties

Property	Description
AdditionalReferences	Returns the additional references.
Characteristics	Returns the characteristics.
ControlMethod	Returns or sets the control method.
CreateDirectionVector	Returns or sets the option to control if a reference datum axis should be output with this feature.
CreatePlane	Returns or sets the option to control if a reference datum plane should be output with the this feature.
CreatePoint	Returns or sets the option to control if a reference point should be output with this feature.
CreationDirection	Returns or sets the creation direction.
CustomAboveLength	Returns or sets the length above the datum reference point.
CustomRadius	Returns or sets the radius of the solid sphere, cylinder or cone created.
CustomTotalLength	Returns or sets the total length of the cylinder or cone along the direction axis.
CustomType	Returns or sets the custom datum type.
CustomTypeName	Returns or sets the custom name used to create the datum.
Derived	Returns or sets the indicator if this should be marked as a derived from another datum.
DirectionAxis	Returns or sets the direction axis.
DirectionLength	Returns or sets the length of the datum axis vector created.
ModelingTolerance	Returns or sets the modeling distance tolerance.
PlaneHeight	Returns or sets the plane height along the direction axis.
PlaneWidth	Returns or sets the plane width perpendicular to the direction axis.
PrincipalAxisX	Returns or sets the principal axis x.
PrincipalAxisY	Returns or sets the principal axis y.
PrincipalAxisZ	Returns or sets the principal axis z.
ProjectAlongDirection	Returns or sets the project along direction.
SectionPlaneNormal	Returns or sets the section plane normal.
SolidType	Returns or sets the solid body type specified.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateWithDerivedDatum	Initialize the builder with the inputs from an existing datum.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

DatumCommonBuilderControlMethodTypes Enumeration	Settings for the method used to define the control direction.
DatumCommonBuilderCreationDirectionMethods Enumeration	Settings to define the creation direction.
DatumCommonBuilderCustomTypes Enumeration	The custom type of the datum specified for creation.
DatumCommonBuilderSolidTypes Enumeration	Settings for defining the solid type to create for the datum object.

Property Detail

AdditionalReferences

DatumCommonBuilder.AdditionalReferences

Returns the additional references.

Use to define addtion parts the datum connects.

-------------------------------------

Getter Method

Signature AdditionalReferences

Returns: Return type:NXOpen.Assemblies.SelectComponentList

New in version NX8.5.0.

License requirements: None.

Characteristics

DatumCommonBuilder.Characteristics

Returns the characteristics.

Used to specify additional attributes.

-------------------------------------

Getter Method

Signature Characteristics

Returns: Return type:NXOpen.Weld.CharacteristicsBuilder

New in version NX8.5.0.

License requirements: None.

ControlMethod

DatumCommonBuilder.ControlMethod

Returns or sets the control method.

The method for fixing the datum orientation.

-------------------------------------

Getter Method

Signature ControlMethod

Returns: Return type:NXOpen.Weld.DatumCommonBuilderControlMethodTypes

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ControlMethod

Parameters:controlMethod (NXOpen.Weld.DatumCommonBuilderControlMethodTypes) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CreateDirectionVector

DatumCommonBuilder.CreateDirectionVector

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

-------------------------------------

Getter Method

Signature CreateDirectionVector

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateDirectionVector

Parameters:createDirectionVector (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CreatePlane

DatumCommonBuilder.CreatePlane

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

-------------------------------------

Getter Method

Signature CreatePlane

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreatePlane

Parameters:createPlane (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CreatePoint

DatumCommonBuilder.CreatePoint

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

-------------------------------------

Getter Method

Signature CreatePoint

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreatePoint

Parameters:createPoint (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CreationDirection

DatumCommonBuilder.CreationDirection

Returns or sets the creation direction.

-------------------------------------

Getter Method

Signature CreationDirection

Returns: Return type:NXOpen.Weld.DatumCommonBuilderCreationDirectionMethods

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreationDirection

Parameters:creationDirection (NXOpen.Weld.DatumCommonBuilderCreationDirectionMethods) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CustomAboveLength

DatumCommonBuilder.CustomAboveLength

Returns or sets the length above the datum reference point.

This is used if a cylinder or cone are created.

-------------------------------------

Getter Method

Signature CustomAboveLength

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CustomAboveLength

Parameters:directionLength (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CustomRadius

DatumCommonBuilder.CustomRadius

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

-------------------------------------

Getter Method

Signature CustomRadius

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CustomRadius

Parameters:customRadius (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CustomTotalLength

DatumCommonBuilder.CustomTotalLength

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

-------------------------------------

Getter Method

Signature CustomTotalLength

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CustomTotalLength

Parameters:customTotalLength (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

CustomType

DatumCommonBuilder.CustomType

Returns or sets the custom datum type.

This cooresponds to an entry in the customer defaults.

-------------------------------------

Getter Method

Signature CustomType

Returns: Return type:NXOpen.Weld.DatumCommonBuilderCustomTypes

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CustomType

Parameters:customType (NXOpen.Weld.DatumCommonBuilderCustomTypes) –

New in version NX9.0.0.

License requirements: ugweld (“UG WELD”)

CustomTypeName

DatumCommonBuilder.CustomTypeName

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

-------------------------------------

Getter Method

Signature CustomTypeName

Returns:Name of custom data type used from customer defaults Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CustomTypeName

Parameters:customTypeName (str) – Custom datum type from customer defaults to use

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

Derived

DatumCommonBuilder.Derived

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

-------------------------------------

Getter Method

Signature Derived

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Derived

Parameters:derived (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

DirectionAxis

DatumCommonBuilder.DirectionAxis

Returns or sets the direction axis.

This defines the datum origin and specifed axis.

-------------------------------------

Getter Method

Signature DirectionAxis

Returns: Return type:NXOpen.Axis

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DirectionAxis

Parameters:directionAxis (NXOpen.Axis) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

DirectionLength

DatumCommonBuilder.DirectionLength

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

-------------------------------------

Getter Method

Signature DirectionLength

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DirectionLength

Parameters:directionLength (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

ModelingTolerance

DatumCommonBuilder.ModelingTolerance

Returns or sets the modeling distance tolerance.

-------------------------------------

Getter Method

Signature ModelingTolerance

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ModelingTolerance

Parameters:modelingTolerance (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

PlaneHeight

DatumCommonBuilder.PlaneHeight

Returns or sets the plane height along the direction axis.

Controls the boundary of a datum plane.

-------------------------------------

Getter Method

Signature PlaneHeight

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneHeight

Parameters:planeHeight (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

PlaneWidth

DatumCommonBuilder.PlaneWidth

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

Controls the boundary of a datum plane.

-------------------------------------

Getter Method

Signature PlaneWidth

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneWidth

Parameters:planeWidth (float) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

PrincipalAxisX

DatumCommonBuilder.PrincipalAxisX

Returns or sets the principal axis x.

Used to specify datum is controlling the x axis.

-------------------------------------

Getter Method

Signature PrincipalAxisX

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PrincipalAxisX

Parameters:principalAxisX (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

PrincipalAxisY

DatumCommonBuilder.PrincipalAxisY

Returns or sets the principal axis y.

Used to specify the datum is controlling the y axis.

-------------------------------------

Getter Method

Signature PrincipalAxisY

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PrincipalAxisY

Parameters:principalAxisY (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

PrincipalAxisZ

DatumCommonBuilder.PrincipalAxisZ

Returns or sets the principal axis z.

Used to specify the datum is controlling the z axis.

-------------------------------------

Getter Method

Signature PrincipalAxisZ

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PrincipalAxisZ

Parameters:principalAxisZ (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

ProjectAlongDirection

DatumCommonBuilder.ProjectAlongDirection

Returns or sets the project along direction.

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

-------------------------------------

Getter Method

Signature ProjectAlongDirection

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ProjectAlongDirection

Parameters:projectAlongDirection (bool) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

SectionPlaneNormal

DatumCommonBuilder.SectionPlaneNormal

Returns or sets the section plane normal.

This is sometimes referred to as the clamping plane.

-------------------------------------

Getter Method

Signature SectionPlaneNormal

Returns: Return type:NXOpen.Direction

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SectionPlaneNormal

Parameters:sectionPlaneNormal (NXOpen.Direction) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

SolidType

DatumCommonBuilder.SolidType

Returns or sets the solid body type specified.

-------------------------------------

Getter Method

Signature SolidType

Returns: Return type:NXOpen.Weld.DatumCommonBuilderSolidTypes

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SolidType

Parameters:solidType (NXOpen.Weld.DatumCommonBuilderSolidTypes) –

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

Method Detail

UpdateWithDerivedDatum

DatumCommonBuilder.UpdateWithDerivedDatum

Initialize the builder with the inputs from an existing datum.

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

Signature UpdateWithDerivedDatum()

New in version NX8.5.0.

License requirements: ugweld (“UG WELD”)

Validate

DatumCommonBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.