NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Annotations::LineWeldBuilder Class Reference

Represents a NXOpen::Annotations::LineWeldBuilder
To create a new instance of this class, use NXOpen::Annotations::WeldCollection::CreateLineWeldBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::LineWeldBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::PmiLineWeldBuilder

Public Types

enum  FieldWeldType { FieldWeldTypePlain, FieldWeldTypeTopField, FieldWeldTypeTopFieldSimpleFlag }
 Represents the field weld type. More...
 
enum  IdLineType {
  IdLineTypePlain, IdLineTypeIdLineAbove, IdLineTypeIdLineBelow, IdLineTypeCenteredSpotWeld,
  IdLineTypeCenteredSeamWeld, IdLineTypeCentered
}
 Represents the id line type. More...
 
enum  StaggeredWeldType { StaggeredWeldTypeNoStaggeredSymbol, StaggeredWeldTypeStaggeredSymbol, StaggeredWeldTypeStaggeredSymbolWeldSide }
 Represents the staggered weld type. More...
 
enum  TailType { TailTypeNoTail, TailTypeTail, TailTypeBox }
 represents the tail type More...
 
enum  WeldSymbolWeldAlongContourType {
  WeldSymbolWeldAlongContourTypeNone, WeldSymbolWeldAlongContourTypeClosed, WeldSymbolWeldAlongContourTypeUnclosed, WeldSymbolWeldAlongContourTypeTrilateralWeld,
  WeldSymbolWeldAlongContourTypeAllAround
}
 Represents the weld along contour option. More...
 

Public Member Functions

NXOpen::Annotations::LineWeldDataBuilderArrowSideWeldData ()
 Returns the NXOpen::Annotations::LineWeldDataBuilder for the arrow side of the weld symbol
Created in NX6.0.0. More...
 
NXOpen::Annotations::LineWeldBuilder::FieldWeldType FieldWeld ()
 Returns the field indicating the weld is done at the field site
Created in NX6.0.0. More...
 
bool FlipDirection ()
 Returns the flip direction for top seam
Created in NX6.0.0. More...
 
bool FlipHorizontal ()
 Returns the flip horizontal direction for side seam
Created in NX6.0.0. More...
 
bool FlipVertical ()
 Returns the flip vertical direction for side seam
Created in NX6.0.0. More...
 
NXOpen::Annotations::ForeshorteningSymbolBuilderForeshorteningSymbol ()
 Returns the foreshortening symbol builder
Created in NX10.0.0. More...
 
std::vector< NXStringGetReference ()
 Returns the reference or specification text. More...
 
NXOpen::Annotations::LineWeldBuilder::IdLineType IdLine ()
 Returns the identification or reference line
Created in NX6.0.0. More...
 
NXOpen::SelectDisplayableObjectInherit ()
 Returns the weld symbol from which the style properties are inherited
Created in NX6.0.0. More...
 
void InheritProperties (NXOpen::Annotations::Weld *annotation)
 This inherits the properties from the existing weld symbol
Created in NX8.0.0. More...
 
void InheritPropertiesFromWeldFeature (NXOpen::DisplayableObject *feature)
 This inherits the properties from the existing weld feature
Created in NX8.0.0. More...
 
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the NXOpen::Annotations::LeaderBuilder for weld symbol
Created in NX6.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the NXOpen::Annotations::OriginBuilder for the weld symbol
Created in NX6.0.0. More...
 
NXOpen::Annotations::LineWeldDataBuilderOtherSideWeldData ()
 Returns the NXOpen::Annotations::LineWeldDataBuilder for the other side of the weld symbol
Created in NX6.0.0. More...
 
double Scale ()
 Returns the scaling factor for the welding symbol
Created in NX6.0.0. More...
 
void SetFieldWeld (NXOpen::Annotations::LineWeldBuilder::FieldWeldType fieldWeld)
 Sets the field indicating the weld is done at the field site
Created in NX6.0.0. More...
 
void SetFlipDirection (bool flipDirection)
 Sets the flip direction for top seam
Created in NX6.0.0. More...
 
void SetFlipHorizontal (bool flipHorizontal)
 Sets the flip horizontal direction for side seam
Created in NX6.0.0. More...
 
void SetFlipVertical (bool flipVertical)
 Sets the flip vertical direction for side seam
Created in NX6.0.0. More...
 
void SetIdLine (NXOpen::Annotations::LineWeldBuilder::IdLineType idLine)
 Sets the identification or reference line
Created in NX6.0.0. More...
 
void SetReference (const std::vector< NXString > &reference)
 Sets the reference or specification text
Created in NX6.0.0. More...
 
void SetScale (double scale)
 Sets the scaling factor for the welding symbol
Created in NX6.0.0. More...
 
void SetSpaceFactor (double spaceFactor)
 Sets the space factor for the welding symbol
Created in NX7.0.0. More...
 
void SetStaggeredWeld (NXOpen::Annotations::LineWeldBuilder::StaggeredWeldType staggeredWeld)
 Sets the staggered weld
Created in NX6.0.0. More...
 
void SetTail (NXOpen::Annotations::LineWeldBuilder::TailType tail)
 Sets the weld tail
Created in NX6.0.0. More...
 
void SetWeldAlongContour (NXOpen::Annotations::LineWeldBuilder::WeldSymbolWeldAlongContourType alongContour)
 Sets the weld along contour option
Created in NX6.0.0. More...
 
NXOpen::SelectDisplayableObjectListSideSeamObjects ()
 Returns the side seam object
Created in NX6.0.0. More...
 
double SpaceFactor ()
 Returns the space factor for the welding symbol
Created in NX7.0.0. More...
 
NXOpen::Annotations::LineWeldBuilder::StaggeredWeldType StaggeredWeld ()
 Returns the staggered weld
Created in NX6.0.0. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the NXOpen::Annotations::StyleBuilder for the weld symbol
Created in NX6.0.0. More...
 
NXOpen::Annotations::LineWeldBuilder::TailType Tail ()
 Returns the weld tail
Created in NX6.0.0. More...
 
NXOpen::SelectDisplayableObjectTopSeamObject ()
 Returns the top seam object
Created in NX6.0.0. More...
 
NXOpen::Annotations::LineWeldBuilder::WeldSymbolWeldAlongContourType WeldAlongContour ()
 Returns the weld along contour option
Created in NX6.0.0. 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

Represents a NXOpen::Annotations::LineWeldBuilder
To create a new instance of this class, use NXOpen::Annotations::WeldCollection::CreateLineWeldBuilder
Default values.

Property Value

ArrowSideWeldData.ContourSymbol

None

ArrowSideWeldData.FinishSymbol

None

ArrowSideWeldData.WeldSizeCode

None

ArrowSideWeldData.WeldSymbol

None

FieldWeld

Plain

FlipDirection

False

FlipHorizontal

False

FlipVertical

False

IdLine

Plain

Scale

1

StaggeredWeld

NoStaggeredSymbol

Tail

NoTail

WeldAlongContour

None


Created in NX6.0.0.

Member Enumeration Documentation

Represents the field weld type.

Enumerator
FieldWeldTypePlain 

plain

FieldWeldTypeTopField 

top field

FieldWeldTypeTopFieldSimpleFlag 

top field simple flag

Represents the id line type.

Enumerator
IdLineTypePlain 

plain

IdLineTypeIdLineAbove 

id line above

IdLineTypeIdLineBelow 

id line below

IdLineTypeCenteredSpotWeld 

centered spot weld

IdLineTypeCenteredSeamWeld 

centered seam weld

IdLineTypeCentered 

centered

Represents the staggered weld type.

Enumerator
StaggeredWeldTypeNoStaggeredSymbol 

no staggered symbol

StaggeredWeldTypeStaggeredSymbol 

staggered symbol

StaggeredWeldTypeStaggeredSymbolWeldSide 

staggered symbol weld side

represents the tail type

Enumerator
TailTypeNoTail 

no tail

TailTypeTail 

tail

TailTypeBox 

box

Represents the weld along contour option.

Enumerator
WeldSymbolWeldAlongContourTypeNone 

none

WeldSymbolWeldAlongContourTypeClosed 

closed

WeldSymbolWeldAlongContourTypeUnclosed 

unclosed

WeldSymbolWeldAlongContourTypeTrilateralWeld 

trilateral weld

WeldSymbolWeldAlongContourTypeAllAround 

all around

Member Function Documentation

NXOpen::Annotations::LineWeldDataBuilder* NXOpen::Annotations::LineWeldBuilder::ArrowSideWeldData ( )

Returns the NXOpen::Annotations::LineWeldDataBuilder for the arrow side of the weld symbol
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::LineWeldBuilder::FieldWeldType NXOpen::Annotations::LineWeldBuilder::FieldWeld ( )

Returns the field indicating the weld is done at the field site
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::LineWeldBuilder::FlipDirection ( )

Returns the flip direction for top seam
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::LineWeldBuilder::FlipHorizontal ( )

Returns the flip horizontal direction for side seam
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::LineWeldBuilder::FlipVertical ( )

Returns the flip vertical direction for side seam
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::ForeshorteningSymbolBuilder* NXOpen::Annotations::LineWeldBuilder::ForeshorteningSymbol ( )

Returns the foreshortening symbol builder
Created in NX10.0.0.



License requirements : None

std::vector<NXString> NXOpen::Annotations::LineWeldBuilder::GetReference ( )

Returns the reference or specification text.

Returns

Created in NX6.0.0.

License requirements : None
NXOpen::Annotations::LineWeldBuilder::IdLineType NXOpen::Annotations::LineWeldBuilder::IdLine ( )

Returns the identification or reference line
Created in NX6.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::LineWeldBuilder::Inherit ( )

Returns the weld symbol from which the style properties are inherited
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::LineWeldBuilder::InheritProperties ( NXOpen::Annotations::Weld annotation)

This inherits the properties from the existing weld symbol
Created in NX8.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
annotationannotation
void NXOpen::Annotations::LineWeldBuilder::InheritPropertiesFromWeldFeature ( NXOpen::DisplayableObject feature)

This inherits the properties from the existing weld feature
Created in NX8.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
featurefeature
NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::LineWeldBuilder::Leader ( )

Returns the NXOpen::Annotations::LeaderBuilder for weld symbol
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::LineWeldBuilder::Origin ( )

Returns the NXOpen::Annotations::OriginBuilder for the weld symbol
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::LineWeldDataBuilder* NXOpen::Annotations::LineWeldBuilder::OtherSideWeldData ( )

Returns the NXOpen::Annotations::LineWeldDataBuilder for the other side of the weld symbol
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::LineWeldBuilder::Scale ( )

Returns the scaling factor for the welding symbol
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::LineWeldBuilder::SetFieldWeld ( NXOpen::Annotations::LineWeldBuilder::FieldWeldType  fieldWeld)

Sets the field indicating the weld is done at the field site
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
fieldWeldfieldweld
void NXOpen::Annotations::LineWeldBuilder::SetFlipDirection ( bool  flipDirection)

Sets the flip direction for top seam
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
flipDirectionflipdirection
void NXOpen::Annotations::LineWeldBuilder::SetFlipHorizontal ( bool  flipHorizontal)

Sets the flip horizontal direction for side seam
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
flipHorizontalfliphorizontal
void NXOpen::Annotations::LineWeldBuilder::SetFlipVertical ( bool  flipVertical)

Sets the flip vertical direction for side seam
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
flipVerticalflipvertical
void NXOpen::Annotations::LineWeldBuilder::SetIdLine ( NXOpen::Annotations::LineWeldBuilder::IdLineType  idLine)

Sets the identification or reference line
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
idLineid line
void NXOpen::Annotations::LineWeldBuilder::SetReference ( const std::vector< NXString > &  reference)

Sets the reference or specification text
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
referencereference
void NXOpen::Annotations::LineWeldBuilder::SetScale ( double  scale)

Sets the scaling factor for the welding symbol
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
scalescale
void NXOpen::Annotations::LineWeldBuilder::SetSpaceFactor ( double  spaceFactor)

Sets the space factor for the welding symbol
Created in NX7.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
spaceFactorspacefactor
void NXOpen::Annotations::LineWeldBuilder::SetStaggeredWeld ( NXOpen::Annotations::LineWeldBuilder::StaggeredWeldType  staggeredWeld)

Sets the staggered weld
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
staggeredWeldstaggeredweld
void NXOpen::Annotations::LineWeldBuilder::SetTail ( NXOpen::Annotations::LineWeldBuilder::TailType  tail)

Sets the weld tail
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
tailtail
void NXOpen::Annotations::LineWeldBuilder::SetWeldAlongContour ( NXOpen::Annotations::LineWeldBuilder::WeldSymbolWeldAlongContourType  alongContour)

Sets the weld along contour option
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
alongContouralongcontour
NXOpen::SelectDisplayableObjectList* NXOpen::Annotations::LineWeldBuilder::SideSeamObjects ( )

Returns the side seam object
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::LineWeldBuilder::SpaceFactor ( )

Returns the space factor for the welding symbol
Created in NX7.0.0.



License requirements : None

NXOpen::Annotations::LineWeldBuilder::StaggeredWeldType NXOpen::Annotations::LineWeldBuilder::StaggeredWeld ( )

Returns the staggered weld
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::LineWeldBuilder::Style ( )

Returns the NXOpen::Annotations::StyleBuilder for the weld symbol
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::LineWeldBuilder::TailType NXOpen::Annotations::LineWeldBuilder::Tail ( )

Returns the weld tail
Created in NX6.0.0.



License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::LineWeldBuilder::TopSeamObject ( )

Returns the top seam object
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::LineWeldBuilder::WeldSymbolWeldAlongContourType NXOpen::Annotations::LineWeldBuilder::WeldAlongContour ( )

Returns the weld along contour option
Created in NX6.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.