NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Weld.JointmarkGuideBuilder Class Reference

Used to create or edit a guide curve for Jointmark. More...

Inheritance diagram for NXOpen.Weld.JointmarkGuideBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Location { CenterLine, OffsetFromEdge, ExistingCurve }
 The type of guide curve More...
 
enum  SpaceMethod { ArcLength, ParallelXPlane, ParallelYPlane, ParallelZPlane }
 Options for Spacing Method More...
 
enum  SpaceOption { Distance, Number, MinimumDistance }
 Spacing Option More...
 

Public Member Functions

unsafe void CreateGuideCurves ()
 Creates the guide curves. More...
 
unsafe void GetGuideCurves (out NXOpen.ICurve[] guideCurves, out NXOpen.NXObject[] instanceGuideCurves)
 Gets the created curves curves. More...
 
unsafe void RediscoverGuideEnds ()
 Use the specified reuse features to set the start and end distance for the guide curve. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.GeometricUtilities.OnPathDimensionBuilder 
EndDistance [get]
 Returns the end distance. More...
 
unsafe bool ExtendOffset [get, set]
 Returns or sets the extend offset. More...
 
unsafe NXOpen.Section GuideCurve [get, set]
 Returns or sets the guide curve. More...
 
unsafe
NXOpen.Weld.JointmarkGuideBuilder.Location 
LocationOption [get, set]
 Returns or sets the location option. More...
 
unsafe int NumberOfPoints [get, set]
 Returns or sets the number to determine the points along the guide curve. More...
 
unsafe NXOpen.Expression OffsetDistance [get]
 Returns the offset distance. More...
 
unsafe bool RespacePoints [get, set]
 Returns or sets the option to control whether new points should be added when the feature is edited. More...
 
unsafe bool ReverseDirection [get, set]
 Returns or sets the reversal status of Guide Curve direction. More...
 
unsafe NXOpen.Section Section1 [get]
 Returns the first section used in Centerline. More...
 
unsafe NXOpen.Section Section2 [get]
 Returns the second section used in Centerline. More...
 
unsafe NXOpen.Section Section3 [get]
 Returns the third section used in Offset from Edge. More...
 
unsafe NXOpen.Section Section4 [get]
 Returns the fourth section used in Existing Curve. More...
 
unsafe NXOpen.Expression Spacing [get]
 Returns the spacing to determine the points along the guide curve. More...
 
unsafe
NXOpen.Weld.JointmarkGuideBuilder.SpaceMethod 
SpacingMethod [get, set]
 Returns or sets the spacing method. More...
 
unsafe
NXOpen.Weld.JointmarkGuideBuilder.SpaceOption 
SpacingOption [get, set]
 Returns or sets the spacing option. More...
 
unsafe
NXOpen.GeometricUtilities.OnPathDimensionBuilder 
StartDistance [get]
 Returns the start distance. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Used to create or edit a guide curve for Jointmark.

To create a new instance of this class, use NXOpen.Weld.JointmarkBuilder.NewGuide

Created in NX9.0.0

Member Enumeration Documentation

The type of guide curve

Enumerator
CenterLine 

Centerline

OffsetFromEdge 

Offset from Edge

ExistingCurve 

Existing Curve

Options for Spacing Method

Enumerator
ArcLength 

Arc Length

ParallelXPlane 

Parallel X Plane

ParallelYPlane 

Parallel Y Plane

ParallelZPlane 

Parallel Z Plane

Spacing Option

Enumerator
Distance 

Space points by a fixed distance.

Spacing at last point may not be uniform.

Number 

Uniformly space a number of points.

MinimumDistance 

Uniformly space points using a minimum distance value.

Member Function Documentation

unsafe void NXOpen.Weld.JointmarkGuideBuilder.CreateGuideCurves ( )
inline

Creates the guide curves.

Created in NX9.0.1

License requirements: ugweld ("UG WELD")

unsafe void NXOpen.Weld.JointmarkGuideBuilder.GetGuideCurves ( out NXOpen.ICurve[]  guideCurves,
out NXOpen.NXObject[]  instanceGuideCurves 
)
inline

Gets the created curves curves.

The guide curves need to exist before calling this, or nothing will be returned.

Created in NX9.0.1

License requirements: ugweld ("UG WELD")

Parameters
guideCurvesThe array of curves.
instanceGuideCurvesThe array of component curve instances. If there is not an assembly, then this will match the prototype curve.
unsafe void NXOpen.Weld.JointmarkGuideBuilder.RediscoverGuideEnds ( )
inline

Use the specified reuse features to set the start and end distance for the guide curve.

Created in NX11.0.1

License requirements: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.JointmarkGuideBuilder.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.GeometricUtilities.OnPathDimensionBuilder NXOpen.Weld.JointmarkGuideBuilder.EndDistance
get

Returns the end distance.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.JointmarkGuideBuilder.ExtendOffset
getset

Returns or sets the extend offset.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Section NXOpen.Weld.JointmarkGuideBuilder.GuideCurve
getset

Returns or sets the guide curve.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Weld.JointmarkGuideBuilder.Location NXOpen.Weld.JointmarkGuideBuilder.LocationOption
getset

Returns or sets the location option.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe int NXOpen.Weld.JointmarkGuideBuilder.NumberOfPoints
getset

Returns or sets the number to determine the points along the guide curve.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Expression NXOpen.Weld.JointmarkGuideBuilder.OffsetDistance
get

Returns the offset distance.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.JointmarkGuideBuilder.RespacePoints
getset

Returns or sets the option to control whether new points should be added when the feature is edited.

If true new points can to be added, otherwise no new points will be added.

Created in NX1847.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe bool NXOpen.Weld.JointmarkGuideBuilder.ReverseDirection
getset

Returns or sets the reversal status of Guide Curve direction.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Section NXOpen.Weld.JointmarkGuideBuilder.Section1
get

Returns the first section used in Centerline.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe NXOpen.Section NXOpen.Weld.JointmarkGuideBuilder.Section2
get

Returns the second section used in Centerline.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe NXOpen.Section NXOpen.Weld.JointmarkGuideBuilder.Section3
get

Returns the third section used in Offset from Edge.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe NXOpen.Section NXOpen.Weld.JointmarkGuideBuilder.Section4
get

Returns the fourth section used in Existing Curve.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe NXOpen.Expression NXOpen.Weld.JointmarkGuideBuilder.Spacing
get

Returns the spacing to determine the points along the guide curve.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")

unsafe NXOpen.Weld.JointmarkGuideBuilder.SpaceMethod NXOpen.Weld.JointmarkGuideBuilder.SpacingMethod
getset

Returns or sets the spacing method.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.Weld.JointmarkGuideBuilder.SpaceOption NXOpen.Weld.JointmarkGuideBuilder.SpacingOption
getset

Returns or sets the spacing option.

Created in NX9.0.0

License requirements to get this property: ugweld ("UG WELD")

License requirements to set this property: ugweld ("UG WELD")

unsafe NXOpen.GeometricUtilities.OnPathDimensionBuilder NXOpen.Weld.JointmarkGuideBuilder.StartDistance
get

Returns the start distance.

Created in NX9.0.0

License requirements: ugweld ("UG WELD")


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