NXOpen::Weld::WeldPmiBuilder Class Reference

Create PMI symbols for multiple structure welds, this builder's Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject's output array is stable. More...

Inheritance diagram for NXOpen::Weld::WeldPmiBuilder:

Public Types
enum	OrientationPlaneType {   OrientationPlaneTypeXYPlane, OrientationPlaneTypeXZPlane, OrientationPlaneTypeYZPlane, OrientationPlaneTypeModelView,   OrientationPlaneTypeLastUserDefined, OrientationPlaneTypeUserDefined }
	This represents the Orientation Plane Type. More...

Public Member Functions
NXOpen::SelectNXObjectList *	Objects ()
	Returns the objects (either features or curves) that are used to create PMI symbols.
NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType	PlaneType ()
	Returns the plane type.
void	SetPlaneType (NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType planeType)
	Sets the plane type.
void	SetSpaceFactor (double spaceFactor)
	Sets the space factor.
void	SetUserCoordinateSystem (NXOpen::CoordinateSystem *userCsys)
	Sets the user specified coordinate system.
double	SpaceFactor ()
	Returns the space factor.
NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the Annotations::StyleBuilder for the annotation.
NXOpen::CoordinateSystem *	UserCoordinateSystem ()
	Returns the user specified coordinate system.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Create PMI symbols for multiple structure welds, this builder's Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject's output array is stable.

To create a new instance of this class, use Weld::WeldManager::CreateWeldPmiBuilder
Default values.

Property	Value
PlaneType	ModelView
SpaceFactor	1.0

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType

This represents the Orientation Plane Type.

Enumerator:

OrientationPlaneTypeXYPlane	xyplane
OrientationPlaneTypeXZPlane	xzplane
OrientationPlaneTypeYZPlane	yzplane
OrientationPlaneTypeModelView	model view
OrientationPlaneTypeLastUserDefined	last user defined
OrientationPlaneTypeUserDefined	user defined

Member Function Documentation

NXOpen::SelectNXObjectList* NXOpen::Weld::WeldPmiBuilder::Objects

(

)

Returns the objects (either features or curves) that are used to create PMI symbols.

Created in NX9.0.0.

License requirements : None

NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType NXOpen::Weld::WeldPmiBuilder::PlaneType

(

)

Returns the plane type.

Created in NX9.0.0.

License requirements : None

void NXOpen::Weld::WeldPmiBuilder::SetPlaneType

(

NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType

planeType

)

Sets the plane type.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters

planeType

planetype

void NXOpen::Weld::WeldPmiBuilder::SetSpaceFactor

(

double

spaceFactor

)

Sets the space factor.

The value is greater than zero.
Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters

spaceFactor

spacefactor

void NXOpen::Weld::WeldPmiBuilder::SetUserCoordinateSystem

(

NXOpen::CoordinateSystem *

userCsys

)

Sets the user specified coordinate system.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")

Parameters

userCsys

usercsys

double NXOpen::Weld::WeldPmiBuilder::SpaceFactor

(

)

Returns the space factor.

The value is greater than zero.
Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::StyleBuilder* NXOpen::Weld::WeldPmiBuilder::Style

(

)

Returns the Annotations::StyleBuilder for the annotation.

Created in NX9.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::Weld::WeldPmiBuilder::UserCoordinateSystem

(

)

Returns the user specified coordinate system.

Created in NX9.0.0.

License requirements : None

---

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

• Weld_WeldPmiBuilder.hxx