NXOpen::Weld::JointmarkGuideBuilder Class Reference

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

Inheritance diagram for NXOpen::Weld::JointmarkGuideBuilder:

Public Types
enum	Location { LocationCenterLine, LocationOffsetFromEdge, LocationExistingCurve }
	The type of guide curve. More...
enum	SpaceMethod { SpaceMethodArcLength, SpaceMethodParallelXPlane, SpaceMethodParallelYPlane, SpaceMethodParallelZPlane }
	Options for Spacing Method. More...
enum	SpaceOption { SpaceOptionDistance, SpaceOptionNumber }
	Spacing Option. More...

Public Member Functions
void	CreateGuideCurves (std::vector< NXOpen::ICurve * > &curves, std::vector< NXOpen::NXObject * > &instanceCurves)
	Creates the guide curve and returns the created curves.
NXOpen::GeometricUtilities::OnPathDimensionBuilder *	EndDistance ()
	Returns the end distance.
bool	ExtendOffset ()
	Returns the extend offset.
NXOpen::Section *	GuideCurve ()
	Returns the guide curve.
NXOpen::Weld::JointmarkGuideBuilder::Location	LocationOption ()
	Returns the location option.
int	NumberOfPoints ()
	Returns the number to determine the points along the guide curve.
NXOpen::Expression *	OffsetDistance ()
	Returns the offset distance.
bool	ReverseDirection ()
	Returns the reversal status of Guide Curve direction.
NXOpen::Section *	Section1 ()
	Returns the first section used in Centerline.
NXOpen::Section *	Section2 ()
	Returns the second section used in Centerline.
NXOpen::Section *	Section3 ()
	Returns the third section used in Offset from Edge.
NXOpen::Section *	Section4 ()
	Returns the fourth section used in Existing Curve.
void	SetExtendOffset (bool extendOffset)
	Sets the extend offset.
void	SetGuideCurve (NXOpen::Section *guide)
	Sets the guide curve.
void	SetLocationOption (NXOpen::Weld::JointmarkGuideBuilder::Location locationOption)
	Sets the location option.
void	SetNumberOfPoints (int number)
	Sets the number to determine the points along the guide curve.
void	SetReverseDirection (bool reverse)
	Sets the reversal status of Guide Curve direction.
void	SetSpacingMethod (NXOpen::Weld::JointmarkGuideBuilder::SpaceMethod spacingMethod)
	Sets the spacing method.
void	SetSpacingOption (NXOpen::Weld::JointmarkGuideBuilder::SpaceOption spacingOption)
	Sets the spacing option.
NXOpen::Expression *	Spacing ()
	Returns the spacing to determine the points along the guide curve.
NXOpen::Weld::JointmarkGuideBuilder::SpaceMethod	SpacingMethod ()
	Returns the spacing method.
NXOpen::Weld::JointmarkGuideBuilder::SpaceOption	SpacingOption ()
	Returns the spacing option.
NXOpen::GeometricUtilities::OnPathDimensionBuilder *	StartDistance ()
	Returns the start distance.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Used to create or edit a guide curve for Jointmark.

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

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Weld::JointmarkGuideBuilder::Location

The type of guide curve.

Enumerator:

LocationCenterLine	Centerline.
LocationOffsetFromEdge	Offset from Edge.
LocationExistingCurve	Existing Curve.

enum NXOpen::Weld::JointmarkGuideBuilder::SpaceMethod

Options for Spacing Method.

Enumerator:

SpaceMethodArcLength	Arc Length.
SpaceMethodParallelXPlane	Parallel X Plane.
SpaceMethodParallelYPlane	Parallel Y Plane.
SpaceMethodParallelZPlane	Parallel Z Plane.

enum NXOpen::Weld::JointmarkGuideBuilder::SpaceOption

Spacing Option.

Enumerator:

SpaceOptionDistance	Distance.
SpaceOptionNumber	Number.

Member Function Documentation

void NXOpen::Weld::JointmarkGuideBuilder::CreateGuideCurves	(	std::vector< NXOpen::ICurve * > &	curves,
		std::vector< NXOpen::NXObject * > &	instanceCurves
	)

Creates the guide curve and returns the created curves.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

curves	The array of curves.
instanceCurves	The array of component curve instances. If there is not an assembly, then this will match the prototype curve.

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Weld::JointmarkGuideBuilder::EndDistance

(

)

Returns the end distance.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

bool NXOpen::Weld::JointmarkGuideBuilder::ExtendOffset

(

)

Returns the extend offset.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Section* NXOpen::Weld::JointmarkGuideBuilder::GuideCurve

(

)

Returns the guide curve.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Weld::JointmarkGuideBuilder::Location NXOpen::Weld::JointmarkGuideBuilder::LocationOption

(

)

Returns the location option.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

int NXOpen::Weld::JointmarkGuideBuilder::NumberOfPoints

(

)

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

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Expression* NXOpen::Weld::JointmarkGuideBuilder::OffsetDistance

(

)

Returns the offset distance.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

bool NXOpen::Weld::JointmarkGuideBuilder::ReverseDirection

(

)

Returns the reversal status of Guide Curve direction.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Section* NXOpen::Weld::JointmarkGuideBuilder::Section1

(

)

Returns the first section used in Centerline.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Section* NXOpen::Weld::JointmarkGuideBuilder::Section2

(

)

Returns the second section used in Centerline.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Section* NXOpen::Weld::JointmarkGuideBuilder::Section3

(

)

Returns the third section used in Offset from Edge.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Section* NXOpen::Weld::JointmarkGuideBuilder::Section4

(

)

Returns the fourth section used in Existing Curve.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

void NXOpen::Weld::JointmarkGuideBuilder::SetExtendOffset

(

bool

extendOffset

)

Sets the extend offset.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

extendOffset

extendoffset

void NXOpen::Weld::JointmarkGuideBuilder::SetGuideCurve

(

NXOpen::Section *

guide

)

Sets the guide curve.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

guide

guide

void NXOpen::Weld::JointmarkGuideBuilder::SetLocationOption

(

NXOpen::Weld::JointmarkGuideBuilder::Location

locationOption

)

Sets the location option.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

locationOption

locationoption

void NXOpen::Weld::JointmarkGuideBuilder::SetNumberOfPoints

(

int

number

)

Sets the number to determine the points along the guide curve.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

number

number

void NXOpen::Weld::JointmarkGuideBuilder::SetReverseDirection

(

bool

reverse

)

Sets the reversal status of Guide Curve direction.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

reverse

reverse

void NXOpen::Weld::JointmarkGuideBuilder::SetSpacingMethod

(

NXOpen::Weld::JointmarkGuideBuilder::SpaceMethod

spacingMethod

)

Sets the spacing method.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

spacingMethod

spacingmethod

void NXOpen::Weld::JointmarkGuideBuilder::SetSpacingOption

(

NXOpen::Weld::JointmarkGuideBuilder::SpaceOption

spacingOption

)

Sets the spacing option.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

Parameters

spacingOption

spacingoption

NXOpen::Expression* NXOpen::Weld::JointmarkGuideBuilder::Spacing

(

)

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

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Weld::JointmarkGuideBuilder::SpaceMethod NXOpen::Weld::JointmarkGuideBuilder::SpacingMethod

(

)

Returns the spacing method.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::Weld::JointmarkGuideBuilder::SpaceOption NXOpen::Weld::JointmarkGuideBuilder::SpacingOption

(

)

Returns the spacing option.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Weld::JointmarkGuideBuilder::StartDistance

(

)

Returns the start distance.

Created in NX9.0.0.

License requirements : ugweld ("UG WELD")

virtual bool NXOpen::Weld::JointmarkGuideBuilder::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.

---

The documentation for this class was generated from the following file:

• Weld_JointmarkGuideBuilder.hxx