FormToolBuilder Class¶

class NXOpen.CAM.FormToolBuilder¶

Bases: NXOpen.CAM.TurningToolBuilder

Represents a Form tool builder

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

New in version NX5.0.0.

Properties¶

Property	Description
ChannelName	Returns or sets the channel’s name
CutterExportBuilder	Returns the cutter export builder
CycleEvent	Returns the cycle event
CycleTable	Returns the cycle
Description	Returns or sets the description
EndUdeSet	Returns the end ude set
FormEdges	Returns the Form Edges Builder
HolderAngleBuilder	Returns the holder angle builder (inheritable double)
HolderDescription	Returns or sets the holder description
HolderLengthBuilder	Returns the turn holder length builder (inheritable double)
HolderLibraryReference	Returns or sets the holder libref
HolderLock	Returns or sets the lock turn holder toggle
HolderShankLineBuilder	Returns the turn holder shank line builder (inheritable double)
HolderShankType	Returns or sets the turn holder shank type
HolderShankWidthBuilder	Returns the turn holder shank width builder (inheritable double)
HolderUse	Returns or sets the use turn holder toggle
HolderWidthBuilder	Returns the turn holder width builder (inheritable double)
InsertLengthBuilder	Returns the insert length builder (inheritable double)
InsertPosition	Returns or sets the insert position
InsertWidthBuilder	Returns the insert width builder (inheritable double)
LeftAngleBuilder	Returns the left angle builder (inheritable double)
LibraryParametersBuilder	Returns the Library Data Object
ManageToolPartBuilder	Returns the manage tool part builder
MaxDepthBuilder	Returns the max.
MaxDepthToggle	Returns or sets the max.
MaxFacingDiameterBuilder	Returns the max.
MaxFacingDiameterToggle	Returns or sets the max.
MaxToolReachBuilder	Returns the max.
MaxToolReachToggle	Returns or sets the max.
McsSpindleGroup	Returns or sets the MCS spindle group
MinBoringDiameterBuilder	Returns the min.
MinBoringDiameterToggle	Returns or sets the min.
MinFacingDiameterBuilder	Returns the min.
MinFacingDiameterToggle	Returns or sets the min.
NoseRadiusBuilder	Returns the nose radius builder (inheritable double)
NoseWidthBuilder	Returns the nose width builder (inheritable double)
OptimizationMethod	Returns or sets the optim method
OrientAngleBuilder	Returns the orient angle builder (inheritable double)
RightAngleBuilder	Returns the right angle builder (inheritable double)
StartUdeSet	Returns the start ude set
Tag	Returns the Tag for this object.
ThicknessBuilder	Returns the thickness builder (inheritable double)
TlCtlgNum	Returns or sets the Catalog Number
TlDescription	Returns or sets the Cutter Description
TlHolderNumberBuilder	Returns the Holder Number
TlLibref	Returns or sets the Cutter Libref
TlManualToolChange	Returns or sets the Manual Tool Change
TlNumberBuilder	Returns the Tool Number
TlText	Returns or sets the tool text
TrackingBuilder	Returns the tracking point builder
XMountBuilder	Returns the x mount builder (inheritable double)
YMountBuilder	Returns the y mount builder (inheritable double)

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
GetMaterial	Get tool material
GetMaterialData	Get material data
GetObject	Returns the object currently being edited by this builder.
SetMaterial	Set tool material
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¶

FormEdges¶

FormToolBuilder.FormEdges¶

Returns the Form Edges Builder

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

Getter Method

Signature FormEdges

Returns:	The Form Edges builder
Return type:	`NXOpen.CAM.FormEdgesBuilder`

New in version NX6.0.0.

License requirements: None.

Method Detail¶

Validate¶

FormToolBuilder.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.