NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

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

Public Member Functions

NXOpen::SelectNXObjectListObjects ()
 Returns the objects (either features or curves) that are used to create PMI symbols. More...
 
NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType PlaneType ()
 Returns the plane type. More...
 
void SetPlaneType (NXOpen::Weld::WeldPmiBuilder::OrientationPlaneType planeType)
 Sets the plane type. More...
 
void SetSpaceFactor (double spaceFactor)
 Sets the space factor. More...
 
void SetUserCoordinateSystem (NXOpen::CoordinateSystem *userCsys)
 Sets the user specified coordinate system. More...
 
double SpaceFactor ()
 Returns the space factor. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the Annotations::StyleBuilder for the annotation. More...
 
NXOpen::CoordinateSystemUserCoordinateSystem ()
 Returns the user specified coordinate system. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

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 NXOpen::Weld::WeldManager::CreateWeldPmiBuilder
Default values.

Property Value

PlaneType

ModelView

SpaceFactor

1.0


Created in NX9.0.0.

Member Enumeration Documentation

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
planeTypeplanetype
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
spaceFactorspacefactor
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
userCsysusercsys
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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.