Represents a Machine Tool Configuration object. More...

Inheritance diagram for NXOpen::SIM::MachineToolConfiguration:

Public Types
enum	ControllerLines { ControllerLinesSolutionline, ControllerLinesPowerline }
	The controller line. More...

enum	MdynamicsTypes { MdynamicsTypesFiveaxmill }
	The mdynamics types. More...

enum	PlaneTypes { PlaneTypesOperator, PlaneTypesG17, PlaneTypesG18, PlaneTypesG19 }
	The plane selection types. More...

enum	SwivelingTypes { SwivelingTypesCycle800, SwivelingTypesTransarot }
	The machine swiveling types. More...

enum	TechnologyTypes { TechnologyTypesMill, TechnologyTypesTurn, TechnologyTypesMillturn, TechnologyTypesNone }
	The machine technology types. More...

enum	UnitTypes { UnitTypesMm, UnitTypesIn }
	The units type. More...

Public Member Functions
NXOpen::SIM::MachineToolConfiguration::ControllerLines	ControllerLine ()
	Returns the controller line Created in NX9.0.3. More...

NXString	ControllerType ()
	Returns the controller type Created in NX9.0.3. More...

double	CycleTime ()
	Returns the cycle time Created in NX9.0.3. More...

int	GetArchiveControllerType ()
	Retrieves the archive controller type. More...

NXString	GetArchiveControllerVersion ()
	Retrieves the archive controller version. More...

NXOpen::SIM::MachineToolConfiguration::PlaneTypes	GetChannelPlaneMill (const NXString &channelName)
	Retrieves the plane mill from a channel. More...

NXOpen::SIM::MachineToolConfiguration::PlaneTypes	GetChannelPlaneMill (const char *channelName)
	Retrieves the plane mill from a channel. More...

NXOpen::SIM::MachineToolConfiguration::PlaneTypes	GetChannelPlaneTurn (const NXString &channelName)
	Retrieves the plane turn from a channel. More...

NXOpen::SIM::MachineToolConfiguration::PlaneTypes	GetChannelPlaneTurn (const char *channelName)
	Retrieves the plane turn from a channel. More...

NXOpen::SIM::MachineToolConfiguration::SwivelingTypes	GetChannelSwiveling (const NXString &channelName)
	Retrieves channel's swiveling mode. More...

NXOpen::SIM::MachineToolConfiguration::SwivelingTypes	GetChannelSwiveling (const char *channelName)
	Retrieves channel's swiveling mode. More...

bool	GetChannelTcpmSupport (const NXString &channelName)
	Retrieves machine TCPM support. More...

bool	GetChannelTcpmSupport (const char *channelName)
	Retrieves machine TCPM support. More...

bool	GetChannelToolAsSubprogram (const NXString &channelName)
	Retrieves a channel's subprogram support. More...

bool	GetChannelToolAsSubprogram (const char *channelName)
	Retrieves a channel's subprogram support. More...

NXString	GetChannelToolCommand (const NXString &channelName)
	Retrieves a channel's tool command. More...

NXString	GetChannelToolCommand (const char *channelName)
	Retrieves a channel's tool command. More...

NXString	GetChannelToolPreselect (const NXString &channelName)
	Retrieves a channel's tool preselect. More...

NXString	GetChannelToolPreselect (const char *channelName)
	Retrieves a channel's tool preselect. More...

double	GetCircularPrecision (const NXString &channelName)
	Retrieves the circular precision. More...

double	GetCircularPrecision (const char *channelName)
	Retrieves the circular precision. More...

double	GetCircularPrecisionFactor (const NXString &channelName)
	Retrieves the circular precision factor. More...

double	GetCircularPrecisionFactor (const char *channelName)
	Retrieves the circular precision factor. More...

NXString	GetControllerLanguage ()
	Retrieves the controller language. More...

NXString	GetControllerVersion ()
	Retrieves the controller version. More...

NXString	GetDiameterGeoAxisName (const NXString &channelName)
	Retrieves the diameter geo axis name, which change the output behavior of length values during turning. More...

NXString	GetDiameterGeoAxisName (const char *channelName)
	Retrieves the diameter geo axis name, which change the output behavior of length values during turning. More...

int	GetLookahead (const NXString &channelName)
	Retrieves the controller lookahead, which indicates how many lines are evaluate from the controller ahead. More...

int	GetLookahead (const char *channelName)
	Retrieves the controller lookahead, which indicates how many lines are evaluate from the controller ahead. More...

NXOpen::SIM::MachineToolConfiguration::TechnologyTypes	GetMachineTechnology (const NXString &channelName)
	Retrieves the machine technology. More...

NXOpen::SIM::MachineToolConfiguration::TechnologyTypes	GetMachineTechnology (const char *channelName)
	Retrieves the machine technology. More...

NXOpen::SIM::MachineToolConfiguration::MdynamicsTypes	GetMdynamics ()
	Retrieve the MDynamics information. More...

double	GetResolutionDeg ()
	Retrieves the degree resolution. More...

double	GetResolutionMm ()
	Retrieves the millimeter resolution. More...

int	GetToolCarrierDirectionSelection (const NXString &channelName, const NXString &carrierName)
	Retrieves the direction selection for a tool carrier. More...

int	GetToolCarrierDirectionSelection (const char channelName, const char carrierName)
	Retrieves the direction selection for a tool carrier. More...

int	GetToolCarrierRetraction (const NXString &channelName, const NXString &carrierName)
	Retrieves the retraction for a tool carrier. More...

int	GetToolCarrierRetraction (const char channelName, const char carrierName)
	Retrieves the retraction for a tool carrier. More...

int	GetToolCarrierSwivelMode (const NXString &channelName, const NXString &carrierName)
	Retrieves the swiveling mode for a tool carrier. More...

int	GetToolCarrierSwivelMode (const char channelName, const char carrierName)
	Retrieves the swiveling mode for a tool carrier. More...

double	GetToolCarrierXRetractionPosition (const NXString &channelName, const NXString &carrierName)
	Retrieves the X retraction position for a tool carrier. More...

double	GetToolCarrierXRetractionPosition (const char channelName, const char carrierName)
	Retrieves the X retraction position for a tool carrier. More...

double	GetToolCarrierYRetractionPosition (const NXString &channelName, const NXString &carrierName)
	Retrieves the Y retraction position for a tool carrier. More...

double	GetToolCarrierYRetractionPosition (const char channelName, const char carrierName)
	Retrieves the Y retraction position for a tool carrier. More...

double	GetToolCarrierZRetractionPosition (const NXString &channelName, const NXString &carrierName)
	Retrieves the Z retraction position for a tool carrier. More...

double	GetToolCarrierZRetractionPosition (const char channelName, const char carrierName)
	Retrieves the Z retraction position for a tool carrier. More...

bool	GetToolRadiusCompensation ()
	Retrieves the 3D Tool Radius Compensation information. More...

int	GetUsedUnit ()
	Retrieves the used unit. More...

NXString	MachineName ()
	Returns the machine name Created in NX9.0.3. More...

NXString	MachineVendor ()
	Returns the machine vendor Created in NX9.0.3. More...

void	SetArchiveControllerType (int newArchiveControllerType)
	Sets the archive controller type Created in NX10.0.3. More...

void	SetArchiveControllerVersion (const NXString &newArchiveControllerVersion)
	Sets the archive controller version Created in NX10.0.3. More...

void	SetArchiveControllerVersion (const char *newArchiveControllerVersion)
	Sets the archive controller version Created in NX10.0.3. More...

void	SetChannelPlaneMill (const NXString &channelName, NXOpen::SIM::MachineToolConfiguration::PlaneTypes newPlaneMill)
	Sets the plane mill for a channel Created in NX10.0.2. More...

void	SetChannelPlaneMill (const char *channelName, NXOpen::SIM::MachineToolConfiguration::PlaneTypes newPlaneMill)
	Sets the plane mill for a channel Created in NX10.0.2. More...

void	SetChannelPlaneTurn (const NXString &channelName, NXOpen::SIM::MachineToolConfiguration::PlaneTypes newPlaneTurn)
	Sets the plane turn for a channel Created in NX10.0.2. More...

void	SetChannelPlaneTurn (const char *channelName, NXOpen::SIM::MachineToolConfiguration::PlaneTypes newPlaneTurn)
	Sets the plane turn for a channel Created in NX10.0.2. More...

void	SetChannelSwiveling (const NXString &channelName, NXOpen::SIM::MachineToolConfiguration::SwivelingTypes value)
	Sets the channel's swiveling mode Created in NX10.0.3. More...

void	SetChannelSwiveling (const char *channelName, NXOpen::SIM::MachineToolConfiguration::SwivelingTypes value)
	Sets the channel's swiveling mode Created in NX10.0.3. More...

void	SetChannelTcpmSupport (const NXString &channelName, bool value)
	Sets the TCPM support value Created in NX10.0.3. More...

void	SetChannelTcpmSupport (const char *channelName, bool value)
	Sets the TCPM support value Created in NX10.0.3. More...

void	SetChannelToolAsSubprogram (const NXString &channelName, bool value)
	Sets a channel's subprogram support Created in NX10.0.3. More...

void	SetChannelToolAsSubprogram (const char *channelName, bool value)
	Sets a channel's subprogram support Created in NX10.0.3. More...

void	SetChannelToolCommand (const NXString &channelName, const NXString &newToolCommand)
	Sets a channel's tool command Created in NX10.0.3. More...

void	SetChannelToolCommand (const char channelName, const char newToolCommand)
	Sets a channel's tool command Created in NX10.0.3. More...

void	SetChannelToolPreselect (const NXString &channelName, const NXString &newToolPreselect)
	Sets a channel's tool preselect Created in NX10.0.3. More...

void	SetChannelToolPreselect (const char channelName, const char newToolPreselect)
	Sets a channel's tool preselect Created in NX10.0.3. More...

void	SetCircularPrecision (const NXString &channelName, double newCircularPrecision)
	Sets the circular precision Created in NX10.0.3. More...

void	SetCircularPrecision (const char *channelName, double newCircularPrecision)
	Sets the circular precision Created in NX10.0.3. More...

void	SetCircularPrecisionFactor (const NXString &channelName, double newCircularPrecisionFactor)
	Sets the circular precision factor Created in NX10.0.3. More...

void	SetCircularPrecisionFactor (const char *channelName, double newCircularPrecisionFactor)
	Sets the circular precision factor Created in NX10.0.3. More...

void	SetControllerLanguage (const NXString &newLanguage)
	Sets the controller language Created in NX10.0.3. More...

void	SetControllerLanguage (const char *newLanguage)
	Sets the controller language Created in NX10.0.3. More...

void	SetControllerLine (NXOpen::SIM::MachineToolConfiguration::ControllerLines line)
	Sets the controller line Created in NX9.0.3. More...

void	SetControllerType (const NXString &controllerType)
	Sets the controller type Created in NX9.0.3. More...

void	SetControllerType (const char *controllerType)
	Sets the controller type Created in NX9.0.3. More...

void	SetControllerVersion (const NXString &newVersion)
	Sets the controller version Created in NX10.0.3. More...

void	SetControllerVersion (const char *newVersion)
	Sets the controller version Created in NX10.0.3. More...

void	SetCycleTime (double cycleTime)
	Sets the cycle time Created in NX9.0.3. More...

void	SetDiameterGeoAxisName (const NXString &channelName, const NXString &newDiameterMode)
	Sets the diameter geo axis name, which change the output behavior of length values during turning. More...

void	SetDiameterGeoAxisName (const char channelName, const char newDiameterMode)
	Sets the diameter geo axis name, which change the output behavior of length values during turning. More...

void	SetLookahead (const NXString &channelName, int lookAhead)
	Sets the controller lookahead, which indicates how many lines are evaluate from the controller ahead. More...

void	SetLookahead (const char *channelName, int lookAhead)
	Sets the controller lookahead, which indicates how many lines are evaluate from the controller ahead. More...

void	SetMachineName (const NXString &name)
	Sets the machine name Created in NX9.0.3. More...

void	SetMachineName (const char *name)
	Sets the machine name Created in NX9.0.3. More...

void	SetMachineTechnology (const NXString &channelName, NXOpen::SIM::MachineToolConfiguration::TechnologyTypes technology)
	Sets the machine technology Created in NX9.0.3. More...

void	SetMachineTechnology (const char *channelName, NXOpen::SIM::MachineToolConfiguration::TechnologyTypes technology)
	Sets the machine technology Created in NX9.0.3. More...

void	SetMachineVendor (const NXString &vendor)
	Sets the machine vendor Created in NX9.0.3. More...

void	SetMachineVendor (const char *vendor)
	Sets the machine vendor Created in NX9.0.3. More...

void	SetMdynamics (NXOpen::SIM::MachineToolConfiguration::MdynamicsTypes newMDynamicsValue)
	Sets the Mdynamics value Created in NX10.0.3. More...

void	SetResolutionDeg (double newResolutionValue)
	Sets the degree resolution value Created in NX10.0.3. More...

void	SetResolutionMm (double newResolutionValue)
	Sets the millimeter resolution value Created in NX10.0.3. More...

void	SetToolCarrierDirectionSelection (const NXString &channelName, const NXString &carrierName, int newDirectionSelection)
	Sets the direction selection for a tool carrier. More...

void	SetToolCarrierDirectionSelection (const char channelName, const char carrierName, int newDirectionSelection)
	Sets the direction selection for a tool carrier. More...

void	SetToolCarrierName (const NXString &carrierName)
	Sets the tool carrier name Created in NX9.0.3. More...

void	SetToolCarrierName (const char *carrierName)
	Sets the tool carrier name Created in NX9.0.3. More...

void	SetToolCarrierRetraction (const NXString &channelName, const NXString &carrierName, int newRetraction)
	Sets the retraction for a tool carrier. More...

void	SetToolCarrierRetraction (const char channelName, const char carrierName, int newRetraction)
	Sets the retraction for a tool carrier. More...

void	SetToolCarrierSwivelMode (const NXString &channelName, const NXString &carrierName, int newSwivelingMode)
	Sets the swiveling mode for a tool carrier. More...

void	SetToolCarrierSwivelMode (const char channelName, const char carrierName, int newSwivelingMode)
	Sets the swiveling mode for a tool carrier. More...

void	SetToolCarrierXRetractionPosition (const NXString &channelName, const NXString &carrierName, double newXPosition)
	Sets the X retraction position for a tool carrier. More...

void	SetToolCarrierXRetractionPosition (const char channelName, const char carrierName, double newXPosition)
	Sets the X retraction position for a tool carrier. More...

void	SetToolCarrierYRetractionPosition (const NXString &channelName, const NXString &carrierName, double newYPosition)
	Sets the Y retraction position for a tool carrier. More...

void	SetToolCarrierYRetractionPosition (const char channelName, const char carrierName, double newYPosition)
	Sets the Y retraction position for a tool carrier. More...

void	SetToolCarrierZRetractionPosition (const NXString &channelName, const NXString &carrierName, double newZPosition)
	Sets the Z retraction position for a tool carrier. More...

void	SetToolCarrierZRetractionPosition (const char channelName, const char carrierName, double newZPosition)
	Sets the Z retraction position for a tool carrier. More...

void	SetToolRadiusCompensation (bool newCompensationValue)
	Sets the 3D Tool Radius Compensation information Created in NX10.0.3. More...

void	SetUsedUnit (int newUsedUnit)
	Sets the used unit Created in NX10.0.3. More...

NXString	ToolCarrierName ()
	Returns the tool carrier name Created in NX9.0.3. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a Machine Tool Configuration object.

To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateMachineToolConfigurationBuilder

Created in NX9.0.3.

Member Enumeration Documentation

enum NXOpen::SIM::MachineToolConfiguration::ControllerLines

The controller line.

Enumerator
ControllerLinesSolutionline	The solutionline controller line.
ControllerLinesPowerline	The powerline controller line.

enum NXOpen::SIM::MachineToolConfiguration::MdynamicsTypes

The mdynamics types.

Enumerator
MdynamicsTypesFiveaxmill	The Five Axis Milling MDynamics type.

enum NXOpen::SIM::MachineToolConfiguration::PlaneTypes

The plane selection types.

Enumerator
PlaneTypesOperator	The operator panel plane type.
PlaneTypesG17	The G17 plane type.
PlaneTypesG18	The G18 plane type.
PlaneTypesG19	The G19 plane type.

enum NXOpen::SIM::MachineToolConfiguration::SwivelingTypes

The machine swiveling types.

Enumerator
SwivelingTypesCycle800	The CYCLE800 swiveling type.
SwivelingTypesTransarot	The TRANS/AROT swiveling type.

enum NXOpen::SIM::MachineToolConfiguration::TechnologyTypes

The machine technology types.

Enumerator
TechnologyTypesMill	The mill technology type.
TechnologyTypesTurn	The lathe technology type.
TechnologyTypesMillturn	The millturn technology type.
TechnologyTypesNone	No technology type.

enum NXOpen::SIM::MachineToolConfiguration::UnitTypes

The units type.

Enumerator
UnitTypesMm	The millimeter unit type.
UnitTypesIn	The inch unit type.

Member Function Documentation

NXOpen::SIM::MachineToolConfiguration::ControllerLines NXOpen::SIM::MachineToolConfiguration::ControllerLine ( )

Returns the controller line
Created in NX9.0.3.

License requirements : None

NXString NXOpen::SIM::MachineToolConfiguration::ControllerType ( )

Returns the controller type
Created in NX9.0.3.

License requirements : None

double NXOpen::SIM::MachineToolConfiguration::CycleTime ( )

Returns the cycle time
Created in NX9.0.3.

License requirements : None

int NXOpen::SIM::MachineToolConfiguration::GetArchiveControllerType ( )

Retrieves the archive controller type.

Returns: The archive controller type
Created in NX10.0.3.

License requirements : None

NXString NXOpen::SIM::MachineToolConfiguration::GetArchiveControllerVersion ( )

Retrieves the archive controller version.

Returns: The archive controller version
Created in NX10.0.3.

License requirements : None

NXOpen::SIM::MachineToolConfiguration::PlaneTypes NXOpen::SIM::MachineToolConfiguration::GetChannelPlaneMill ( const NXString & channelName )

Retrieves the plane mill from a channel.

Returns: The plane mill value
Created in NX10.0.2.

License requirements : None

Parameters

channelName The channel in question

NXOpen::SIM::MachineToolConfiguration::PlaneTypes NXOpen::SIM::MachineToolConfiguration::GetChannelPlaneMill ( const char * channelName )

Retrieves the plane mill from a channel.

Returns: The plane mill value
Created in NX10.0.2.

License requirements : None

Parameters

channelName The channel in question

NXOpen::SIM::MachineToolConfiguration::PlaneTypes NXOpen::SIM::MachineToolConfiguration::GetChannelPlaneTurn ( const NXString & channelName )

Retrieves the plane turn from a channel.

Returns: The plane turn value
Created in NX10.0.2.

License requirements : None

Parameters

channelName The channel in question

NXOpen::SIM::MachineToolConfiguration::PlaneTypes NXOpen::SIM::MachineToolConfiguration::GetChannelPlaneTurn ( const char * channelName )

Retrieves the plane turn from a channel.

Returns: The plane turn value
Created in NX10.0.2.

License requirements : None

Parameters

channelName The channel in question

NXOpen::SIM::MachineToolConfiguration::SwivelingTypes NXOpen::SIM::MachineToolConfiguration::GetChannelSwiveling ( const NXString & channelName )

Retrieves channel's swiveling mode.

Returns: The swiveling mode value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXOpen::SIM::MachineToolConfiguration::SwivelingTypes NXOpen::SIM::MachineToolConfiguration::GetChannelSwiveling ( const char * channelName )

Retrieves channel's swiveling mode.

Returns: The swiveling mode value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

bool NXOpen::SIM::MachineToolConfiguration::GetChannelTcpmSupport ( const NXString & channelName )

Retrieves machine TCPM support.

Returns: The TCPM support value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

bool NXOpen::SIM::MachineToolConfiguration::GetChannelTcpmSupport ( const char * channelName )

Retrieves machine TCPM support.

Returns: The TCPM support value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

bool NXOpen::SIM::MachineToolConfiguration::GetChannelToolAsSubprogram ( const NXString & channelName )

Retrieves a channel's subprogram support.

Returns: The tool as subprogram mode value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

bool NXOpen::SIM::MachineToolConfiguration::GetChannelToolAsSubprogram ( const char * channelName )

Retrieves a channel's subprogram support.

Returns: The tool as subprogram mode value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXString NXOpen::SIM::MachineToolConfiguration::GetChannelToolCommand ( const NXString & channelName )

Retrieves a channel's tool command.

Returns: The tool command
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXString NXOpen::SIM::MachineToolConfiguration::GetChannelToolCommand ( const char * channelName )

Retrieves a channel's tool command.

Returns: The tool command
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXString NXOpen::SIM::MachineToolConfiguration::GetChannelToolPreselect ( const NXString & channelName )

Retrieves a channel's tool preselect.

Returns: The tool preselect
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXString NXOpen::SIM::MachineToolConfiguration::GetChannelToolPreselect ( const char * channelName )

Retrieves a channel's tool preselect.

Returns: The tool preselect
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

double NXOpen::SIM::MachineToolConfiguration::GetCircularPrecision ( const NXString & channelName )

Retrieves the circular precision.

Returns: The circular precision value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

double NXOpen::SIM::MachineToolConfiguration::GetCircularPrecision ( const char * channelName )

Retrieves the circular precision.

Returns: The circular precision value
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

double NXOpen::SIM::MachineToolConfiguration::GetCircularPrecisionFactor ( const NXString & channelName )

Retrieves the circular precision factor.

Returns: The circular precision factor
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

double NXOpen::SIM::MachineToolConfiguration::GetCircularPrecisionFactor ( const char * channelName )

Retrieves the circular precision factor.

Returns: The circular precision factor
Created in NX10.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXString NXOpen::SIM::MachineToolConfiguration::GetControllerLanguage ( )

Retrieves the controller language.

Returns: The controller language
Created in NX10.0.3.

License requirements : None

NXString NXOpen::SIM::MachineToolConfiguration::GetControllerVersion ( )

Retrieves the controller version.

Returns: The controller version
Created in NX10.0.3.

License requirements : None

NXString NXOpen::SIM::MachineToolConfiguration::GetDiameterGeoAxisName ( const NXString & channelName )

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

Returns: The diameter geo axis name
Created in NX11.0.0.

License requirements : None

Parameters

channelName The channel to modify

NXString NXOpen::SIM::MachineToolConfiguration::GetDiameterGeoAxisName ( const char * channelName )

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

Returns: The diameter geo axis name
Created in NX11.0.0.

License requirements : None

Parameters

channelName The channel to modify

int NXOpen::SIM::MachineToolConfiguration::GetLookahead ( const NXString & channelName )

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

Returns: The controller lookahead
Created in NX9.0.3.

License requirements : None

Parameters

channelName The channel to modify

int NXOpen::SIM::MachineToolConfiguration::GetLookahead ( const char * channelName )

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

Returns: The controller lookahead
Created in NX9.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXOpen::SIM::MachineToolConfiguration::TechnologyTypes NXOpen::SIM::MachineToolConfiguration::GetMachineTechnology ( const NXString & channelName )

Retrieves the machine technology.

Returns: The machine technology
Created in NX9.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXOpen::SIM::MachineToolConfiguration::TechnologyTypes NXOpen::SIM::MachineToolConfiguration::GetMachineTechnology ( const char * channelName )

Retrieves the machine technology.

Returns: The machine technology
Created in NX9.0.3.

License requirements : None

Parameters

channelName The channel to modify

NXOpen::SIM::MachineToolConfiguration::MdynamicsTypes NXOpen::SIM::MachineToolConfiguration::GetMdynamics ( )

Retrieve the MDynamics information.

Returns: The mdynamics value
Created in NX10.0.3.

License requirements : None

double NXOpen::SIM::MachineToolConfiguration::GetResolutionDeg ( )

Retrieves the degree resolution.

Returns: The degree resolution value
Created in NX10.0.3.

License requirements : None

double NXOpen::SIM::MachineToolConfiguration::GetResolutionMm ( )

Retrieves the millimeter resolution.

Returns: The millimeter resolution value
Created in NX10.0.3.

License requirements : None

int NXOpen::SIM::MachineToolConfiguration::GetToolCarrierDirectionSelection	(	const NXString &	channelName,
		const NXString &	carrierName
	)

Retrieves the direction selection for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

int NXOpen::SIM::MachineToolConfiguration::GetToolCarrierDirectionSelection	(	const char *	channelName,
		const char *	carrierName
	)

Retrieves the direction selection for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

int NXOpen::SIM::MachineToolConfiguration::GetToolCarrierRetraction	(	const NXString &	channelName,
		const NXString &	carrierName
	)

Retrieves the retraction for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

int NXOpen::SIM::MachineToolConfiguration::GetToolCarrierRetraction	(	const char *	channelName,
		const char *	carrierName
	)

Retrieves the retraction for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

int NXOpen::SIM::MachineToolConfiguration::GetToolCarrierSwivelMode	(	const NXString &	channelName,
		const NXString &	carrierName
	)

Retrieves the swiveling mode for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

int NXOpen::SIM::MachineToolConfiguration::GetToolCarrierSwivelMode	(	const char *	channelName,
		const char *	carrierName
	)

Retrieves the swiveling mode for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

double NXOpen::SIM::MachineToolConfiguration::GetToolCarrierXRetractionPosition	(	const NXString &	channelName,
		const NXString &	carrierName
	)

Retrieves the X retraction position for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

double NXOpen::SIM::MachineToolConfiguration::GetToolCarrierXRetractionPosition	(	const char *	channelName,
		const char *	carrierName
	)

Retrieves the X retraction position for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

double NXOpen::SIM::MachineToolConfiguration::GetToolCarrierYRetractionPosition	(	const NXString &	channelName,
		const NXString &	carrierName
	)

Retrieves the Y retraction position for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

double NXOpen::SIM::MachineToolConfiguration::GetToolCarrierYRetractionPosition	(	const char *	channelName,
		const char *	carrierName
	)

Retrieves the Y retraction position for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

double NXOpen::SIM::MachineToolConfiguration::GetToolCarrierZRetractionPosition	(	const NXString &	channelName,
		const NXString &	carrierName
	)

Retrieves the Z retraction position for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

double NXOpen::SIM::MachineToolConfiguration::GetToolCarrierZRetractionPosition	(	const char *	channelName,
		const char *	carrierName
	)

Retrieves the Z retraction position for a tool carrier.

Returns: Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to query

bool NXOpen::SIM::MachineToolConfiguration::GetToolRadiusCompensation ( )

Retrieves the 3D Tool Radius Compensation information.

Returns: The Tool Radius value
Created in NX10.0.3.

License requirements : None

int NXOpen::SIM::MachineToolConfiguration::GetUsedUnit ( )

Retrieves the used unit.

Returns: The used unit
Created in NX10.0.3.

License requirements : None

NXString NXOpen::SIM::MachineToolConfiguration::MachineName ( )

Returns the machine name
Created in NX9.0.3.

License requirements : None

NXString NXOpen::SIM::MachineToolConfiguration::MachineVendor ( )

Returns the machine vendor
Created in NX9.0.3.

License requirements : None

void NXOpen::SIM::MachineToolConfiguration::SetArchiveControllerType ( int newArchiveControllerType )

Sets the archive controller type
Created in NX10.0.3.

License requirements : None

Parameters

newArchiveControllerType The new archive controller type

void NXOpen::SIM::MachineToolConfiguration::SetArchiveControllerVersion ( const NXString & newArchiveControllerVersion )

Sets the archive controller version
Created in NX10.0.3.

License requirements : None

Parameters

newArchiveControllerVersion The new archive controller version

void NXOpen::SIM::MachineToolConfiguration::SetArchiveControllerVersion ( const char * newArchiveControllerVersion )

Sets the archive controller version
Created in NX10.0.3.

License requirements : None

Parameters

newArchiveControllerVersion The new archive controller version

void NXOpen::SIM::MachineToolConfiguration::SetChannelPlaneMill	(	const NXString &	channelName,
		NXOpen::SIM::MachineToolConfiguration::PlaneTypes	newPlaneMill
	)

Sets the plane mill for a channel
Created in NX10.0.2.

License requirements : None

Parameters

channelName	The channel to modify
newPlaneMill	The new plane mill value

void NXOpen::SIM::MachineToolConfiguration::SetChannelPlaneMill	(	const char *	channelName,
		NXOpen::SIM::MachineToolConfiguration::PlaneTypes	newPlaneMill
	)

Sets the plane mill for a channel
Created in NX10.0.2.

License requirements : None

Parameters

channelName	The channel to modify
newPlaneMill	The new plane mill value

void NXOpen::SIM::MachineToolConfiguration::SetChannelPlaneTurn	(	const NXString &	channelName,
		NXOpen::SIM::MachineToolConfiguration::PlaneTypes	newPlaneTurn
	)

Sets the plane turn for a channel
Created in NX10.0.2.

License requirements : None

Parameters

channelName	The channel to modify
newPlaneTurn	The new plane turn value

void NXOpen::SIM::MachineToolConfiguration::SetChannelPlaneTurn	(	const char *	channelName,
		NXOpen::SIM::MachineToolConfiguration::PlaneTypes	newPlaneTurn
	)

Sets the plane turn for a channel
Created in NX10.0.2.

License requirements : None

Parameters

channelName	The channel to modify
newPlaneTurn	The new plane turn value

void NXOpen::SIM::MachineToolConfiguration::SetChannelSwiveling	(	const NXString &	channelName,
		NXOpen::SIM::MachineToolConfiguration::SwivelingTypes	value
	)

Sets the channel's swiveling mode
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
value	The new swiveling mode value

void NXOpen::SIM::MachineToolConfiguration::SetChannelSwiveling	(	const char *	channelName,
		NXOpen::SIM::MachineToolConfiguration::SwivelingTypes	value
	)

Sets the channel's swiveling mode
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
value	The new swiveling mode value

void NXOpen::SIM::MachineToolConfiguration::SetChannelTcpmSupport	(	const NXString &	channelName,
		bool	value
	)

Sets the TCPM support value
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
value	The new TCPM support value

void NXOpen::SIM::MachineToolConfiguration::SetChannelTcpmSupport	(	const char *	channelName,
		bool	value
	)

Sets the TCPM support value
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
value	The new TCPM support value

void NXOpen::SIM::MachineToolConfiguration::SetChannelToolAsSubprogram	(	const NXString &	channelName,
		bool	value
	)

Sets a channel's subprogram support
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
value	The new tool as subprogram value

void NXOpen::SIM::MachineToolConfiguration::SetChannelToolAsSubprogram	(	const char *	channelName,
		bool	value
	)

Sets a channel's subprogram support
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
value	The new tool as subprogram value

void NXOpen::SIM::MachineToolConfiguration::SetChannelToolCommand	(	const NXString &	channelName,
		const NXString &	newToolCommand
	)

Sets a channel's tool command
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newToolCommand	The new tool command

void NXOpen::SIM::MachineToolConfiguration::SetChannelToolCommand	(	const char *	channelName,
		const char *	newToolCommand
	)

Sets a channel's tool command
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newToolCommand	The new tool command

void NXOpen::SIM::MachineToolConfiguration::SetChannelToolPreselect	(	const NXString &	channelName,
		const NXString &	newToolPreselect
	)

Sets a channel's tool preselect
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newToolPreselect	The new tool preselect

void NXOpen::SIM::MachineToolConfiguration::SetChannelToolPreselect	(	const char *	channelName,
		const char *	newToolPreselect
	)

Sets a channel's tool preselect
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newToolPreselect	The new tool preselect

void NXOpen::SIM::MachineToolConfiguration::SetCircularPrecision	(	const NXString &	channelName,
		double	newCircularPrecision
	)

Sets the circular precision
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newCircularPrecision	The new circular precision value

void NXOpen::SIM::MachineToolConfiguration::SetCircularPrecision	(	const char *	channelName,
		double	newCircularPrecision
	)

Sets the circular precision
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newCircularPrecision	The new circular precision value

void NXOpen::SIM::MachineToolConfiguration::SetCircularPrecisionFactor	(	const NXString &	channelName,
		double	newCircularPrecisionFactor
	)

Sets the circular precision factor
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newCircularPrecisionFactor	The new circular precision factor

void NXOpen::SIM::MachineToolConfiguration::SetCircularPrecisionFactor	(	const char *	channelName,
		double	newCircularPrecisionFactor
	)

Sets the circular precision factor
Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to modify
newCircularPrecisionFactor	The new circular precision factor

void NXOpen::SIM::MachineToolConfiguration::SetControllerLanguage ( const NXString & newLanguage )

Sets the controller language
Created in NX10.0.3.

License requirements : None

Parameters

newLanguage The new controller language

void NXOpen::SIM::MachineToolConfiguration::SetControllerLanguage ( const char * newLanguage )

Sets the controller language
Created in NX10.0.3.

License requirements : None

Parameters

newLanguage The new controller language

void NXOpen::SIM::MachineToolConfiguration::SetControllerLine ( NXOpen::SIM::MachineToolConfiguration::ControllerLines line )

Sets the controller line
Created in NX9.0.3.

License requirements : None

Parameters

line	The new controller line

void NXOpen::SIM::MachineToolConfiguration::SetControllerType ( const NXString & controllerType )

Sets the controller type
Created in NX9.0.3.

License requirements : None

Parameters

controllerType The new controller type

void NXOpen::SIM::MachineToolConfiguration::SetControllerType ( const char * controllerType )

Sets the controller type
Created in NX9.0.3.

License requirements : None

Parameters

controllerType The new controller type

void NXOpen::SIM::MachineToolConfiguration::SetControllerVersion ( const NXString & newVersion )

Sets the controller version
Created in NX10.0.3.

License requirements : None

Parameters

newVersion The new controller version

void NXOpen::SIM::MachineToolConfiguration::SetControllerVersion ( const char * newVersion )

Sets the controller version
Created in NX10.0.3.

License requirements : None

Parameters

newVersion The new controller version

void NXOpen::SIM::MachineToolConfiguration::SetCycleTime ( double cycleTime )

Sets the cycle time
Created in NX9.0.3.

License requirements : None

Parameters

cycleTime The new cycle time

void NXOpen::SIM::MachineToolConfiguration::SetDiameterGeoAxisName	(	const NXString &	channelName,
		const NXString &	newDiameterMode
	)

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

Created in NX11.0.0.

License requirements : None

Parameters

channelName	The channel to modify
newDiameterMode	The new diameter geo axis name

void NXOpen::SIM::MachineToolConfiguration::SetDiameterGeoAxisName	(	const char *	channelName,
		const char *	newDiameterMode
	)

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

Created in NX11.0.0.

License requirements : None

Parameters

channelName	The channel to modify
newDiameterMode	The new diameter geo axis name

void NXOpen::SIM::MachineToolConfiguration::SetLookahead	(	const NXString &	channelName,
		int	lookAhead
	)

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

Created in NX9.0.3.

License requirements : None

Parameters

channelName	The channel to modify
lookAhead	The new controller lookahead

void NXOpen::SIM::MachineToolConfiguration::SetLookahead	(	const char *	channelName,
		int	lookAhead
	)

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

Created in NX9.0.3.

License requirements : None

Parameters

channelName	The channel to modify
lookAhead	The new controller lookahead

void NXOpen::SIM::MachineToolConfiguration::SetMachineName ( const NXString & name )

Sets the machine name
Created in NX9.0.3.

License requirements : None

Parameters

name	The new machine name

void NXOpen::SIM::MachineToolConfiguration::SetMachineName ( const char * name )

Sets the machine name
Created in NX9.0.3.

License requirements : None

Parameters

name	The new machine name

void NXOpen::SIM::MachineToolConfiguration::SetMachineTechnology	(	const NXString &	channelName,
		NXOpen::SIM::MachineToolConfiguration::TechnologyTypes	technology
	)

Sets the machine technology
Created in NX9.0.3.

License requirements : None

Parameters

channelName	The channel to modify
technology	The new machine technology

void NXOpen::SIM::MachineToolConfiguration::SetMachineTechnology	(	const char *	channelName,
		NXOpen::SIM::MachineToolConfiguration::TechnologyTypes	technology
	)

Sets the machine technology
Created in NX9.0.3.

License requirements : None

Parameters

channelName	The channel to modify
technology	The new machine technology

void NXOpen::SIM::MachineToolConfiguration::SetMachineVendor ( const NXString & vendor )

Sets the machine vendor
Created in NX9.0.3.

License requirements : None

Parameters

vendor The new machine vendor

void NXOpen::SIM::MachineToolConfiguration::SetMachineVendor ( const char * vendor )

Sets the machine vendor
Created in NX9.0.3.

License requirements : None

Parameters

vendor The new machine vendor

void NXOpen::SIM::MachineToolConfiguration::SetMdynamics ( NXOpen::SIM::MachineToolConfiguration::MdynamicsTypes newMDynamicsValue )

Sets the Mdynamics value
Created in NX10.0.3.

License requirements : None

Parameters

newMDynamicsValue The new mdynamics value

void NXOpen::SIM::MachineToolConfiguration::SetResolutionDeg ( double newResolutionValue )

Sets the degree resolution value
Created in NX10.0.3.

License requirements : None

Parameters

newResolutionValue The new degree resolution value

void NXOpen::SIM::MachineToolConfiguration::SetResolutionMm ( double newResolutionValue )

Sets the millimeter resolution value
Created in NX10.0.3.

License requirements : None

Parameters

newResolutionValue The new millimeter resolution value

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierDirectionSelection	(	const NXString &	channelName,
		const NXString &	carrierName,
		int	newDirectionSelection
	)

Sets the direction selection for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newDirectionSelection	The new swiveling mode

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierDirectionSelection	(	const char *	channelName,
		const char *	carrierName,
		int	newDirectionSelection
	)

Sets the direction selection for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newDirectionSelection	The new swiveling mode

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierName ( const NXString & carrierName )

Sets the tool carrier name
Created in NX9.0.3.

License requirements : None

Parameters

carrierName The new tool carrier name

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierName ( const char * carrierName )

Sets the tool carrier name
Created in NX9.0.3.

License requirements : None

Parameters

carrierName The new tool carrier name

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierRetraction	(	const NXString &	channelName,
		const NXString &	carrierName,
		int	newRetraction
	)

Sets the retraction for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newRetraction	The new swiveling mode

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierRetraction	(	const char *	channelName,
		const char *	carrierName,
		int	newRetraction
	)

Sets the retraction for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newRetraction	The new swiveling mode

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierSwivelMode	(	const NXString &	channelName,
		const NXString &	carrierName,
		int	newSwivelingMode
	)

Sets the swiveling mode for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newSwivelingMode	The new swiveling mode

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierSwivelMode	(	const char *	channelName,
		const char *	carrierName,
		int	newSwivelingMode
	)

Sets the swiveling mode for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newSwivelingMode	The new swiveling mode

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierXRetractionPosition	(	const NXString &	channelName,
		const NXString &	carrierName,
		double	newXPosition
	)

Sets the X retraction position for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newXPosition	The new X position

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierXRetractionPosition	(	const char *	channelName,
		const char *	carrierName,
		double	newXPosition
	)

Sets the X retraction position for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newXPosition	The new X position

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierYRetractionPosition	(	const NXString &	channelName,
		const NXString &	carrierName,
		double	newYPosition
	)

Sets the Y retraction position for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newYPosition	The new Y position

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierYRetractionPosition	(	const char *	channelName,
		const char *	carrierName,
		double	newYPosition
	)

Sets the Y retraction position for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newYPosition	The new Y position

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierZRetractionPosition	(	const NXString &	channelName,
		const NXString &	carrierName,
		double	newZPosition
	)

Sets the Z retraction position for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newZPosition	The new Z position

void NXOpen::SIM::MachineToolConfiguration::SetToolCarrierZRetractionPosition	(	const char *	channelName,
		const char *	carrierName,
		double	newZPosition
	)

Sets the Z retraction position for a tool carrier.

Created in NX10.0.3.

License requirements : None

Parameters

channelName	The channel to which the carrier belongs
carrierName	The name of the carrier to modify
newZPosition	The new Z position

void NXOpen::SIM::MachineToolConfiguration::SetToolRadiusCompensation ( bool newCompensationValue )

Sets the 3D Tool Radius Compensation information
Created in NX10.0.3.

License requirements : None

Parameters

newCompensationValue The new Tool Radius Compensation value

void NXOpen::SIM::MachineToolConfiguration::SetUsedUnit ( int newUsedUnit )

Sets the used unit
Created in NX10.0.3.

License requirements : None

Parameters

newUsedUnit The new used unit

NXString NXOpen::SIM::MachineToolConfiguration::ToolCarrierName ( )

Returns the tool carrier name
Created in NX9.0.3.

License requirements : None

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

SIM_MachineToolConfiguration.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation