NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Weld::WeldJointBuilder Class Reference

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

Inheritance diagram for NXOpen::Weld::WeldJointBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Weld::JointExitBuilder

List of all members.

Public Types

enum  DestinationTypes { DestinationTypesWorkPart, DestinationTypesNewComponent }
 Where to create new joints. More...
enum  SplitTypes {
  SplitTypesEqualSegments, SplitTypesLimits, SplitTypesAngle, SplitTypesComputedAngle,
  SplitTypesLength
}
 Joint splitting options. More...
enum  Types { TypesCreateAutomatic, TypesCreateManual, TypesCreateMultiple, TypesCreateAttributes }
 Creation method. More...
enum  WeldTypes { WeldTypesAny, WeldTypesGroove, WeldTypesFillet }
 Weld types. More...

Public Member Functions

int ButtColor ()
 Returns the color for butt weld type joints
Created in NX8.0.0.
NXOpen::DisplayableObject::ObjectFont ButtFont ()
 Returns the curve font for butt weld type joints
Created in NX8.0.0.
NXOpen::DisplayableObject::ObjectWidth ButtWidth ()
 Returns the curve with for butt weld type joints
Created in NX8.0.0.
NXOpen::CurveCreateLimitsPath (NXOpen::Curve *jointCurve)
 Creates the path to be used for the limits.
NXOpen::Weld::WeldJointBuilder::Types CreateMethod ()
 Returns the creation method
Created in NX8.0.0.
void CreateSingleJointFromFeature (NXOpen::Curve *featureCurve, bool updateBuilder)
 Creates a joint from a feature.
void Delete ()
 Deletes all joints set by Weld::WeldJointBuilder::Joint .
NXOpen::Weld::WeldJointBuilder::DestinationTypes Destination ()
 Returns the destination to create new joints
Created in NX8.0.0.
bool DuplicateCheck ()
 Returns the indication to not allow new joints to be created if they are duplicates of exising joints
Created in NX8.0.0.
int FilletColor ()
 Returns the color for fillet weld type joints
Created in NX8.0.0.
NXOpen::DisplayableObject::ObjectFont FilletFont ()
 Returns the curve font for fillet weld type joints
Created in NX8.0.0.
NXOpen::DisplayableObject::ObjectWidth FilletWidth ()
 Returns the curve with for fillet weld type joints
Created in NX8.0.0.
double GetAngleBetween ()
 Gets the angle between the fillet weld mold faces, and the target faces, or butt weld primary and secondary faces.
bool GetIsLongPoint ()
 Gets the long point status.
bool GetJointChanged (NXOpen::Curve *curve)
 Indicates whether joint was changed.
NXOpen::Die::DieLimitsBuilderGetJointLimits (NXOpen::Curve *curve)
 Get the limits of an individual joint.
void GetNewlyCreatedJoints (std::vector< NXOpen::Curve * > &curves, std::vector< NXOpen::Weld::JointItemBuilder * > &newItemBuilder)
 Gets the Weld::JointItemBuilder objects and curves which were just created by Weld::WeldJointBuilder::ShowJoints .
double GetPrimaryThickness (NXOpen::Curve *curve)
 Gets the primary thickness for a specified joint.
double GetSecondaryThickness (NXOpen::Curve *curve)
 Gets the primary secondary for a specified joint.
NXOpen::Weld::JointItemBuilderGetSingleJoint (NXOpen::Curve *curve)
 Gets the Weld::JointItemBuilder object associated to the input curve.
NXOpen::SelectCurveListJoint ()
 Returns the welding joint curves.
NXOpen::Weld::JointItemBuilderListJointList ()
 Returns the list of joints.
NXOpen::Die::DieLimitsBuilderListLimitList ()
 Returns the list of limit builders.
NXOpen::Die::DieLimitsBuilderLimits ()
 Returns the limits of the joint curve span.
NXOpen::ScCollectorMasterEdge ()
 Returns the master edge of a fillet weld.
NXOpen::Weld::JointItemBuilderNewItem ()
 Creates a Weld::JointItemBuilder object.
int NumberSegments ()
 Returns the number of segments to divide a joint when using Weld::WeldJointBuilder::SplitTypesEqualSegments .
NXOpen::ScCollectorPlacementFace ()
 Returns the placement face of a fillet weld.
NXOpen::ScCollectorPrimaryEdge ()
 Returns the primary edge of a butt weld.
NXOpen::ScCollectorPrimaryFace ()
 Returns the primary face of a butt weld.
NXOpen::ScCollectorSecondaryEdge ()
 Returns the secondary edge of a butt weld.
NXOpen::ScCollectorSecondaryFace ()
 Returns the secondary face of a butt weld.
void SetButtColor (int color)
 Sets the color for butt weld type joints
Created in NX8.0.0.
void SetButtFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the curve font for butt weld type joints
Created in NX8.0.0.
void SetButtWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the curve with for butt weld type joints
Created in NX8.0.0.
void SetCreateMethod (NXOpen::Weld::WeldJointBuilder::Types type)
 Sets the creation method
Created in NX8.0.0.
void SetDestination (NXOpen::Weld::WeldJointBuilder::DestinationTypes type)
 Sets the destination to create new joints
Created in NX8.0.0.
void SetDuplicateCheck (bool status)
 Sets the indication to not allow new joints to be created if they are duplicates of exising joints
Created in NX8.0.0.
void SetFilletColor (int color)
 Sets the color for fillet weld type joints
Created in NX8.0.0.
void SetFilletFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the curve font for fillet weld type joints
Created in NX8.0.0.
void SetFilletWidth (NXOpen::DisplayableObject::ObjectWidth width)
 Sets the curve with for fillet weld type joints
Created in NX8.0.0.
void SetJointChanged (NXOpen::Curve *curve, bool changed)
 Indicate that joint was changed.
void SetNumberSegments (int numberSegments)
 Sets the number of segments to divide a joint when using Weld::WeldJointBuilder::SplitTypesEqualSegments .
void SetSplitAngle (double angle)
 Sets the split angle to divide a joint when using Weld::WeldJointBuilder::SplitTypesAngle .
void SetSplitLength (double length)
 Sets the split length to divide a joint when using Weld::WeldJointBuilder::SplitTypesLength .
void SetSplitOption (NXOpen::Weld::WeldJointBuilder::SplitTypes option)
 Sets the method used to split the joint
Created in NX8.0.0.
void SetType (NXOpen::Weld::WeldJointBuilder::Types type)
 Sets the creation type
Created in NX8.0.0.
void SetVariableBevelAngles (const std::vector< double > &variableAngles)
 This method is for use with the variable bevel callback.
void SetWeldType (NXOpen::Weld::WeldJointBuilder::WeldTypes type)
 Sets the weld type
Created in NX8.0.0.
NXOpen::SelectBodyListShipComponent ()
 Returns the components on which the welding joints will be created.
void ShowJoints ()
 Show joints will create joints using the method set by Weld::WeldJointBuilder::Types .
void Split ()
 Splits all joints set by Weld::WeldJointBuilder::Joint defined by Weld::WeldJointBuilder::SplitTypes .
double SplitAngle ()
 Returns the split angle to divide a joint when using Weld::WeldJointBuilder::SplitTypesAngle .
double SplitLength ()
 Returns the split length to divide a joint when using Weld::WeldJointBuilder::SplitTypesLength .
NXOpen::Weld::WeldJointBuilder::SplitTypes SplitOption ()
 Returns the method used to split the joint
Created in NX8.0.0.
NXOpen::ScCollectorTargetFace ()
 Returns the target face of a fillet weld.
NXOpen::Weld::WeldJointBuilder::Types Type ()
 Returns the creation type
Created in NX8.0.0.
void UpdateCollectors (NXOpen::Curve *jointCurve)
 Updates the main collectors by copying data from Joint.
void UpdateJointAfterLimitsChange ()
 Updates the joint curve after the limits change.
void UpdateJointAfterLimitsChange (NXOpen::Die::DieLimitsBuilder *limits)
 Updates the joint curve after the limits change.
NXOpen::Weld::CharacteristicsBuilderWeldingCharacteristics ()
 Returns the collection of welding characteristics defined by attributes.
NXOpen::Weld::WeldJointBuilder::WeldTypes WeldType ()
 Returns the weld type
Created in NX8.0.0.

Detailed Description

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


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

Property Value

NumberSegments

2

SplitAngle

5.0


Created in NX8.0.0.


Member Enumeration Documentation

Where to create new joints.

Enumerator:
DestinationTypesWorkPart 

Create new joints in work part.

DestinationTypesNewComponent 

Create a new componenent for each joint under the work part.

Joint splitting options.

Enumerator:
SplitTypesEqualSegments 

Specified number of equal segments.

SplitTypesLimits 

At limits defined by Weld::WeldJointBuilder::LimitList .

SplitTypesAngle 

At specifed angle.

SplitTypesComputedAngle 

At angle computed from geometry and tables.

SplitTypesLength 

At equal arc length.

Creation method.

Enumerator:
TypesCreateAutomatic 

Automatic weld joint creation.

TypesCreateManual 

Manual weld joint creation.

TypesCreateMultiple 

Create multiple weld joints from manual input.

TypesCreateAttributes 

Create weld joints from attributed ship structures data.

Weld types.

Enumerator:
WeldTypesAny 

Any Weld type.

WeldTypesGroove 

Groove weld.

WeldTypesFillet 

Fillet weld.


Member Function Documentation

Returns the color for butt weld type joints
Created in NX8.0.0.



License requirements : None

Returns the curve font for butt weld type joints
Created in NX8.0.0.



License requirements : None

Returns the curve with for butt weld type joints
Created in NX8.0.0.



License requirements : None

Creates the path to be used for the limits.

Returns:
Resulting path.
Created in NX8.0.0.

License requirements : None
Parameters:
jointCurveJoint curve used to create path.

Returns the creation method
Created in NX8.0.0.



License requirements : None

void NXOpen::Weld::WeldJointBuilder::CreateSingleJointFromFeature ( NXOpen::Curve featureCurve,
bool  updateBuilder 
)

Creates a joint from a feature.


Created in NX8.0.0.

License requirements : None

Parameters:
featureCurveWeld Joint feature curve
updateBuilderindicates where builder should be updated with information from the feature

Deletes all joints set by Weld::WeldJointBuilder::Joint .


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Returns the destination to create new joints
Created in NX8.0.0.



License requirements : None

Returns the indication to not allow new joints to be created if they are duplicates of exising joints
Created in NX8.0.0.



License requirements : None

Returns the color for fillet weld type joints
Created in NX8.0.0.



License requirements : None

Returns the curve font for fillet weld type joints
Created in NX8.0.0.



License requirements : None

Returns the curve with for fillet weld type joints
Created in NX8.0.0.



License requirements : None

Gets the angle between the fillet weld mold faces, and the target faces, or butt weld primary and secondary faces.

Returns:

Created in NX8.0.0.

License requirements : None

Gets the long point status.

A long point indicates only trimming and no extension is needed to to meeting the body being welded to.

Returns:

Created in NX8.0.0.

License requirements : None

Indicates whether joint was changed.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
curveJoint curve to check

Get the limits of an individual joint.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
curvecurve
void NXOpen::Weld::WeldJointBuilder::GetNewlyCreatedJoints ( std::vector< NXOpen::Curve * > &  curves,
std::vector< NXOpen::Weld::JointItemBuilder * > &  newItemBuilder 
)

Gets the Weld::JointItemBuilder objects and curves which were just created by Weld::WeldJointBuilder::ShowJoints .


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
curvescurves
newItemBuildernewitembuilder

Gets the primary thickness for a specified joint.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
curvecurve

Gets the primary secondary for a specified joint.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
curvecurve

Gets the Weld::JointItemBuilder object associated to the input curve.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
curveJoint curve

Returns the welding joint curves.


Created in NX8.0.0.

License requirements : None

Returns the list of joints.


Created in NX8.0.0.

License requirements : None

Returns the list of limit builders.


Created in NX8.0.0.

License requirements : None

Returns the limits of the joint curve span.


Created in NX8.0.0.

License requirements : None

Returns the master edge of a fillet weld.


Created in NX8.0.0.

License requirements : None

Creates a Weld::JointItemBuilder object.

Returns:

Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Returns the number of segments to divide a joint when using Weld::WeldJointBuilder::SplitTypesEqualSegments .


Created in NX8.0.0.

License requirements : None

Returns the placement face of a fillet weld.

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

License requirements : None

Returns the primary edge of a butt weld.


Created in NX8.0.0.

License requirements : None

Returns the primary face of a butt weld.


Created in NX8.0.0.

License requirements : None

Returns the secondary edge of a butt weld.


Created in NX8.0.0.

License requirements : None

Returns the secondary face of a butt weld.


Created in NX8.0.0.

License requirements : None

Sets the color for butt weld type joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
colorcolor

Sets the curve font for butt weld type joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
fontfont

Sets the curve with for butt weld type joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
widthwidth

Sets the creation method
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
typetype

Sets the destination to create new joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
typetype

Sets the indication to not allow new joints to be created if they are duplicates of exising joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
statusstatus

Sets the color for fillet weld type joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
colorcolor

Sets the curve font for fillet weld type joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
fontfont

Sets the curve with for fillet weld type joints
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
widthwidth
void NXOpen::Weld::WeldJointBuilder::SetJointChanged ( NXOpen::Curve curve,
bool  changed 
)

Indicate that joint was changed.


Created in NX8.0.0.

License requirements : None

Parameters:
curveJoint curve to check
changedchanged

Sets the number of segments to divide a joint when using Weld::WeldJointBuilder::SplitTypesEqualSegments .


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
numberSegmentsnumbersegments

Sets the split angle to divide a joint when using Weld::WeldJointBuilder::SplitTypesAngle .


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
angleangle

Sets the split length to divide a joint when using Weld::WeldJointBuilder::SplitTypesLength .


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
lengthlength

Sets the method used to split the joint
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
optionoption

Sets the creation type
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
typetype
void NXOpen::Weld::WeldJointBuilder::SetVariableBevelAngles ( const std::vector< double > &  variableAngles)

This method is for use with the variable bevel callback.


Created in NX8.0.0.

License requirements : None

Parameters:
variableAnglesthe variable angles.

Sets the weld type
Created in NX8.0.0.



License requirements : structure_weld ("STRUCTURE WELD")

Parameters:
typetype

Returns the components on which the welding joints will be created.

Used when Weld::WeldJointBuilder::Types . is set to Weld::WeldJointBuilder::TypesCreateAutomatic or Weld::WeldJointBuilder::TypesCreateAttributes After setting the components, Weld::WeldJointBuilder::ShowJoints should be called to create the welding joints.
Created in NX8.0.0.

License requirements : None

Splits all joints set by Weld::WeldJointBuilder::Joint defined by Weld::WeldJointBuilder::SplitTypes .


Created in NX8.0.0.

License requirements : structure_weld ("STRUCTURE WELD")

Returns the split angle to divide a joint when using Weld::WeldJointBuilder::SplitTypesAngle .


Created in NX8.0.0.

License requirements : None

Returns the split length to divide a joint when using Weld::WeldJointBuilder::SplitTypesLength .


Created in NX8.0.0.

License requirements : None

Returns the method used to split the joint
Created in NX8.0.0.



License requirements : None

Returns the target face of a fillet weld.

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

License requirements : None

Returns the creation type
Created in NX8.0.0.



License requirements : None

Updates the main collectors by copying data from Joint.


Created in NX8.0.0.

License requirements : None

Parameters:
jointCurveJoint curve to use to update collectors

Updates the joint curve after the limits change.


Created in NX8.0.0.

License requirements : None

Updates the joint curve after the limits change.


Created in NX8.0.0.

License requirements : None

Parameters:
limitslimits that changed

Returns the collection of welding characteristics defined by attributes.


Created in NX8.0.0.

License requirements : None

Returns the weld type
Created in NX8.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.