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

Represents the easy pattern builder. More...

Inheritance diagram for NXOpen::Weld::EasyPatternBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  HemMethodTypes { HemMethodTypesMidPoint, HemMethodTypesNormalToBody }
 Indicates the method to use to compute the hem vector location. More...
 
enum  PlaneMethodTypes { PlaneMethodTypesInferPlanes, PlaneMethodTypesParallelXCPlanes, PlaneMethodTypesParallelYCPlanes, PlaneMethodTypesParallelZCPlanes }
 The plane to cut sections in to determine placement measurement patterns. More...
 
enum  SpacingMethodTypes { SpacingMethodTypesGrid, SpacingMethodTypesSinglePlane }
 Indicates whether planes should be cut a grid lines, or if a single plane should be used. More...
 
enum  Types { TypesTrimAndSurface, TypesHemAndSurface }
 Controls the type of pattern. More...
 

Public Member Functions

double BackEdgeOffset ()
 Returns the back edge offset. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
double GridAngleTolerance ()
 Returns the grid angle tolerance. More...
 
double GridIncrement ()
 Returns the grid increment. More...
 
double Height ()
 Returns the height of the measurement solid to create. More...
 
NXOpen::Weld::EasyPatternBuilder::HemMethodTypes HemMethod ()
 Returns the hem method. More...
 
double LengthAndWidth ()
 Returns the length and width of the measurement solid to create. More...
 
double MaximumSpacing ()
 Returns the maximum spacing between the trim edge offset and the back edge offset. More...
 
double MinimumFlangeWidth ()
 Returns the value used to control when only one surface measurement vector will be created. More...
 
int NumberSurfaceVectors ()
 Returns the number surface vectors to create for each pattern. More...
 
NXOpen::SectionPatternPath ()
 Returns the pattern path. More...
 
double PlaneLocation ()
 Returns the plane location. More...
 
NXOpen::Weld::EasyPatternBuilder::PlaneMethodTypes PlaneMethod ()
 Returns the plane method. More...
 
bool ReverseDirection ()
 Returns the reverse direction. More...
 
void SetBackEdgeOffset (double backEdgeOffset)
 Sets the back edge offset. More...
 
void SetDistanceTolerance (double tolerance)
 Sets the distance tolerance. More...
 
void SetGridAngleTolerance (double gridAngleTolerance)
 Sets the grid angle tolerance. More...
 
void SetGridIncrement (double gridIncrement)
 Sets the grid increment. More...
 
void SetHeight (double height)
 Sets the height of the measurement solid to create. More...
 
void SetHemMethod (NXOpen::Weld::EasyPatternBuilder::HemMethodTypes hemMethod)
 Sets the hem method. More...
 
void SetLengthAndWidth (double lengthAndWidth)
 Sets the length and width of the measurement solid to create. More...
 
void SetMaximumSpacing (double maximumSpacing)
 Sets the maximum spacing between the trim edge offset and the back edge offset. More...
 
void SetMinimumFlangeWidth (double minimumFlangeWidth)
 Sets the value used to control when only one surface measurement vector will be created. More...
 
void SetNumberSurfaceVectors (int numberSurfaceVectors)
 Sets the number surface vectors to create for each pattern. More...
 
void SetPlaneLocation (double planeLocation)
 Sets the plane location. More...
 
void SetPlaneMethod (NXOpen::Weld::EasyPatternBuilder::PlaneMethodTypes planeMethod)
 Sets the plane method. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the reverse direction. More...
 
void SetSpacingMethod (NXOpen::Weld::EasyPatternBuilder::SpacingMethodTypes spacingMethod)
 Sets the spacing method. More...
 
void SetTrimEdgeOffset (double trimEdgeOffset)
 Sets the trim edge offset distance. More...
 
void SetType (NXOpen::Weld::EasyPatternBuilder::Types type)
 Sets the type of pattern to created. More...
 
NXOpen::Weld::EasyPatternBuilder::SpacingMethodTypes SpacingMethod ()
 Returns the spacing method. More...
 
NXOpen::ScCollectorSurfaceVectorFace ()
 Returns the surface vector face. More...
 
double TrimEdgeOffset ()
 Returns the trim edge offset distance. More...
 
NXOpen::Weld::EasyPatternBuilder::Types Type ()
 Returns the type of pattern to created. 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 the easy pattern builder.

This is used to create hem, trim and surface measurement points at various plane locations.
To create a new instance of this class, use NXOpen::Weld::WeldManager::CreateEasyPatternBuilder
Default values.

Property Value

BackEdgeOffset

2 (millimeters part), 0.08 (inches part)

GridAngleTolerance

15

GridIncrement

25 (millimeters part), 1.0 (inches part)

Height

25 (millimeters part), 1.0 (inches part)

HemMethod

MidPoint

LengthAndWidth

5 (millimeters part), 0.02 (inches part)

MaximumSpacing

20 (millimeters part), 0.8 (inches part)

MinimumFlangeWidth

6.0 (millimeters part), 0.25 (inches part)

NumberSurfaceVectors

1

PlaneLocation

0

PlaneMethod

InferPlanes

SpacingMethod

Grid

TrimEdgeOffset

2 (millimeters part), 0.08 (inches part)


Created in NX7.5.0.

Member Enumeration Documentation

Indicates the method to use to compute the hem vector location.

Enumerator
HemMethodTypesMidPoint 

Use the mid point of a section cut.

HemMethodTypesNormalToBody 

Use Normal to Body Method.

The plane to cut sections in to determine placement measurement patterns.

Enumerator
PlaneMethodTypesInferPlanes 

Determine the best XC,YC, or ZC plane.

PlaneMethodTypesParallelXCPlanes 

Patterns are on the XC plane.

PlaneMethodTypesParallelYCPlanes 

Patterns are on the YC plane.

PlaneMethodTypesParallelZCPlanes 

Patterns are on the ZC plane.

Indicates whether planes should be cut a grid lines, or if a single plane should be used.

Enumerator
SpacingMethodTypesGrid 

Use Grid spacing to cut sections.

SpacingMethodTypesSinglePlane 

Use a single plane to cut a sections.

Controls the type of pattern.

Enumerator
TypesTrimAndSurface 

Trim vector and surface vectors.

TypesHemAndSurface 

Hem vector and surface vectors.

Member Function Documentation

double NXOpen::Weld::EasyPatternBuilder::BackEdgeOffset ( )

Returns the back edge offset.

This offset distance is measured from the end of the section cut curve. The start of the curve is at path curve specified.
Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::DistanceTolerance ( )

Returns the distance tolerance.


Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::GridAngleTolerance ( )

Returns the grid angle tolerance.

This is used for the inferred grid spacing method.
Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::GridIncrement ( )

Returns the grid increment.

The grid spacing value use to generate planes.
Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::Height ( )

Returns the height of the measurement solid to create.


Created in NX7.5.0.

License requirements : None

NXOpen::Weld::EasyPatternBuilder::HemMethodTypes NXOpen::Weld::EasyPatternBuilder::HemMethod ( )

Returns the hem method.

This controls the method used for determining the hem point location and vector direction.
Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::LengthAndWidth ( )

Returns the length and width of the measurement solid to create.


Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::MaximumSpacing ( )

Returns the maximum spacing between the trim edge offset and the back edge offset.


Created in NX7.5.5.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::MinimumFlangeWidth ( )

Returns the value used to control when only one surface measurement vector will be created.


Created in NX7.5.1.

License requirements : None

int NXOpen::Weld::EasyPatternBuilder::NumberSurfaceVectors ( )

Returns the number surface vectors to create for each pattern.


Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::Weld::EasyPatternBuilder::PatternPath ( )

Returns the pattern path.

This path is used to determine the pattern spacing.
Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::PlaneLocation ( )

Returns the plane location.

The single plane location to create a pattern.
Created in NX7.5.0.

License requirements : None

NXOpen::Weld::EasyPatternBuilder::PlaneMethodTypes NXOpen::Weld::EasyPatternBuilder::PlaneMethod ( )

Returns the plane method.

This is used to control plane orientations for the measurement points.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Weld::EasyPatternBuilder::ReverseDirection ( )

Returns the reverse direction.

This will reverse direction of all measurement points created.
Created in NX7.5.0.

License requirements : None

void NXOpen::Weld::EasyPatternBuilder::SetBackEdgeOffset ( double  backEdgeOffset)

Sets the back edge offset.

This offset distance is measured from the end of the section cut curve. The start of the curve is at path curve specified.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
backEdgeOffsetbackedgeoffset
void NXOpen::Weld::EasyPatternBuilder::SetDistanceTolerance ( double  tolerance)

Sets the distance tolerance.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
tolerancetolerance
void NXOpen::Weld::EasyPatternBuilder::SetGridAngleTolerance ( double  gridAngleTolerance)

Sets the grid angle tolerance.

This is used for the inferred grid spacing method.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
gridAngleTolerancegridangletolerance
void NXOpen::Weld::EasyPatternBuilder::SetGridIncrement ( double  gridIncrement)

Sets the grid increment.

The grid spacing value use to generate planes.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
gridIncrementgridincrement
void NXOpen::Weld::EasyPatternBuilder::SetHeight ( double  height)

Sets the height of the measurement solid to create.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
heightheight
void NXOpen::Weld::EasyPatternBuilder::SetHemMethod ( NXOpen::Weld::EasyPatternBuilder::HemMethodTypes  hemMethod)

Sets the hem method.

This controls the method used for determining the hem point location and vector direction.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
hemMethodhemmethod
void NXOpen::Weld::EasyPatternBuilder::SetLengthAndWidth ( double  lengthAndWidth)

Sets the length and width of the measurement solid to create.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
lengthAndWidthlengthandwidth
void NXOpen::Weld::EasyPatternBuilder::SetMaximumSpacing ( double  maximumSpacing)

Sets the maximum spacing between the trim edge offset and the back edge offset.


Created in NX7.5.5.

License requirements : ugweld ("UG WELD")

Parameters
maximumSpacingmaximumspacing
void NXOpen::Weld::EasyPatternBuilder::SetMinimumFlangeWidth ( double  minimumFlangeWidth)

Sets the value used to control when only one surface measurement vector will be created.


Created in NX7.5.1.

License requirements : ugweld ("UG WELD")

Parameters
minimumFlangeWidthminimumflangewidth
void NXOpen::Weld::EasyPatternBuilder::SetNumberSurfaceVectors ( int  numberSurfaceVectors)

Sets the number surface vectors to create for each pattern.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
numberSurfaceVectorsnumbersurfacevectors
void NXOpen::Weld::EasyPatternBuilder::SetPlaneLocation ( double  planeLocation)

Sets the plane location.

The single plane location to create a pattern.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
planeLocationplanelocation
void NXOpen::Weld::EasyPatternBuilder::SetPlaneMethod ( NXOpen::Weld::EasyPatternBuilder::PlaneMethodTypes  planeMethod)

Sets the plane method.

This is used to control plane orientations for the measurement points.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
planeMethodplanemethod
void NXOpen::Weld::EasyPatternBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the reverse direction.

This will reverse direction of all measurement points created.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
reverseDirectionreversedirection
void NXOpen::Weld::EasyPatternBuilder::SetSpacingMethod ( NXOpen::Weld::EasyPatternBuilder::SpacingMethodTypes  spacingMethod)

Sets the spacing method.

This method controls whether multiple patterns are created or a single pattern.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
spacingMethodspacingmethod
void NXOpen::Weld::EasyPatternBuilder::SetTrimEdgeOffset ( double  trimEdgeOffset)

Sets the trim edge offset distance.

This is the offset distance from the path specified.
Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
trimEdgeOffsettrimedgeoffset
void NXOpen::Weld::EasyPatternBuilder::SetType ( NXOpen::Weld::EasyPatternBuilder::Types  type)

Sets the type of pattern to created.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
typetype
NXOpen::Weld::EasyPatternBuilder::SpacingMethodTypes NXOpen::Weld::EasyPatternBuilder::SpacingMethod ( )

Returns the spacing method.

This method controls whether multiple patterns are created or a single pattern.
Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Weld::EasyPatternBuilder::SurfaceVectorFace ( )

Returns the surface vector face.

This is the face surface vectors will be created on.
Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::EasyPatternBuilder::TrimEdgeOffset ( )

Returns the trim edge offset distance.

This is the offset distance from the path specified.
Created in NX7.5.0.

License requirements : None

NXOpen::Weld::EasyPatternBuilder::Types NXOpen::Weld::EasyPatternBuilder::Type ( )

Returns the type of pattern to created.


Created in NX7.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.