MachineToolConfiguration Class¶

class NXOpen.SIM.MachineToolConfiguration¶

Bases: NXOpen.Builder

Represents a Machine Tool Configuration object.

To create a new instance of this class, use NXOpen.SIM.KinematicConfigurator.CreateMachineToolConfigurationBuilder()

New in version NX9.0.3.

Properties¶

Property	Description
ControllerLine	Returns or sets the controller line
ControllerType	Returns or sets the controller type
CycleTime	Returns or sets the cycle time
MachineName	Returns or sets the machine name
MachineVendor	Returns or sets the machine vendor
Tag	Returns the Tag for this object.
ToolCarrierName	Returns or sets the tool carrier name

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.
GetArchiveControllerType	Retrieves the archive controller type
GetArchiveControllerVersion	Retrieves the archive controller version
GetChannelPlaneMill	Retrieves the plane mill from a channel
GetChannelPlaneTurn	Retrieves the plane turn from a channel
GetChannelSwiveling	Retrieves channel’s swiveling mode
GetChannelTcpmSupport	Retrieves machine TCPM support
GetChannelToolAsSubprogram	Retrieves a channel’s subprogram support
GetChannelToolCommand	Retrieves a channel’s tool command
GetChannelToolPreselect	Retrieves a channel’s tool preselect
GetCircularPrecision	Retrieves the circular precision
GetCircularPrecisionFactor	Retrieves the circular precision factor
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetControllerLanguage	Retrieves the controller language
GetControllerVersion	Retrieves the controller version
GetDiameterGeoAxisName	Retrieves the diameter geo axis name, which change the output behavior of length values during turning.
GetLookahead	Retrieves the controller lookahead, which indicates how many lines are evaluate from the controller ahead.
GetMachineTechnology	Retrieves the machine technology
GetMdynamics	Retrieve the MDynamics information
GetObject	Returns the object currently being edited by this builder.
GetResolutionDeg	Retrieves the degree resolution
GetResolutionMm	Retrieves the millimeter resolution
GetToolCarrierDirectionSelection	Retrieves the direction selection for a tool carrier.
GetToolCarrierRetraction	Retrieves the retraction for a tool carrier.
GetToolCarrierSwivelMode	Retrieves the swiveling mode for a tool carrier.
GetToolCarrierXRetractionPosition	Retrieves the X retraction position for a tool carrier.
GetToolCarrierYRetractionPosition	Retrieves the Y retraction position for a tool carrier.
GetToolCarrierZRetractionPosition	Retrieves the Z retraction position for a tool carrier.
GetToolRadiusCompensation	Retrieves the 3D Tool Radius Compensation information
GetUsedUnit	Retrieves the used unit
SetArchiveControllerType	Sets the archive controller type
SetArchiveControllerVersion	Sets the archive controller version
SetChannelPlaneMill	Sets the plane mill for a channel
SetChannelPlaneTurn	Sets the plane turn for a channel
SetChannelSwiveling	Sets the channel’s swiveling mode
SetChannelTcpmSupport	Sets the TCPM support value
SetChannelToolAsSubprogram	Sets a channel’s subprogram support
SetChannelToolCommand	Sets a channel’s tool command
SetChannelToolPreselect	Sets a channel’s tool preselect
SetCircularPrecision	Sets the circular precision
SetCircularPrecisionFactor	Sets the circular precision factor
SetControllerLanguage	Sets the controller language
SetControllerVersion	Sets the controller version
SetDiameterGeoAxisName	Sets the diameter geo axis name, which change the output behavior of length values during turning.
SetLookahead	Sets the controller lookahead, which indicates how many lines are evaluate from the controller ahead.
SetMachineTechnology	Sets the machine technology
SetMdynamics	Sets the Mdynamics value
SetResolutionDeg	Sets the degree resolution value
SetResolutionMm	Sets the millimeter resolution value
SetToolCarrierDirectionSelection	Sets the direction selection for a tool carrier.
SetToolCarrierRetraction	Sets the retraction for a tool carrier.
SetToolCarrierSwivelMode	Sets the swiveling mode for a tool carrier.
SetToolCarrierXRetractionPosition	Sets the X retraction position for a tool carrier.
SetToolCarrierYRetractionPosition	Sets the Y retraction position for a tool carrier.
SetToolCarrierZRetractionPosition	Sets the Z retraction position for a tool carrier.
SetToolRadiusCompensation	Sets the 3D Tool Radius Compensation information
SetUsedUnit	Sets the used unit
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.

Enumerations¶

MachineToolConfigurationControllerLines Enumeration	The controller line
MachineToolConfigurationMdynamicsTypes Enumeration	The mdynamics types
MachineToolConfigurationPlaneTypes Enumeration	The plane selection types
MachineToolConfigurationSwivelingTypes Enumeration	The machine swiveling types
MachineToolConfigurationTechnologyTypes Enumeration	The machine technology types
MachineToolConfigurationUnitTypes Enumeration	The units type

Property Detail¶

ControllerLine¶

MachineToolConfiguration.ControllerLine¶

Returns or sets the controller line

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

Getter Method

Signature ControllerLine

Returns:	The controller line
Return type:	`NXOpen.SIM.MachineToolConfigurationControllerLines`

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature ControllerLine

Parameters:	line (`NXOpen.SIM.MachineToolConfigurationControllerLines`) – The new controller line

New in version NX9.0.3.

License requirements: None.

ControllerType¶

MachineToolConfiguration.ControllerType¶

Returns or sets the controller type

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

Getter Method

Signature ControllerType

Returns:	The controller type
Return type:	str

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature ControllerType

Parameters:	controllerType (str) – The new controller type

New in version NX9.0.3.

License requirements: None.

CycleTime¶

MachineToolConfiguration.CycleTime¶

Returns or sets the cycle time

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

Getter Method

Signature CycleTime

Returns:	The cycle time
Return type:	float

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature CycleTime

Parameters:	cycleTime (float) – The new cycle time

New in version NX9.0.3.

License requirements: None.

MachineName¶

MachineToolConfiguration.MachineName¶

Returns or sets the machine name

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

Getter Method

Signature MachineName

Returns:	The machine name
Return type:	str

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature MachineName

Parameters:	name (str) – The new machine name

New in version NX9.0.3.

License requirements: None.

MachineVendor¶

MachineToolConfiguration.MachineVendor¶

Returns or sets the machine vendor

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

Getter Method

Signature MachineVendor

Returns:	The machine vendor
Return type:	str

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature MachineVendor

Parameters:	vendor (str) – The new machine vendor

New in version NX9.0.3.

License requirements: None.

ToolCarrierName¶

MachineToolConfiguration.ToolCarrierName¶

Returns or sets the tool carrier name

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

Getter Method

Signature ToolCarrierName

Returns:	The tool carrier name
Return type:	str

New in version NX9.0.3.

License requirements: None.

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

Setter Method

Signature ToolCarrierName

Parameters:	carrierName (str) – The new tool carrier name

New in version NX9.0.3.

License requirements: None.

Method Detail¶

GetArchiveControllerType¶

MachineToolConfiguration.GetArchiveControllerType¶

Retrieves the archive controller type

Signature GetArchiveControllerType()

Returns:	The archive controller type
Return type:	int

New in version NX10.0.3.

License requirements: None.

GetArchiveControllerVersion¶

MachineToolConfiguration.GetArchiveControllerVersion¶

Retrieves the archive controller version

Signature GetArchiveControllerVersion()

Returns:	The archive controller version
Return type:	str

New in version NX10.0.3.

License requirements: None.

GetChannelPlaneMill¶

MachineToolConfiguration.GetChannelPlaneMill¶

Retrieves the plane mill from a channel

Signature GetChannelPlaneMill(channelName)

Parameters:	channelName (str) – The channel in question
Returns:	The plane mill value
Return type:	`NXOpen.SIM.MachineToolConfigurationPlaneTypes`

New in version NX10.0.2.

License requirements: None.

GetChannelPlaneTurn¶

MachineToolConfiguration.GetChannelPlaneTurn¶

Retrieves the plane turn from a channel

Signature GetChannelPlaneTurn(channelName)

Parameters:	channelName (str) – The channel in question
Returns:	The plane turn value
Return type:	`NXOpen.SIM.MachineToolConfigurationPlaneTypes`

New in version NX10.0.2.

License requirements: None.

GetChannelSwiveling¶

MachineToolConfiguration.GetChannelSwiveling¶

Retrieves channel’s swiveling mode

Signature GetChannelSwiveling(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The swiveling mode value
Return type:	`NXOpen.SIM.MachineToolConfigurationSwivelingTypes`

New in version NX10.0.3.

License requirements: None.

GetChannelTcpmSupport¶

MachineToolConfiguration.GetChannelTcpmSupport¶

Retrieves machine TCPM support

Signature GetChannelTcpmSupport(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The TCPM support value
Return type:	bool

New in version NX10.0.3.

License requirements: None.

GetChannelToolAsSubprogram¶

MachineToolConfiguration.GetChannelToolAsSubprogram¶

Retrieves a channel’s subprogram support

Signature GetChannelToolAsSubprogram(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The tool as subprogram mode value
Return type:	bool

New in version NX10.0.3.

License requirements: None.

GetChannelToolCommand¶

MachineToolConfiguration.GetChannelToolCommand¶

Retrieves a channel’s tool command

Signature GetChannelToolCommand(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The tool command
Return type:	str

New in version NX10.0.3.

License requirements: None.

GetChannelToolPreselect¶

MachineToolConfiguration.GetChannelToolPreselect¶

Retrieves a channel’s tool preselect

Signature GetChannelToolPreselect(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The tool preselect
Return type:	str

New in version NX10.0.3.

License requirements: None.

GetCircularPrecision¶

MachineToolConfiguration.GetCircularPrecision¶

Retrieves the circular precision

Signature GetCircularPrecision(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The circular precision value
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetCircularPrecisionFactor¶

MachineToolConfiguration.GetCircularPrecisionFactor¶

Retrieves the circular precision factor

Signature GetCircularPrecisionFactor(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The circular precision factor
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetControllerLanguage¶

MachineToolConfiguration.GetControllerLanguage¶

Retrieves the controller language

Signature GetControllerLanguage()

Returns:	The controller language
Return type:	str

New in version NX10.0.3.

License requirements: None.

GetControllerVersion¶

MachineToolConfiguration.GetControllerVersion¶

Retrieves the controller version

Signature GetControllerVersion()

Returns:	The controller version
Return type:	str

New in version NX10.0.3.

License requirements: None.

GetDiameterGeoAxisName¶

MachineToolConfiguration.GetDiameterGeoAxisName¶

Retrieves the diameter geo axis name, which change the output behavior of length values during turning.

Signature GetDiameterGeoAxisName(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The diameter geo axis name
Return type:	str

New in version NX11.0.0.

License requirements: None.

GetLookahead¶

MachineToolConfiguration.GetLookahead¶

Retrieves the controller lookahead, which indicates how many lines are evaluate from the controller ahead.

Signature GetLookahead(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The controller lookahead
Return type:	int

New in version NX9.0.3.

License requirements: None.

GetMachineTechnology¶

MachineToolConfiguration.GetMachineTechnology¶

Retrieves the machine technology

Signature GetMachineTechnology(channelName)

Parameters:	channelName (str) – The channel to modify
Returns:	The machine technology
Return type:	`NXOpen.SIM.MachineToolConfigurationTechnologyTypes`

New in version NX9.0.3.

License requirements: None.

GetMdynamics¶

MachineToolConfiguration.GetMdynamics¶

Retrieve the MDynamics information

Signature GetMdynamics()

Returns:	The mdynamics value
Return type:	`NXOpen.SIM.MachineToolConfigurationMdynamicsTypes`

New in version NX10.0.3.

License requirements: None.

GetResolutionDeg¶

MachineToolConfiguration.GetResolutionDeg¶

Retrieves the degree resolution

Signature GetResolutionDeg()

Returns:	The degree resolution value
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetResolutionMm¶

MachineToolConfiguration.GetResolutionMm¶

Retrieves the millimeter resolution

Signature GetResolutionMm()

Returns:	The millimeter resolution value
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetToolCarrierDirectionSelection¶

MachineToolConfiguration.GetToolCarrierDirectionSelection¶

Retrieves the direction selection for a tool carrier.

Signature GetToolCarrierDirectionSelection(channelName, carrierName)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to query
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

GetToolCarrierRetraction¶

MachineToolConfiguration.GetToolCarrierRetraction¶

Retrieves the retraction for a tool carrier.

Signature GetToolCarrierRetraction(channelName, carrierName)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to query
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

GetToolCarrierSwivelMode¶

MachineToolConfiguration.GetToolCarrierSwivelMode¶

Retrieves the swiveling mode for a tool carrier.

Signature GetToolCarrierSwivelMode(channelName, carrierName)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to query
Returns:
Return type:	int

New in version NX10.0.3.

License requirements: None.

GetToolCarrierXRetractionPosition¶

MachineToolConfiguration.GetToolCarrierXRetractionPosition¶

Retrieves the X retraction position for a tool carrier.

Signature GetToolCarrierXRetractionPosition(channelName, carrierName)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to query
Returns:
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetToolCarrierYRetractionPosition¶

MachineToolConfiguration.GetToolCarrierYRetractionPosition¶

Retrieves the Y retraction position for a tool carrier.

Signature GetToolCarrierYRetractionPosition(channelName, carrierName)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to query
Returns:
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetToolCarrierZRetractionPosition¶

MachineToolConfiguration.GetToolCarrierZRetractionPosition¶

Retrieves the Z retraction position for a tool carrier.

Signature GetToolCarrierZRetractionPosition(channelName, carrierName)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to query
Returns:
Return type:	float

New in version NX10.0.3.

License requirements: None.

GetToolRadiusCompensation¶

MachineToolConfiguration.GetToolRadiusCompensation¶

Retrieves the 3D Tool Radius Compensation information

Signature GetToolRadiusCompensation()

Returns:	The Tool Radius value
Return type:	bool

New in version NX10.0.3.

License requirements: None.

GetUsedUnit¶

MachineToolConfiguration.GetUsedUnit¶

Retrieves the used unit

Signature GetUsedUnit()

Returns:	The used unit
Return type:	int

New in version NX10.0.3.

License requirements: None.

SetArchiveControllerType¶

MachineToolConfiguration.SetArchiveControllerType¶

Sets the archive controller type

Signature SetArchiveControllerType(newArchiveControllerType)

Parameters:	newArchiveControllerType (int) – The new archive controller type

New in version NX10.0.3.

License requirements: None.

SetArchiveControllerVersion¶

MachineToolConfiguration.SetArchiveControllerVersion¶

Sets the archive controller version

Signature SetArchiveControllerVersion(newArchiveControllerVersion)

Parameters:	newArchiveControllerVersion (str) – The new archive controller version

New in version NX10.0.3.

License requirements: None.

SetChannelPlaneMill¶

MachineToolConfiguration.SetChannelPlaneMill¶

Sets the plane mill for a channel

Signature SetChannelPlaneMill(channelName, newPlaneMill)

Parameters:	channelName (str) – The channel to modify newPlaneMill (`NXOpen.SIM.MachineToolConfigurationPlaneTypes`) – The new plane mill value

New in version NX10.0.2.

License requirements: None.

SetChannelPlaneTurn¶

MachineToolConfiguration.SetChannelPlaneTurn¶

Sets the plane turn for a channel

Signature SetChannelPlaneTurn(channelName, newPlaneTurn)

Parameters:	channelName (str) – The channel to modify newPlaneTurn (`NXOpen.SIM.MachineToolConfigurationPlaneTypes`) – The new plane turn value

New in version NX10.0.2.

License requirements: None.

SetChannelSwiveling¶

MachineToolConfiguration.SetChannelSwiveling¶

Sets the channel’s swiveling mode

Signature SetChannelSwiveling(channelName, value)

Parameters:	channelName (str) – The channel to modify value (`NXOpen.SIM.MachineToolConfigurationSwivelingTypes`) – The new swiveling mode value

New in version NX10.0.3.

License requirements: None.

SetChannelTcpmSupport¶

MachineToolConfiguration.SetChannelTcpmSupport¶

Sets the TCPM support value

Signature SetChannelTcpmSupport(channelName, value)

Parameters:	channelName (str) – The channel to modify value (bool) – The new TCPM support value

New in version NX10.0.3.

License requirements: None.

SetChannelToolAsSubprogram¶

MachineToolConfiguration.SetChannelToolAsSubprogram¶

Sets a channel’s subprogram support

Signature SetChannelToolAsSubprogram(channelName, value)

Parameters:	channelName (str) – The channel to modify value (bool) – The new tool as subprogram value

New in version NX10.0.3.

License requirements: None.

SetChannelToolCommand¶

MachineToolConfiguration.SetChannelToolCommand¶

Sets a channel’s tool command

Signature SetChannelToolCommand(channelName, newToolCommand)

Parameters:	channelName (str) – The channel to modify newToolCommand (str) – The new tool command

New in version NX10.0.3.

License requirements: None.

SetChannelToolPreselect¶

MachineToolConfiguration.SetChannelToolPreselect¶

Sets a channel’s tool preselect

Signature SetChannelToolPreselect(channelName, newToolPreselect)

Parameters:	channelName (str) – The channel to modify newToolPreselect (str) – The new tool preselect

New in version NX10.0.3.

License requirements: None.

SetCircularPrecision¶

MachineToolConfiguration.SetCircularPrecision¶

Sets the circular precision

Signature SetCircularPrecision(channelName, newCircularPrecision)

Parameters:	channelName (str) – The channel to modify newCircularPrecision (float) – The new circular precision value

New in version NX10.0.3.

License requirements: None.

SetCircularPrecisionFactor¶

MachineToolConfiguration.SetCircularPrecisionFactor¶

Sets the circular precision factor

Signature SetCircularPrecisionFactor(channelName, newCircularPrecisionFactor)

Parameters:	channelName (str) – The channel to modify newCircularPrecisionFactor (float) – The new circular precision factor

New in version NX10.0.3.

License requirements: None.

SetControllerLanguage¶

MachineToolConfiguration.SetControllerLanguage¶

Sets the controller language

Signature SetControllerLanguage(newLanguage)

Parameters:	newLanguage (str) – The new controller language

New in version NX10.0.3.

License requirements: None.

SetControllerVersion¶

MachineToolConfiguration.SetControllerVersion¶

Sets the controller version

Signature SetControllerVersion(newVersion)

Parameters:	newVersion (str) – The new controller version

New in version NX10.0.3.

License requirements: None.

SetDiameterGeoAxisName¶

MachineToolConfiguration.SetDiameterGeoAxisName¶

Sets the diameter geo axis name, which change the output behavior of length values during turning.

Signature SetDiameterGeoAxisName(channelName, newDiameterMode)

Parameters:	channelName (str) – The channel to modify newDiameterMode (str) – The new diameter geo axis name

New in version NX11.0.0.

License requirements: None.

SetLookahead¶

MachineToolConfiguration.SetLookahead¶

Sets the controller lookahead, which indicates how many lines are evaluate from the controller ahead.

Signature SetLookahead(channelName, lookAhead)

Parameters:	channelName (str) – The channel to modify lookAhead (int) – The new controller lookahead

New in version NX9.0.3.

License requirements: None.

SetMachineTechnology¶

MachineToolConfiguration.SetMachineTechnology¶

Sets the machine technology

Signature SetMachineTechnology(channelName, technology)

Parameters:	channelName (str) – The channel to modify technology (`NXOpen.SIM.MachineToolConfigurationTechnologyTypes`) – The new machine technology

New in version NX9.0.3.

License requirements: None.

SetMdynamics¶

MachineToolConfiguration.SetMdynamics¶

Sets the Mdynamics value

Signature SetMdynamics(newMDynamicsValue)

Parameters:	newMDynamicsValue (`NXOpen.SIM.MachineToolConfigurationMdynamicsTypes`) – The new mdynamics value

New in version NX10.0.3.

License requirements: None.

SetResolutionDeg¶

MachineToolConfiguration.SetResolutionDeg¶

Sets the degree resolution value

Signature SetResolutionDeg(newResolutionValue)

Parameters:	newResolutionValue (float) – The new degree resolution value

New in version NX10.0.3.

License requirements: None.

SetResolutionMm¶

MachineToolConfiguration.SetResolutionMm¶

Sets the millimeter resolution value

Signature SetResolutionMm(newResolutionValue)

Parameters:	newResolutionValue (float) – The new millimeter resolution value

New in version NX10.0.3.

License requirements: None.

SetToolCarrierDirectionSelection¶

MachineToolConfiguration.SetToolCarrierDirectionSelection¶

Sets the direction selection for a tool carrier.

Signature SetToolCarrierDirectionSelection(channelName, carrierName, newDirectionSelection)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to modify newDirectionSelection (int) – The new swiveling mode

New in version NX10.0.3.

License requirements: None.

SetToolCarrierRetraction¶

MachineToolConfiguration.SetToolCarrierRetraction¶

Sets the retraction for a tool carrier.

Signature SetToolCarrierRetraction(channelName, carrierName, newRetraction)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to modify newRetraction (int) – The new swiveling mode

New in version NX10.0.3.

License requirements: None.

SetToolCarrierSwivelMode¶

MachineToolConfiguration.SetToolCarrierSwivelMode¶

Sets the swiveling mode for a tool carrier.

Signature SetToolCarrierSwivelMode(channelName, carrierName, newSwivelingMode)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to modify newSwivelingMode (int) – The new swiveling mode

New in version NX10.0.3.

License requirements: None.

SetToolCarrierXRetractionPosition¶

MachineToolConfiguration.SetToolCarrierXRetractionPosition¶

Sets the X retraction position for a tool carrier.

Signature SetToolCarrierXRetractionPosition(channelName, carrierName, newXPosition)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to modify newXPosition (float) – The new X position

New in version NX10.0.3.

License requirements: None.

SetToolCarrierYRetractionPosition¶

MachineToolConfiguration.SetToolCarrierYRetractionPosition¶

Sets the Y retraction position for a tool carrier.

Signature SetToolCarrierYRetractionPosition(channelName, carrierName, newYPosition)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to modify newYPosition (float) – The new Y position

New in version NX10.0.3.

License requirements: None.

SetToolCarrierZRetractionPosition¶

MachineToolConfiguration.SetToolCarrierZRetractionPosition¶

Sets the Z retraction position for a tool carrier.

Signature SetToolCarrierZRetractionPosition(channelName, carrierName, newZPosition)

Parameters:	channelName (str) – The channel to which the carrier belongs carrierName (str) – The name of the carrier to modify newZPosition (float) – The new Z position

New in version NX10.0.3.

License requirements: None.

SetToolRadiusCompensation¶

MachineToolConfiguration.SetToolRadiusCompensation¶

Sets the 3D Tool Radius Compensation information

Signature SetToolRadiusCompensation(newCompensationValue)

Parameters:	newCompensationValue (bool) – The new Tool Radius Compensation value

New in version NX10.0.3.

License requirements: None.

SetUsedUnit¶

MachineToolConfiguration.SetUsedUnit¶

Sets the used unit

Signature SetUsedUnit(newUsedUnit)

Parameters:	newUsedUnit (int) – The new used unit

New in version NX10.0.3.

License requirements: None.

Validate¶

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