WedmBasedGeomBuilder Class¶

class NXOpen.CAM.WedmBasedGeomBuilder¶

Bases: NXOpen.CAM.ParamBuilder

Represents a WedmBasedGeom Builder

To create a new instance of this class, use NXOpen.CAM.NCGroupCollection.CreateWedmBasedGeomBuilder()

New in version NX5.0.0.

Properties¶

Property	Description
BackburnPasses	Returns or sets the Backburn Passes
CustomBoundaryDataList	Returns the Custom Boundary Data List
CutDirection	Returns or sets the Cut Direction
CutoffDistance	Returns or sets the Cutoff Distance
CutoffFlag	Returns or sets the Cutoff Flag
CutoffStock	Returns or sets the Cutoff Stock
CycleEvent	Returns the cycle event
CycleTable	Returns the cycle
FinishPasses	Returns or sets the Finish Passes
FromPoint	Returns or sets the From Point
FromPointStatus	Returns or sets the From Point Status
FromPointToolAxis	Returns or sets the From Point Tool Axis
GoHomePoint	Returns or sets the Go Home Point
GoHomePointStatus	Returns or sets the Go Home Point Status
GoHomePointToolAxis	Returns or sets the Go Home Point Tool Axis
Intol	Returns or sets the intol value
LayoutCiBuilder	Returns the Save Layer/Layout builder
LeadInPoint	Returns or sets the Lead In Point
LeadInPointStatus	Returns or sets the Lead In Point Status
LeadOutPointStatus	Returns or sets the Lead Out Point Status
LowerPlane	Returns or sets the Lower Plane
NumTabs	Returns or sets the Tab Points
OptimizationMethod	Returns or sets the optim method
Outtol	Returns or sets the outtol value
RegionMethod	Returns or sets the Tab Points Region Method
RetractPoint	Returns or sets the Retract Point
RetractPointStatus	Returns or sets the Retract Point Status
RetractPointToolAxis	Returns or sets the Retract Point Tool Axis
RoughPasses	Returns or sets the Rough Passes
SmoothLeadinDistance	Returns or sets the Smooth Leadin Distance
SmoothLeadinFlag	Returns or sets the Smooth Leadin Flag
SmoothLeadoutDistance	Returns or sets the Smooth Leadout Distance
SmoothLeadoutFlag	Returns or sets the Smooth Leadout Flag
StepoverBuilder	Returns the Stepover builder
StopPointDistance	Returns or sets the Stop Point Distance
StopPointFlag	Returns or sets the Stop Point Flag
StopPointType	Returns or sets the Stop Point Type
Tag	Returns the Tag for this object.
ThreadHolePoint	Returns or sets the Thread Hole Point
ThreadHolePointStatus	Returns or sets the Thread Hole Point Status
ThreadHolePointToolAxis	Returns or sets the Thread Hole Point Tool Axis
UpperPlane	Returns or sets the Upper Plane
WireDiameter	Returns or sets the Wire Diameter

Methods¶

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetCustomizableItemBuilder	Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames	Returns the names for all customizable item ids
GetObject	Returns the object currently being edited by this builder.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail¶

BackburnPasses¶

WedmBasedGeomBuilder.BackburnPasses¶

Returns or sets the Backburn Passes

-------------------------------------

Getter Method

Signature BackburnPasses

Returns:	the Backburn Passes
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature BackburnPasses

Parameters:	backburnPasses (int) – the Backburn Passes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CustomBoundaryDataList¶

WedmBasedGeomBuilder.CustomBoundaryDataList¶

Returns the Custom Boundary Data List

-------------------------------------

Getter Method

Signature CustomBoundaryDataList

Returns:	the Custom Boundary Data
Return type:	`NXOpen.CAM.WedmCustomBoundaryDataBuilderList`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutDirection¶

WedmBasedGeomBuilder.CutDirection¶

Returns or sets the Cut Direction

-------------------------------------

Getter Method

Signature CutDirection

Returns:	the Cut Direction
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature CutDirection

Parameters:	cutDirection (int) – the Cut Direction

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

CutoffDistance¶

WedmBasedGeomBuilder.CutoffDistance¶

Returns or sets the Cutoff Distance

-------------------------------------

Getter Method

Signature CutoffDistance

Returns:	the Cutoff Distance
Return type:	float

New in version NX5.0.1.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature CutoffDistance

Parameters:	cutoffDistance (float) – the Cutoff Distance

New in version NX5.0.1.

License requirements: cam_base (“CAM BASE”)

CutoffFlag¶

WedmBasedGeomBuilder.CutoffFlag¶

Returns or sets the Cutoff Flag

-------------------------------------

Getter Method

Signature CutoffFlag

Returns:	the Cutoff Flag
Return type:	int

New in version NX5.0.1.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature CutoffFlag

Parameters:	cutoffFlag (int) – the Cutoff Flag

New in version NX5.0.1.

License requirements: cam_base (“CAM BASE”)

CutoffStock¶

WedmBasedGeomBuilder.CutoffStock¶

Returns or sets the Cutoff Stock

-------------------------------------

Getter Method

Signature CutoffStock

Returns:	the Cutoff Stock
Return type:	float

New in version NX5.0.1.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature CutoffStock

Parameters:	cutoffStock (float) – the Cutoff Stock

New in version NX5.0.1.

License requirements: cam_base (“CAM BASE”)

FinishPasses¶

WedmBasedGeomBuilder.FinishPasses¶

Returns or sets the Finish Passes

-------------------------------------

Getter Method

Signature FinishPasses

Returns:	the Finish Passes
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature FinishPasses

Parameters:	finishPasses (int) – the Finish Passes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

FromPoint¶

WedmBasedGeomBuilder.FromPoint¶

Returns or sets the From Point

-------------------------------------

Getter Method

Signature FromPoint

Returns:	the From Point
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature FromPoint

Parameters:	point (`NXOpen.NXObject`) – the From Point

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

FromPointStatus¶

WedmBasedGeomBuilder.FromPointStatus¶

Returns or sets the From Point Status

-------------------------------------

Getter Method

Signature FromPointStatus

Returns:	the From Point Status
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature FromPointStatus

Parameters:	status (int) – the From Point Status

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

FromPointToolAxis¶

WedmBasedGeomBuilder.FromPointToolAxis¶

Returns or sets the From Point Tool Axis

-------------------------------------

Getter Method

Signature FromPointToolAxis

Returns:	the From Point Tool Axis
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature FromPointToolAxis

Parameters:	toolAxis (`NXOpen.NXObject`) – the From Point Tool Axis

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GoHomePoint¶

WedmBasedGeomBuilder.GoHomePoint¶

Returns or sets the Go Home Point

-------------------------------------

Getter Method

Signature GoHomePoint

Returns:	the Go Home Point
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature GoHomePoint

Parameters:	point (`NXOpen.NXObject`) – the Go Home Point

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GoHomePointStatus¶

WedmBasedGeomBuilder.GoHomePointStatus¶

Returns or sets the Go Home Point Status

-------------------------------------

Getter Method

Signature GoHomePointStatus

Returns:	the Go Home Point Status
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature GoHomePointStatus

Parameters:	status (int) – the Go Home Point Status

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GoHomePointToolAxis¶

WedmBasedGeomBuilder.GoHomePointToolAxis¶

Returns or sets the Go Home Point Tool Axis

-------------------------------------

Getter Method

Signature GoHomePointToolAxis

Returns:	the Go Home Point Tool Axis
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature GoHomePointToolAxis

Parameters:	toolAxis (`NXOpen.NXObject`) – the Go Home Point Tool Axis

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Intol¶

WedmBasedGeomBuilder.Intol¶

Returns or sets the intol value

-------------------------------------

Getter Method

Signature Intol

Returns:	the intol value
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature Intol

Parameters:	intol (float) – the intol value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LayoutCiBuilder¶

WedmBasedGeomBuilder.LayoutCiBuilder¶

Returns the Save Layer/Layout builder

-------------------------------------

Getter Method

Signature LayoutCiBuilder

Returns:	the save layer/layout builder
Return type:	`NXOpen.CAM.LayoutCiBuilder`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LeadInPoint¶

WedmBasedGeomBuilder.LeadInPoint¶

Returns or sets the Lead In Point

-------------------------------------

Getter Method

Signature LeadInPoint

Returns:	the Lead In Point
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature LeadInPoint

Parameters:	point (`NXOpen.NXObject`) – the Lead In Point

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LeadInPointStatus¶

WedmBasedGeomBuilder.LeadInPointStatus¶

Returns or sets the Lead In Point Status

-------------------------------------

Getter Method

Signature LeadInPointStatus

Returns:	the Lead In Point Status
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature LeadInPointStatus

Parameters:	status (int) – the Lead In Point Status

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LeadOutPointStatus¶

WedmBasedGeomBuilder.LeadOutPointStatus¶

Returns or sets the Lead Out Point Status

-------------------------------------

Getter Method

Signature LeadOutPointStatus

Returns:	the Lead Out Point Status
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature LeadOutPointStatus

Parameters:	status (int) – the Lead Out Point Status

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

LowerPlane¶

WedmBasedGeomBuilder.LowerPlane¶

Returns or sets the Lower Plane

-------------------------------------

Getter Method

Signature LowerPlane

Returns:	the Lower Plane
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature LowerPlane

Parameters:	lowerPlane (float) – the Lower Plane

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

NumTabs¶

WedmBasedGeomBuilder.NumTabs¶

Returns or sets the Tab Points

-------------------------------------

Getter Method

Signature NumTabs

Returns:	the Num Tabs
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature NumTabs

Parameters:	numTabs (int) – the Num Tabs

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Outtol¶

WedmBasedGeomBuilder.Outtol¶

Returns or sets the outtol value

-------------------------------------

Getter Method

Signature Outtol

Returns:	the intol value
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature Outtol

Parameters:	outtol (float) – the intol value

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RegionMethod¶

WedmBasedGeomBuilder.RegionMethod¶

Returns or sets the Tab Points Region Method

-------------------------------------

Getter Method

Signature RegionMethod

Returns:	the Tab Points Region Method
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature RegionMethod

Parameters:	regionMethod (int) – the Tab Points Region Method

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RetractPoint¶

WedmBasedGeomBuilder.RetractPoint¶

Returns or sets the Retract Point

-------------------------------------

Getter Method

Signature RetractPoint

Returns:	the Retract Point
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature RetractPoint

Parameters:	point (`NXOpen.NXObject`) – the Retract Point

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RetractPointStatus¶

WedmBasedGeomBuilder.RetractPointStatus¶

Returns or sets the Retract Point Status

-------------------------------------

Getter Method

Signature RetractPointStatus

Returns:	the Retract Point Status
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature RetractPointStatus

Parameters:	status (int) – the Retract Point Status

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RetractPointToolAxis¶

WedmBasedGeomBuilder.RetractPointToolAxis¶

Returns or sets the Retract Point Tool Axis

-------------------------------------

Getter Method

Signature RetractPointToolAxis

Returns:	the Retract Point Tool Axis
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature RetractPointToolAxis

Parameters:	toolAxis (`NXOpen.NXObject`) – the Retract Point Tool Axis

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

RoughPasses¶

WedmBasedGeomBuilder.RoughPasses¶

Returns or sets the Rough Passes

-------------------------------------

Getter Method

Signature RoughPasses

Returns:	the Rough Passes
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature RoughPasses

Parameters:	roughPasses (int) – the Rough Passes

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SmoothLeadinDistance¶

WedmBasedGeomBuilder.SmoothLeadinDistance¶

Returns or sets the Smooth Leadin Distance

-------------------------------------

Getter Method

Signature SmoothLeadinDistance

Returns:	the Smooth Leadin Distance
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature SmoothLeadinDistance

Parameters:	leadInDistance (float) – the Smooth Leadin Distance

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SmoothLeadinFlag¶

WedmBasedGeomBuilder.SmoothLeadinFlag¶

Returns or sets the Smooth Leadin Flag

-------------------------------------

Getter Method

Signature SmoothLeadinFlag

Returns:	the Smooth Leadin Flag
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature SmoothLeadinFlag

Parameters:	leadInFlag (int) – the Smooth Leadin Flag

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SmoothLeadoutDistance¶

WedmBasedGeomBuilder.SmoothLeadoutDistance¶

Returns or sets the Smooth Leadout Distance

-------------------------------------

Getter Method

Signature SmoothLeadoutDistance

Returns:	the Smooth Leadout Distance
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature SmoothLeadoutDistance

Parameters:	leadOutDistance (float) – the Smooth Leadout Distance

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

SmoothLeadoutFlag¶

WedmBasedGeomBuilder.SmoothLeadoutFlag¶

Returns or sets the Smooth Leadout Flag

-------------------------------------

Getter Method

Signature SmoothLeadoutFlag

Returns:	the Smooth Leadout Flag
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature SmoothLeadoutFlag

Parameters:	leadOutFlag (int) – the Smooth Leadout Flag

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

StepoverBuilder¶

WedmBasedGeomBuilder.StepoverBuilder¶

Returns the Stepover builder

-------------------------------------

Getter Method

Signature StepoverBuilder

Returns:	the Stepover Builder
Return type:	`NXOpen.CAM.StepoverBuilder`

New in version NX6.0.0.

License requirements: None.

StopPointDistance¶

WedmBasedGeomBuilder.StopPointDistance¶

Returns or sets the Stop Point Distance

-------------------------------------

Getter Method

Signature StopPointDistance

Returns:	the Stop Point Distance
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature StopPointDistance

Parameters:	stopPointDistance (float) – the Stop Point Distance

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

StopPointFlag¶

WedmBasedGeomBuilder.StopPointFlag¶

Returns or sets the Stop Point Flag

-------------------------------------

Getter Method

Signature StopPointFlag

Returns:	the Stop Point Flag
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature StopPointFlag

Parameters:	stopPointFlag (int) – the Stop Point Flag

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

StopPointType¶

WedmBasedGeomBuilder.StopPointType¶

Returns or sets the Stop Point Type

-------------------------------------

Getter Method

Signature StopPointType

Returns:	the Stop Point Type
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature StopPointType

Parameters:	stopPointType (int) – the Stop Point Type

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ThreadHolePoint¶

WedmBasedGeomBuilder.ThreadHolePoint¶

Returns or sets the Thread Hole Point

-------------------------------------

Getter Method

Signature ThreadHolePoint

Returns:	the Thread Hole Point
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature ThreadHolePoint

Parameters:	point (`NXOpen.NXObject`) – the Thread Hole Point

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ThreadHolePointStatus¶

WedmBasedGeomBuilder.ThreadHolePointStatus¶

Returns or sets the Thread Hole Point Status

-------------------------------------

Getter Method

Signature ThreadHolePointStatus

Returns:	the Thread Hole Point Status
Return type:	int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature ThreadHolePointStatus

Parameters:	status (int) – the Thread Hole Point Status

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

ThreadHolePointToolAxis¶

WedmBasedGeomBuilder.ThreadHolePointToolAxis¶

Returns or sets the Thread Hole Point Tool Axis

-------------------------------------

Getter Method

Signature ThreadHolePointToolAxis

Returns:	the Thread Hole Point Tool Axis
Return type:	`NXOpen.NXObject`

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature ThreadHolePointToolAxis

Parameters:	toolAxis (`NXOpen.NXObject`) – the Thread Hole Point Tool Axis

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

UpperPlane¶

WedmBasedGeomBuilder.UpperPlane¶

Returns or sets the Upper Plane

-------------------------------------

Getter Method

Signature UpperPlane

Returns:	the Upper Plane
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature UpperPlane

Parameters:	upperPlane (float) – the Upper Plane

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

WireDiameter¶

WedmBasedGeomBuilder.WireDiameter¶

Returns or sets the Wire Diameter

-------------------------------------

Getter Method

Signature WireDiameter

Returns:	the Wire Diameter
Return type:	float

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Setter Method

Signature WireDiameter

Parameters:	wireDiameter (float) – the Wire Diameter

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail¶

Validate¶

WedmBasedGeomBuilder.Validate¶

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.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.