NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Weld::JointItemBuilder Class Reference

Used to create or edit a Weld::WeldJoint feature. More...

Inheritance diagram for NXOpen::Weld::JointItemBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::ScCollectorBackingFace ()
 Returns the backing face. More...
 
NXOpen::CurveCurve ()
 Returns the joint curve
Created in NX8.5.0. More...
 
void DeleteCurve ()
 Deletes the joint curve from the builder. More...
 
double GetPortEngagement ()
 Returns the engagement distance of the parent port of the pipe joint. More...
 
NXOpen::Die::DieLimitsBuilderLimits ()
 Returns the limits of the joint curve span. More...
 
NXOpen::ScCollectorMasterEdge ()
 Returns the master edge of a T-joint weld. More...
 
NXOpen::ScCollectorPlacementFace ()
 Returns the placement face of a T-joint weld. More...
 
NXOpen::ScCollectorPrimaryEdge ()
 Returns the primary edge of a butt weld. More...
 
NXOpen::ScCollectorPrimaryFace ()
 Returns the primary face of a butt weld. More...
 
NXOpen::Weld::EdgePrepValuesBuilderReadEdgePrepValues ()
 Read edge prep values set by the user plugin function. More...
 
NXOpen::Routing::SelectPortRoutingObject ()
 Returns the routing port. More...
 
void SaveEdgePrepValues (NXOpen::Weld::EdgePrepValuesBuilder *valuesBuilder)
 Save edge prep values to the Welding Joint. More...
 
NXOpen::ScCollectorSecondaryEdge ()
 Returns the secondary edge of a butt weld. More...
 
NXOpen::ScCollectorSecondaryFace ()
 Returns the secondary face of a butt weld. More...
 
void SetCallbackMessage (const NXString &message)
 Sets a message to display after callback processing ends
Created in NX11.0.2. More...
 
void SetCallbackMessage (const char *message)
 Sets a message to display after callback processing ends
Created in NX11.0.2. More...
 
void SetUseCallbackValues (bool status)
 Sets the indication to use the values of the callback to define the joint
Created in NX8.0.0. More...
 
void SetWeldType (int type)
 Sets the weld type
Created in NX8.5.0. More...
 
NXOpen::ScCollectorTargetFace ()
 Returns the target face of a T-joint weld. More...
 
bool UseCallbackValues ()
 Returns the indication to use the values of the callback to define the joint
Created in NX8.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::Weld::CharacteristicsBuilderWeldingCharacteristics ()
 Returns the collection of welding characteristics defined by attributes. More...
 
int WeldType ()
 Returns the weld type
Created in NX8.5.0. 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 Weld::WeldJoint feature.


To create a new instance of this class, use NXOpen::Weld::WeldJointBuilder::NewItem

Created in NX8.0.0.

Member Function Documentation

NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::BackingFace ( )

Returns the backing face.


Created in NX9.0.0.

License requirements : None

NXOpen::Curve* NXOpen::Weld::JointItemBuilder::Curve ( )

Returns the joint curve
Created in NX8.5.0.



License requirements : None

void NXOpen::Weld::JointItemBuilder::DeleteCurve ( )

Deletes the joint curve from the builder.


Created in NX8.0.0.

License requirements : None

double NXOpen::Weld::JointItemBuilder::GetPortEngagement ( )

Returns the engagement distance of the parent port of the pipe joint.

Returns
Engagement distance
Created in NX10.0.3.

License requirements : None
NXOpen::Die::DieLimitsBuilder* NXOpen::Weld::JointItemBuilder::Limits ( )

Returns the limits of the joint curve span.


Created in NX8.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::MasterEdge ( )

Returns the master edge of a T-joint weld.


Created in NX8.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::PlacementFace ( )

Returns the placement face of a T-joint weld.

For example, on a profile it is the face that touches the plate.
Created in NX8.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::PrimaryEdge ( )

Returns the primary edge of a butt weld.


Created in NX8.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::PrimaryFace ( )

Returns the primary face of a butt weld.


Created in NX8.0.0.

License requirements : None

NXOpen::Weld::EdgePrepValuesBuilder* NXOpen::Weld::JointItemBuilder::ReadEdgePrepValues ( )

Read edge prep values set by the user plugin function.

Returns

Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")
NXOpen::Routing::SelectPort* NXOpen::Weld::JointItemBuilder::RoutingObject ( )

Returns the routing port.


Created in NX10.0.0.

License requirements : None

void NXOpen::Weld::JointItemBuilder::SaveEdgePrepValues ( NXOpen::Weld::EdgePrepValuesBuilder valuesBuilder)

Save edge prep values to the Welding Joint.


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Parameters
valuesBuildervaluesbuilder
NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::SecondaryEdge ( )

Returns the secondary edge of a butt weld.


Created in NX8.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::SecondaryFace ( )

Returns the secondary face of a butt weld.


Created in NX8.0.0.

License requirements : None

void NXOpen::Weld::JointItemBuilder::SetCallbackMessage ( const NXString message)

Sets a message to display after callback processing ends
Created in NX11.0.2.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters
messageMessage to display to user
void NXOpen::Weld::JointItemBuilder::SetCallbackMessage ( const char *  message)

Sets a message to display after callback processing ends
Created in NX11.0.2.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters
messageMessage to display to user
void NXOpen::Weld::JointItemBuilder::SetUseCallbackValues ( bool  status)

Sets the indication to use the values of the callback to define the joint
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters
statusstatus
void NXOpen::Weld::JointItemBuilder::SetWeldType ( int  type)

Sets the weld type
Created in NX8.5.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters
typetype
NXOpen::ScCollector* NXOpen::Weld::JointItemBuilder::TargetFace ( )

Returns the target face of a T-joint weld.

For example, the plate face that the profile lies on.
Created in NX8.0.0.

License requirements : None

bool NXOpen::Weld::JointItemBuilder::UseCallbackValues ( )

Returns the indication to use the values of the callback to define the joint
Created in NX8.0.0.



License requirements : None

virtual bool NXOpen::Weld::JointItemBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXOpen::Weld::CharacteristicsBuilder* NXOpen::Weld::JointItemBuilder::WeldingCharacteristics ( )

Returns the collection of welding characteristics defined by attributes.


Created in NX8.0.0.

License requirements : None

int NXOpen::Weld::JointItemBuilder::WeldType ( )

Returns the weld type
Created in NX8.5.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.