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:

Public Types
enum	ControlMethodTypes { ControlMethodTypesPrincipalAxis, ControlMethodTypesUseSectionPlane }
	Settings for the method used to define the control direction. More...
enum	CreationDirectionMethods { CreationDirectionMethodsDefault, CreationDirectionMethodsOpposite }
	Settings to define the creation direction. More...
enum	CustomTypes {   CustomTypesDefault, CustomTypesCustom1, CustomTypesCustom2, CustomTypesCustom3,   CustomTypesCustom4, CustomTypesCustom5, CustomTypesCustom6, CustomTypesCustom7 }
	The custom type of the datum specified for creation. More...
enum	SolidTypes { SolidTypesSphere, SolidTypesCylinder, SolidTypesCone }
	Settings for defining the solid type to create for the datum object. More...

Public Member Functions
NXOpen::Assemblies::SelectComponentList *	AdditionalReferences ()
	Returns the additional references. More...
NXOpen::Weld::CharacteristicsBuilder *	Characteristics ()
	Returns the characteristics. More...
NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes	ControlMethod ()
	Returns the control method. More...
bool	CreateDirectionVector ()
	Returns the option to control if a reference datum axis should be output with this feature. More...
bool	CreatePlane ()
	Returns the option to control if a reference datum plane should be output with the this feature. More...
bool	CreatePoint ()
	Returns the option to control if a reference point should be output with this feature. More...
NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods	CreationDirection ()
	Returns the creation direction. More...
double	CustomAboveLength ()
	Returns the length above the datum reference point. More...
double	CustomRadius ()
	Returns the radius of the solid sphere, cylinder or cone created. More...
double	CustomTotalLength ()
	Returns the total length of the cylinder or cone along the direction axis. More...
NXOpen::Weld::DatumCommonBuilder::CustomTypes	CustomType ()
	Returns the custom datum type. More...
NXString	CustomTypeName ()
	Returns the custom name used to create the datum. More...
bool	Derived ()
	Returns the indicator if this should be marked as a derived from another datum. More...
NXOpen::Axis *	DirectionAxis ()
	Returns the direction axis. More...
double	DirectionLength ()
	Returns the length of the datum axis vector created. More...
double	ModelingTolerance ()
	Returns the modeling distance tolerance. More...
double	PlaneHeight ()
	Returns the plane height along the direction axis. More...
double	PlaneWidth ()
	Returns the plane width perpendicular to the direction axis. More...
bool	PrincipalAxisX ()
	Returns the principal axis x. More...
bool	PrincipalAxisY ()
	Returns the principal axis y. More...
bool	PrincipalAxisZ ()
	Returns the principal axis z. More...
bool	ProjectAlongDirection ()
	Returns the project along direction. More...
NXOpen::Direction *	SectionPlaneNormal ()
	Returns the section plane normal. More...
void	SetControlMethod (NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes controlMethod)
	Sets the control method. More...
void	SetCreateDirectionVector (bool createDirectionVector)
	Sets the option to control if a reference datum axis should be output with this feature. More...
void	SetCreatePlane (bool createPlane)
	Sets the option to control if a reference datum plane should be output with the this feature. More...
void	SetCreatePoint (bool createPoint)
	Sets the option to control if a reference point should be output with this feature. More...
void	SetCreationDirection (NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods creationDirection)
	Sets the creation direction. More...
void	SetCustomAboveLength (double directionLength)
	Sets the length above the datum reference point. More...
void	SetCustomRadius (double customRadius)
	Sets the radius of the solid sphere, cylinder or cone created. More...
void	SetCustomTotalLength (double customTotalLength)
	Sets the total length of the cylinder or cone along the direction axis. More...
void	SetCustomType (NXOpen::Weld::DatumCommonBuilder::CustomTypes customType)
	Sets the custom datum type. More...
void	SetCustomTypeName (const NXString &customTypeName)
	Sets the custom name used to create the datum. More...
void	SetCustomTypeName (const char *customTypeName)
	Sets the custom name used to create the datum. More...
void	SetDerived (bool derived)
	Sets the indicator if this should be marked as a derived from another datum. More...
void	SetDirectionAxis (NXOpen::Axis *directionAxis)
	Sets the direction axis. More...
void	SetDirectionLength (double directionLength)
	Sets the length of the datum axis vector created. More...
void	SetModelingTolerance (double modelingTolerance)
	Sets the modeling distance tolerance. More...
void	SetPlaneHeight (double planeHeight)
	Sets the plane height along the direction axis. More...
void	SetPlaneWidth (double planeWidth)
	Sets the plane width perpendicular to the direction axis. More...
void	SetPrincipalAxisX (bool principalAxisX)
	Sets the principal axis x. More...
void	SetPrincipalAxisY (bool principalAxisY)
	Sets the principal axis y. More...
void	SetPrincipalAxisZ (bool principalAxisZ)
	Sets the principal axis z. More...
void	SetProjectAlongDirection (bool projectAlongDirection)
	Sets the project along direction. More...
void	SetSectionPlaneNormal (NXOpen::Direction *sectionPlaneNormal)
	Sets the section plane normal. More...
void	SetSolidType (NXOpen::Weld::DatumCommonBuilder::SolidTypes solidType)
	Sets the solid body type specified. More...
NXOpen::Weld::DatumCommonBuilder::SolidTypes	SolidType ()
	Returns the solid body type specified. More...
void	UpdateWithDerivedDatum ()
	Initialize the builder with the inputs from an existing datum. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

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

enum NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes

Settings for the method used to define the control direction.

Enumerator
ControlMethodTypesPrincipalAxis	A principal axis. Absolute X,Y, or Z
ControlMethodTypesUseSectionPlane	Not a principal axis, use Section Plane.

enum NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods

Settings to define the creation direction.

Enumerator
CreationDirectionMethodsDefault	Use the default construction method.
CreationDirectionMethodsOpposite	Reverse the construction orientation.

enum NXOpen::Weld::DatumCommonBuilder::CustomTypes

The custom type of the datum specified for creation.

Enumerator
CustomTypesDefault	A datum surface or pin specified in the customer defaults by the Default type.
CustomTypesCustom1	A datum surface or pin specified in the customer defaults by the Custom1 type.
CustomTypesCustom2	A datum surface or pin specified in the customer defaults by the Custom2 type.
CustomTypesCustom3	A datum surface or pin specified in the customer defaults by the Custom3 type.
CustomTypesCustom4	A datum surface or pin specified in the customer defaults by the Custom4 type.
CustomTypesCustom5	A datum surface or pin specified in the customer defaults by the Custom5 type.
CustomTypesCustom6	A datum surface or pin specified in the customer defaults by the Custom6 type.
CustomTypesCustom7	A datum surface or pin specified in the customer defaults by the Custom7 type.

enum NXOpen::Weld::DatumCommonBuilder::SolidTypes

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

Enumerator
SolidTypesSphere	Datum solid will be a sphere.
SolidTypesCylinder	Datum solid will be a cylinder.
SolidTypesCone	Datum solid will be a cone.

Member Function Documentation

NXOpen::Assemblies::SelectComponentList* NXOpen::Weld::DatumCommonBuilder::AdditionalReferences

(

)

Returns the additional references.

Use to define addtion parts the datum connects.
Created in NX8.5.0.

License requirements : None

NXOpen::Weld::CharacteristicsBuilder* NXOpen::Weld::DatumCommonBuilder::Characteristics

(

)

Returns the characteristics.

Used to specify additional attributes.
Created in NX8.5.0.

License requirements : None

NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes NXOpen::Weld::DatumCommonBuilder::ControlMethod

(

)

Returns the control method.

The method for fixing the datum orientation.
Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::CreateDirectionVector

(

)

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

Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::CreatePlane

(

)

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

Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::CreatePoint

(

)

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

Created in NX8.5.0.

License requirements : None

NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods NXOpen::Weld::DatumCommonBuilder::CreationDirection

(

)

Returns the creation direction.

Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::CustomAboveLength

(

)

Returns the length above the datum reference point.

This is used if a cylinder or cone are created.
Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::CustomRadius

(

)

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

Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::CustomTotalLength

(

)

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

Created in NX8.5.0.

License requirements : None

NXOpen::Weld::DatumCommonBuilder::CustomTypes NXOpen::Weld::DatumCommonBuilder::CustomType

(

)

Returns the custom datum type.

This cooresponds to an entry in the customer defaults.
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Weld::DatumCommonBuilder::CustomTypeName

(

)

Returns the custom name used to create the datum.

Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::Derived

(

)

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

Created in NX8.5.0.

License requirements : None

NXOpen::Axis* NXOpen::Weld::DatumCommonBuilder::DirectionAxis

(

)

Returns the direction axis.

This defines the datum origin and specifed axis.
Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::DirectionLength

(

)

Returns the length of the datum axis vector created.

Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::ModelingTolerance

(

)

Returns the modeling distance tolerance.

Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::PlaneHeight

(

)

Returns the plane height along the direction axis.

Controls the boundary of a datum plane.
Created in NX8.5.0.

License requirements : None

double NXOpen::Weld::DatumCommonBuilder::PlaneWidth

(

)

Returns the plane width perpendicular to the direction axis.

Controls the boundary of a datum plane.
Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::PrincipalAxisX

(

)

Returns the principal axis x.

Used to specify datum is controlling the x axis.
Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::PrincipalAxisY

(

)

Returns the principal axis y.

Used to specify the datum is controlling the y axis.
Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::PrincipalAxisZ

(

)

Returns the principal axis z.

Used to specify the datum is controlling the z axis.
Created in NX8.5.0.

License requirements : None

bool NXOpen::Weld::DatumCommonBuilder::ProjectAlongDirection

(

)

Returns the project along direction.

Two coordiantes can be specified and the third obtained from projection.
Created in NX8.5.0.

License requirements : None

NXOpen::Direction* NXOpen::Weld::DatumCommonBuilder::SectionPlaneNormal

(

)

Returns the section plane normal.

This is sometimes referred to as the clamping plane.
Created in NX8.5.0.

License requirements : None

void NXOpen::Weld::DatumCommonBuilder::SetControlMethod

(

NXOpen::Weld::DatumCommonBuilder::ControlMethodTypes

controlMethod

)

Sets the control method.

The method for fixing the datum orientation.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

controlMethod

controlmethod

void NXOpen::Weld::DatumCommonBuilder::SetCreateDirectionVector

(

bool

createDirectionVector

)

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

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

createDirectionVector

createdirectionvector

void NXOpen::Weld::DatumCommonBuilder::SetCreatePlane

(

bool

createPlane

)

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

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

createPlane

createplane

void NXOpen::Weld::DatumCommonBuilder::SetCreatePoint

(

bool

createPoint

)

Sets the option to control if a reference point should be output with this feature.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

createPoint

createpoint

void NXOpen::Weld::DatumCommonBuilder::SetCreationDirection

(

NXOpen::Weld::DatumCommonBuilder::CreationDirectionMethods

creationDirection

)

Sets the creation direction.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

creationDirection

creationdirection

void NXOpen::Weld::DatumCommonBuilder::SetCustomAboveLength

(

double

directionLength

)

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 : ugweld ("UG WELD")

Parameters

directionLength

directionlength

void NXOpen::Weld::DatumCommonBuilder::SetCustomRadius

(

double

customRadius

)

Sets the radius of the solid sphere, cylinder or cone created.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

customRadius

customradius

void NXOpen::Weld::DatumCommonBuilder::SetCustomTotalLength

(

double

customTotalLength

)

Sets the total length of the cylinder or cone along the direction axis.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

customTotalLength

customtotallength

void NXOpen::Weld::DatumCommonBuilder::SetCustomType

(

NXOpen::Weld::DatumCommonBuilder::CustomTypes

customType

)

Sets the custom datum type.

This cooresponds to an entry in the customer defaults.
Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

customType

customtype

void NXOpen::Weld::DatumCommonBuilder::SetCustomTypeName

(

const NXString &

customTypeName

)

Sets the custom name used to create the datum.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

customTypeName

Custom datum type from customer defaults to use

void NXOpen::Weld::DatumCommonBuilder::SetCustomTypeName

(

const char *

customTypeName

)

Sets the custom name used to create the datum.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

customTypeName

Custom datum type from customer defaults to use

void NXOpen::Weld::DatumCommonBuilder::SetDerived

(

bool

derived

)

Sets the indicator if this should be marked as a derived from another datum.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

derived

derived

void NXOpen::Weld::DatumCommonBuilder::SetDirectionAxis

(

NXOpen::Axis *

directionAxis

)

Sets the direction axis.

This defines the datum origin and specifed axis.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

directionAxis

directionaxis

void NXOpen::Weld::DatumCommonBuilder::SetDirectionLength

(

double

directionLength

)

Sets the length of the datum axis vector created.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

directionLength

directionlength

void NXOpen::Weld::DatumCommonBuilder::SetModelingTolerance

(

double

modelingTolerance

)

Sets the modeling distance tolerance.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

modelingTolerance

modelingtolerance

void NXOpen::Weld::DatumCommonBuilder::SetPlaneHeight

(

double

planeHeight

)

Sets the plane height along the direction axis.

Controls the boundary of a datum plane.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

planeHeight

planeheight

void NXOpen::Weld::DatumCommonBuilder::SetPlaneWidth

(

double

planeWidth

)

Sets the plane width perpendicular to the direction axis.

Controls the boundary of a datum plane.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

planeWidth

planewidth

void NXOpen::Weld::DatumCommonBuilder::SetPrincipalAxisX

(

bool

principalAxisX

)

Sets the principal axis x.

Used to specify datum is controlling the x axis.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

principalAxisX

principalaxisx

void NXOpen::Weld::DatumCommonBuilder::SetPrincipalAxisY

(

bool

principalAxisY

)

Sets the principal axis y.

Used to specify the datum is controlling the y axis.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

principalAxisY

principalaxisy

void NXOpen::Weld::DatumCommonBuilder::SetPrincipalAxisZ

(

bool

principalAxisZ

)

Sets the principal axis z.

Used to specify the datum is controlling the z axis.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

principalAxisZ

principalaxisz

void NXOpen::Weld::DatumCommonBuilder::SetProjectAlongDirection

(

bool

projectAlongDirection

)

Sets the project along direction.

Two coordiantes can be specified and the third obtained from projection.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

projectAlongDirection

projectalongdirection

void NXOpen::Weld::DatumCommonBuilder::SetSectionPlaneNormal

(

NXOpen::Direction *

sectionPlaneNormal

)

Sets the section plane normal.

This is sometimes referred to as the clamping plane.
Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

sectionPlaneNormal

sectionplanenormal

void NXOpen::Weld::DatumCommonBuilder::SetSolidType

(

NXOpen::Weld::DatumCommonBuilder::SolidTypes

solidType

)

Sets the solid body type specified.

Created in NX8.5.0.

License requirements : ugweld ("UG WELD")

Parameters

solidType

solidtype

NXOpen::Weld::DatumCommonBuilder::SolidTypes NXOpen::Weld::DatumCommonBuilder::SolidType

(

)

Returns the solid body type specified.

Created in NX8.5.0.

License requirements : None

void NXOpen::Weld::DatumCommonBuilder::UpdateWithDerivedDatum

(

)

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

---

The documentation for this class was generated from the following file:

• Weld_DatumCommonBuilder.hxx