KinematicConfigurator Class¶

class NXOpen.SIM.KinematicConfigurator¶

Bases: NXOpen.NXObject

Represents the ISV base class object

To obtain an instance of this class, use NXOpen.Part.KinematicConfigurator()

New in version NX7.5.0.

Properties¶

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
IsvControlPanelBuilder	Returns the isv control panel builder
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.
ComponentCollection	Returns the ComponentCollection instance belonging to this SimKim

Methods¶

Method	Description
AddChannel	Adds a new user channel name to the list of channels
AddHoldingSystem	Adds a new user holding system to the list of holding systems
AddUserClassification	Adds a new user class name to the list of user classes
CopyKinematicModel	Copy a kinematic model.
CreateArchiveImportBuilder	Creates a builder to import a Sinumerik archive file
CreateAttributeIterator	Create an attribute iterator
CreateAxisBuilder	Creates a builder for a kinematic axis
CreateChannelConfigurationBuilder	Creates a builder for a kinematic channel configurator
CreateCollisionPairBuilder	Creates a collision pair builder
CreateConvertFromMcdBuilder	Creates a builder to convert from MCD
CreateImportMcfBuilder	Creates a builder for a import axis and channel data from mcf
CreateIsvControlPanelBuilder	Creates an isv control panel builder
CreateJunctionBuilder	Creates a builder for a kinematic junction
CreateKinematicChain	Creates a builder for a kinematic chain
CreateKinematicChannelBuilder	Creates a builder for a channel
CreateKinematicSinumerikCaBuilder	Creates a builder for a kinematic sinumerik ca config
CreateMachineKitBuilder	Creates a builder for the machine tool kit
CreateMachineLibraryBuilder	Creates a builder for the machine tool Library dialog
CreateMachineToolConfigurationBuilder	Creates a builder for the Machine Tool Configuration
CreateNcChannelSelectionData	Creates an NcChannelSelectionData object to which files and channels can be assigned.
CreateNcProgramManagerBuilder	Creates a builder for the nc program manager
CreateSimDebugBuilder	Creates a sim debug builder
CreateSimulationLoadsnapshotBuilder	Creates a builder for the load snapshot
CreateSimulationOptionsBuilder	Creates a simulation options
CreateSimulationSavesnapshotBuilder	Creates a builder for the save snapshot
CreateSinumerikCaExportBuilder	Creates a builder for a sinumerik ca export spf
CreateSinumerikCaFacetBuilder	Creates a builder for a sinumerik ca facet
CreateSinumerikCaPlaceholderBuilder	Creates a builder for a sinumerik ca placeholder
CreateSinumerikCaSimplifyBodiesBuilder	Creates a builder for a sinumerik ca simplify bodies
CreateSpinningClone	Creates a copy of the given component and spins its assigned geometry around a spinning axis.
DefineKinematicChains	Creates a builder for a kinematic chain configurator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAllChannels	Deletes all channels from the kinematic model
DeleteAllHoldingSystems	Delete all holding systems from the kinematic model
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteAxis	Deletes the given axis
DeleteChannel	Deletes a channel name from the list of channels
DeleteComponent	Deletes the given component
DeleteHoldingSystem	Delete a holding system from the list
DeleteJunction	Deletes the given junction
DeleteKinematicModel	Delete the copy of kinematic model.
DeleteModel	Deletes the entire kinematic model
DeleteRootComponent	Delete a root component from the `NXOpen.SIM.KinematicConfigurator` object
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
DeleteUserClassification	Deletes a user class name from the list of user classes
ExportMachineKitBuilder	Creates a builder for export the machine tool kit
FindAxis	Find the axis with the given name
FindComponentsBySystemClass	Finds component which are of the given system class in bitwise
FindJunction	Find the junction with the given name
FindObject	Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
FindOwnerOfJunction	Finds the `NXOpen.SIM.KinematicComponent` which is the owner of this junction
FindParentComponent	Finds the `NXOpen.SIM.KinematicComponent` which is the parent of this component
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetAxes	Gets a list of all axes in the kinematic
GetAxisNames	Gets a list of all axis names in the kinematic
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetChannels	Get a list of all channels
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetHoldingSystems	Get a list of all holding systems
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetJunctionNames	Gets a list of all junction names in the kinematic
GetJunctions	Gets a list of all junctions in the kinematic
GetName	Returns the custom name of the kinematic model
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
GetUserClassifications	Get a list of all user classes
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
ImportMachineKitBuilder	Creates a builder for import the machine tool kit
ImportNcArchive	Import the nc archive for the Machine Tool Configuration
InsertRootComponent	Adds a new root component to the `NXOpen.SIM.KinematicConfigurator` object
Print	Prints a representation of this object to the system log file.
RenameChannel	Renames a channel name from the list
RenameHoldingSystem	Renames a holding system from the list
RenameUserClassification	Renames a user class name from the list
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetName	Sets the custom name of the kinematic model
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.

Enumerations¶

KinematicConfiguratorUniteTypes Enumeration

The unite types for spinning geometries

Property Detail¶

IsOccurrence¶

KinematicConfigurator.IsOccurrence¶

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:	This object is an occurrence
Return type:	bool

New in version NX3.0.0.

License requirements: None.

IsvControlPanelBuilder¶

KinematicConfigurator.IsvControlPanelBuilder¶

Returns the isv control panel builder

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

Getter Method

Signature IsvControlPanelBuilder

Returns:	the isv control panel builder
Return type:	`NXOpen.SIM.IsvControlPanelBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

JournalIdentifier¶

KinematicConfigurator.JournalIdentifier¶

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns:
Return type:	str

New in version NX3.0.0.

License requirements: None.

Name¶

KinematicConfigurator.Name¶

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns:
Return type:	str

New in version NX3.0.0.

License requirements: None.

OwningComponent¶

KinematicConfigurator.OwningComponent¶

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns:
Return type:	`NXOpen.Assemblies.Component`

New in version NX3.0.0.

License requirements: None.

OwningPart¶

KinematicConfigurator.OwningPart¶

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:	The owning part of this object or null if it does not have an owner
Return type:	`NXOpen.BasePart`

New in version NX3.0.0.

License requirements: None.

Prototype¶

KinematicConfigurator.Prototype¶

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:	The prototype of this object or null if this object is not an occurrence
Return type:	`NXOpen.INXObject`

New in version NX3.0.0.

License requirements: None.

ComponentCollection¶

KinematicConfigurator.ComponentCollection¶

Returns the ComponentCollection instance belonging to this SimKim

Signature ComponentCollection

New in version NX7.5.0.

Returns:
Return type:	`NXOpen.SIM.KinematicComponentCollection`

Method Detail¶

AddChannel¶

KinematicConfigurator.AddChannel¶

Adds a new user channel name to the list of channels

Signature AddChannel(channel)

Parameters:	channel (str) – The new channel name.

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

AddHoldingSystem¶

KinematicConfigurator.AddHoldingSystem¶

Adds a new user holding system to the list of holding systems

Signature AddHoldingSystem(holdSys)

Parameters:	holdSys (str) – The new holding system.

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

AddUserClassification¶

KinematicConfigurator.AddUserClassification¶

Adds a new user class name to the list of user classes

Signature AddUserClassification(userClass)

Parameters:	userClass (str) – The new user class name

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CopyKinematicModel¶

KinematicConfigurator.CopyKinematicModel¶

Copy a kinematic model.

User need to call NXOpen.SIM.KinematicConfigurator.DeleteKinematicModel() to delete the copy of kinematic model.

Signature CopyKinematicModel()

Returns:	The copy of kinematic model
Return type:	`NXOpen.SIM.KinematicModel`

New in version NX10.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateArchiveImportBuilder¶

KinematicConfigurator.CreateArchiveImportBuilder¶

Creates a builder to import a Sinumerik archive file

Signature CreateArchiveImportBuilder()

Returns:	The new CamtImport builder
Return type:	`NXOpen.SIM.ArchiveImportBuilder`

New in version NX9.0.3.

License requirements: nx_isv_mtb (“Machine Tool Builder”)

CreateAxisBuilder¶

KinematicConfigurator.CreateAxisBuilder¶

Creates a builder for a kinematic axis

Signature CreateAxisBuilder(parent, jct, axis)

Parameters:	parent (`NXOpen.SIM.KinematicComponent`) – The parent component jct (`NXOpen.SIM.KinematicJunction`) – The junction used for the axis axis (`NXOpen.SIM.KinematicAxis`) – The axis to edit. If NULL, a new axis is craeted
Returns:	The new axis builder
Return type:	`NXOpen.SIM.KinematicAxisBuilder`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateChannelConfigurationBuilder¶

KinematicConfigurator.CreateChannelConfigurationBuilder¶

Creates a builder for a kinematic channel configurator

Signature CreateChannelConfigurationBuilder()

Returns:	The new kinematic channel configuration builder
Return type:	`NXOpen.SIM.KinematicChannelConfigurationBuilder`

New in version NX9.0.3.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateCollisionPairBuilder¶

KinematicConfigurator.CreateCollisionPairBuilder¶

Creates a collision pair builder

Signature CreateCollisionPairBuilder()

Returns:	The new collision pair builder
Return type:	`NXOpen.CAM.CollisionPairBuilder`

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateConvertFromMcdBuilder¶

KinematicConfigurator.CreateConvertFromMcdBuilder¶

Creates a builder to convert from MCD

Signature CreateConvertFromMcdBuilder()

Returns:	The new convert from mcd builder
Return type:	`NXOpen.CAM.ConvertFromMCDBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateImportMcfBuilder¶

KinematicConfigurator.CreateImportMcfBuilder¶

Creates a builder for a import axis and channel data from mcf

Signature CreateImportMcfBuilder()

Returns:	The import axis and channel data builder
Return type:	`NXOpen.SIM.KinematicImportMcfBuilder`

New in version NX9.0.3.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateIsvControlPanelBuilder¶

KinematicConfigurator.CreateIsvControlPanelBuilder¶

Overloaded method CreateIsvControlPanelBuilder

CreateIsvControlPanelBuilder(driverType, objects)
CreateIsvControlPanelBuilder(driverType, filename)
CreateIsvControlPanelBuilder(driverType, channelData)

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

Creates an isv control panel builder

Signature CreateIsvControlPanelBuilder(driverType, objects)

Parameters:	driverType (`NXOpen.SIM.IsvControlPanelBuilderVisualizationType`) – The visualization type objects (list of `NXOpen.CAM.CAMObject`) – array of objects
Returns:	The isv control panel builder
Return type:	`NXOpen.SIM.IsvControlPanelBuilder`

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

Creates an isv control panel builder with given machine code file name.

Signature CreateIsvControlPanelBuilder(driverType, filename)

Parameters:	driverType (`NXOpen.SIM.IsvControlPanelBuilderVisualizationType`) – The visualization type filename (str) – The full path machine code filename
Returns:	The isv control panel builder
Return type:	`NXOpen.SIM.IsvControlPanelBuilder`

New in version NX8.0.0.

Deprecated since version NX9.0.0: Use NXOpen.SIM.KinematicConfigurator.CreateIsvControlPanelBuilder() with NXOpen.SIM.KinematicConfigurator.CreateNcChannelSelectionData() instead.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

Creates an isv control panel builder with given machine code file name.

Signature CreateIsvControlPanelBuilder(driverType, channelData)

Parameters:	driverType (`NXOpen.SIM.IsvControlPanelBuilderVisualizationType`) – The visualization type channelData (`NXOpen.SIM.NcChannelSelectionData`) – The NC channel selection data
Returns:	The isv control panel builder
Return type:	`NXOpen.SIM.IsvControlPanelBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

CreateJunctionBuilder¶

KinematicConfigurator.CreateJunctionBuilder¶

Creates a builder for a kinematic junction

Signature CreateJunctionBuilder(parent, jct)

Parameters:	parent (`NXOpen.SIM.KinematicComponent`) – The parent component jct (`NXOpen.SIM.KinematicJunction`) – The junction to edit. If NULL, a new junction is created
Returns:	The new junction builder
Return type:	`NXOpen.SIM.KinematicJunctionBuilder`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

CreateKinematicChain¶

KinematicConfigurator.CreateKinematicChain¶

Creates a builder for a kinematic chain

Signature CreateKinematicChain()

Returns:	The new kinematic chain builder
Return type:	`NXOpen.SIM.KinematicChain`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateKinematicChannelBuilder¶

KinematicConfigurator.CreateKinematicChannelBuilder¶

Creates a builder for a channel

Signature CreateKinematicChannelBuilder()

Returns:	The new kinematic channel builder
Return type:	`NXOpen.SIM.KinematicChannelBuilder`

New in version NX9.0.3.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateKinematicSinumerikCaBuilder¶

KinematicConfigurator.CreateKinematicSinumerikCaBuilder¶

Creates a builder for a kinematic sinumerik ca config

Signature CreateKinematicSinumerikCaBuilder(comp)

Parameters:	comp (`NXOpen.SIM.KinematicComponent`) – the component to edit
Returns:	The new kinematic sinumerik ca builder
Return type:	`NXOpen.SIM.KinematicSinumerikCaBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateMachineKitBuilder¶

KinematicConfigurator.CreateMachineKitBuilder¶

Creates a builder for the machine tool kit

Signature CreateMachineKitBuilder()

Returns:	The machine kit builder
Return type:	`NXOpen.SIM.MachineKitBuilder`

New in version NX10.0.2.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateMachineLibraryBuilder¶

KinematicConfigurator.CreateMachineLibraryBuilder¶

Creates a builder for the machine tool Library dialog

Signature CreateMachineLibraryBuilder()

Returns:	The machine Library builder
Return type:	`NXOpen.SIM.MachineLibraryBuilder`

New in version NX10.0.2.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateMachineToolConfigurationBuilder¶

KinematicConfigurator.CreateMachineToolConfigurationBuilder¶

Creates a builder for the Machine Tool Configuration

Signature CreateMachineToolConfigurationBuilder()

Returns:	The new machine tool configuration builder
Return type:	`NXOpen.SIM.MachineToolConfiguration`

New in version NX9.0.3.

License requirements: nx_isv_mtb (“Machine Tool Builder”)

CreateNcChannelSelectionData¶

KinematicConfigurator.CreateNcChannelSelectionData¶

Creates an NcChannelSelectionData object to which files and channels can be assigned.

This is used when constructing the builder.

Signature CreateNcChannelSelectionData()

Returns:	The NC channel selection data
Return type:	`NXOpen.SIM.NcChannelSelectionData`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateNcProgramManagerBuilder¶

KinematicConfigurator.CreateNcProgramManagerBuilder¶

Creates a builder for the nc program manager

Signature CreateNcProgramManagerBuilder()

Returns:	The nc program manager builder
Return type:	`NXOpen.SIM.NcProgramManagerBuilder`

New in version NX11.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSimDebugBuilder¶

KinematicConfigurator.CreateSimDebugBuilder¶

Creates a sim debug builder

Signature CreateSimDebugBuilder()

Returns:	The new sim debug builder
Return type:	`NXOpen.SIM.SimDebugBuilder`

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSimulationLoadsnapshotBuilder¶

KinematicConfigurator.CreateSimulationLoadsnapshotBuilder¶

Creates a builder for the load snapshot

Signature CreateSimulationLoadsnapshotBuilder()

Returns:	The load snapshot builder
Return type:	`NXOpen.SIM.LoadSnapshotBuilder`

New in version NX12.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSimulationOptionsBuilder¶

KinematicConfigurator.CreateSimulationOptionsBuilder¶

Creates a simulation options

Signature CreateSimulationOptionsBuilder(dialogType)

Parameters:	dialogType (`NXOpen.CAM.SimulationOptionsBuilderDialogType`) – The dialog type
Returns:	The new simulation options
Return type:	`NXOpen.CAM.SimulationOptionsBuilder`

New in version NX8.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSimulationSavesnapshotBuilder¶

KinematicConfigurator.CreateSimulationSavesnapshotBuilder¶

Creates a builder for the save snapshot

Signature CreateSimulationSavesnapshotBuilder()

Returns:	The save snapshot builder
Return type:	`NXOpen.SIM.SaveSnapshotBuilder`

New in version NX12.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSinumerikCaExportBuilder¶

KinematicConfigurator.CreateSinumerikCaExportBuilder¶

Creates a builder for a sinumerik ca export spf

Signature CreateSinumerikCaExportBuilder()

Returns:	The new sinumerik ca export builder
Return type:	`NXOpen.SIM.SinumerikCaExportBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSinumerikCaFacetBuilder¶

KinematicConfigurator.CreateSinumerikCaFacetBuilder¶

Creates a builder for a sinumerik ca facet

Signature CreateSinumerikCaFacetBuilder()

Returns:	The new sinumerik ca facet builder
Return type:	`NXOpen.SIM.SinumerikCaFacetBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSinumerikCaPlaceholderBuilder¶

KinematicConfigurator.CreateSinumerikCaPlaceholderBuilder¶

Creates a builder for a sinumerik ca placeholder

Signature CreateSinumerikCaPlaceholderBuilder()

Returns:	The new sinumerik ca placeholder builder
Return type:	`NXOpen.SIM.SinumerikCaPlaceholderBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSinumerikCaSimplifyBodiesBuilder¶

KinematicConfigurator.CreateSinumerikCaSimplifyBodiesBuilder¶

Creates a builder for a sinumerik ca simplify bodies

Signature CreateSinumerikCaSimplifyBodiesBuilder()

Returns:	The new sinumerik ca simplify bodies builder
Return type:	`NXOpen.SIM.SinumerikCaSimplifyBodiesBuilder`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

CreateSpinningClone¶

KinematicConfigurator.CreateSpinningClone¶

Creates a copy of the given component and spins its assigned geometry around a spinning axis.

For tool components, the X-axis of the tool tip junction is used as spinning axis. If none is defined and for other types of components, the X-axis of the WCS is used. The new component has the same parent as the source component.

Signature CreateSpinningClone(source, combine)

Parameters:	source (`NXOpen.SIM.KinematicComponent`) – The source component. combine (bool) – Specifies whether to combine the spinning geometries into one, or not
Returns:	The new spinning component
Return type:	`NXOpen.SIM.KinematicComponent`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

DefineKinematicChains¶

KinematicConfigurator.DefineKinematicChains¶

Creates a builder for a kinematic chain configurator

Signature DefineKinematicChains()

Returns:	The new kinematic chain configuration builder
Return type:	`NXOpen.SIM.KinematicChainConfiguration`

New in version NX9.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteAllChannels¶

KinematicConfigurator.DeleteAllChannels¶

Deletes all channels from the kinematic model

Signature DeleteAllChannels()

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteAllHoldingSystems¶

KinematicConfigurator.DeleteAllHoldingSystems¶

Delete all holding systems from the kinematic model

Signature DeleteAllHoldingSystems()

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteAxis¶

KinematicConfigurator.DeleteAxis¶

Deletes the given axis

Signature DeleteAxis(axis)

Parameters:	axis (`NXOpen.SIM.KinematicAxis`) – the component to delete

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteChannel¶

KinematicConfigurator.DeleteChannel¶

Deletes a channel name from the list of channels

Signature DeleteChannel(channel)

Parameters:	channel (str) – The channel name to delete.

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteComponent¶

KinematicConfigurator.DeleteComponent¶

Deletes the given component

Signature DeleteComponent(comp)

Parameters:	comp (`NXOpen.SIM.KinematicComponent`) – the component to delete

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteHoldingSystem¶

KinematicConfigurator.DeleteHoldingSystem¶

Delete a holding system from the list

Signature DeleteHoldingSystem(holdSys)

Parameters:	holdSys (str) – The holding system to delete.

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteJunction¶

KinematicConfigurator.DeleteJunction¶

Deletes the given junction

Signature DeleteJunction(jct)

Parameters:	jct (`NXOpen.SIM.KinematicJunction`) – the component to delete

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteKinematicModel¶

KinematicConfigurator.DeleteKinematicModel¶

Delete the copy of kinematic model.

Signature DeleteKinematicModel(kimModel)

Parameters:	kimModel (`NXOpen.SIM.KinematicModel`) – The copy of kinematic model

New in version NX10.0.1.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteModel¶

KinematicConfigurator.DeleteModel¶

Deletes the entire kinematic model

Signature DeleteModel()

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteRootComponent¶

KinematicConfigurator.DeleteRootComponent¶

Delete a root component from the NXOpen.SIM.KinematicConfigurator object

Signature DeleteRootComponent(oldRoot)

Parameters:	oldRoot (`NXOpen.SIM.KinematicComponent`) – The root component to remove

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

DeleteUserClassification¶

KinematicConfigurator.DeleteUserClassification¶

Deletes a user class name from the list of user classes

Signature DeleteUserClassification(userClass)

Parameters:	userClass (str) – The user class name to delete.

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

ExportMachineKitBuilder¶

KinematicConfigurator.ExportMachineKitBuilder¶

Creates a builder for export the machine tool kit

Signature ExportMachineKitBuilder(machineName)

Parameters:	machineName (str) – The library reference (libref) of the machine to export
Returns:	The machine kit builder
Return type:	`NXOpen.SIM.ExportMachineKitBuilder`

New in version NX11.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

FindAxis¶

KinematicConfigurator.FindAxis¶

Find the axis with the given name

Signature FindAxis(name)

Parameters:	name (str) – The name to look for
Returns:	a tuple
Return type:	A tuple consisting of (axis, pComp, pJct). axis is a `NXOpen.SIM.KinematicAxis`. The axis, if found pComp is a `NXOpen.SIM.KinematicComponent`. The parent component of the axis pJct is a `NXOpen.SIM.KinematicJunction`. The parent junction of the axis

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

FindComponentsBySystemClass¶

KinematicConfigurator.FindComponentsBySystemClass¶

Overloaded method FindComponentsBySystemClass

FindComponentsBySystemClass(sysclass)
FindComponentsBySystemClass(sysclass)

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

Finds component which are of the given system class in bitwise

Signature FindComponentsBySystemClass(sysclass)

Parameters:	sysclass (int) – The system class to look for in bitwise.
Returns:	The found components
Return type:	list of `NXOpen.SIM.KinematicComponent`

New in version NX7.5.0.

Deprecated since version NX8.0.3: Use FindComponentsBySystemClass() with NXOpen.SIM.KinematicComponentBuilderSystemClass instead.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

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

Finds component which are of the given system class

Signature FindComponentsBySystemClass(sysclass)

Parameters:	sysclass (`NXOpen.SIM.KinematicComponentBuilderSystemClass`) – The system class to look for.
Returns:	The found components
Return type:	list of `NXOpen.SIM.KinematicComponent`

New in version NX8.0.3.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

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

FindJunction¶

KinematicConfigurator.FindJunction¶

Overloaded method FindJunction

FindJunction(name)
FindJunction(csys)

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

Find the junction with the given name

Signature FindJunction(name)

Parameters:	name (str) – The name to look for
Returns:	The junction, if found
Return type:	`NXOpen.SIM.KinematicJunction`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

Finds a junction by its coordinate system

Signature FindJunction(csys)

Parameters:	csys (`NXOpen.NXObject`) – the csys of a junction
Returns:	The junction for the csys
Return type:	`NXOpen.SIM.KinematicJunction`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

FindObject¶

KinematicConfigurator.FindObject¶

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:	journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:	`NXOpen.INXObject`

New in version NX3.0.0.

License requirements: None.

FindOwnerOfJunction¶

KinematicConfigurator.FindOwnerOfJunction¶

Finds the NXOpen.SIM.KinematicComponent which is the owner of this junction

Signature FindOwnerOfJunction(jct)

Parameters:	jct (`NXOpen.SIM.KinematicJunction`) – The junction
Returns:	The owning component of the junction
Return type:	`NXOpen.SIM.KinematicComponent`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

FindParentComponent¶

KinematicConfigurator.FindParentComponent¶

Finds the NXOpen.SIM.KinematicComponent which is the parent of this component

Signature FindParentComponent(comp)

Parameters:	comp (`NXOpen.SIM.KinematicComponent`) – The component
Returns:	The parent Component.

NULL if comp is root component :rtype: NXOpen.SIM.KinematicComponent

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

GetAxes¶

KinematicConfigurator.GetAxes¶

Gets a list of all axes in the kinematic

Signature GetAxes()

Returns:	The list of axes
Return type:	list of `NXOpen.SIM.KinematicAxis`

New in version NX11.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

GetAxisNames¶

KinematicConfigurator.GetAxisNames¶

Gets a list of all axis names in the kinematic

Signature GetAxisNames()

Returns:	The list of axis names
Return type:	list of str

New in version NX11.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

GetChannels¶

KinematicConfigurator.GetChannels¶

Get a list of all channels

Signature GetChannels()

Returns:	The list of channels
Return type:	list of str

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

GetHoldingSystems¶

KinematicConfigurator.GetHoldingSystems¶

Get a list of all holding systems

Signature GetHoldingSystems()

Returns:	The holding systems
Return type:	list of str

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

GetJunctionNames¶

KinematicConfigurator.GetJunctionNames¶

Gets a list of all junction names in the kinematic

Signature GetJunctionNames()

Returns:	The list of junction names
Return type:	list of str

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

GetJunctions¶

KinematicConfigurator.GetJunctions¶

Gets a list of all junctions in the kinematic

Signature GetJunctions()

Returns:	The list of junctions
Return type:	list of `NXOpen.SIM.KinematicJunction`

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

GetName¶

KinematicConfigurator.GetName¶

Returns the custom name of the kinematic model

Signature GetName()

Returns:	The kinematic model name
Return type:	str

New in version NX11.0.2.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)

GetUserClassifications¶

KinematicConfigurator.GetUserClassifications¶

Get a list of all user classes

Signature GetUserClassifications()

Returns:	The list of user classes
Return type:	list of str

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

ImportMachineKitBuilder¶

KinematicConfigurator.ImportMachineKitBuilder¶

Creates a builder for import the machine tool kit

Signature ImportMachineKitBuilder(kitPath)

Parameters:	kitPath (str) – path of the machine tool kit file
Returns:	The import machine kit builder
Return type:	`NXOpen.SIM.ImportMachineKitBuilder`

New in version NX11.0.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

ImportNcArchive¶

KinematicConfigurator.ImportNcArchive¶

Import the nc archive for the Machine Tool Configuration

Signature ImportNcArchive(ncFileName, printReport)

Parameters:	ncFileName (str) – The path to the nc archive file printReport (bool) – Print the report

New in version NX11.0.2.

License requirements: nx_isv_mtb (“Machine Tool Builder”)

InsertRootComponent¶

KinematicConfigurator.InsertRootComponent¶

Adds a new root component to the NXOpen.SIM.KinematicConfigurator object

Signature InsertRootComponent(newRoot)

Parameters:	newRoot (`NXOpen.SIM.KinematicComponent`) – The new root component

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

Print¶

KinematicConfigurator.Print¶

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RenameChannel¶

KinematicConfigurator.RenameChannel¶

Renames a channel name from the list

Signature RenameChannel(oldName, newName)

Parameters:	oldName (str) – The old channel name newName (str) – The new channel name

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

RenameHoldingSystem¶

KinematicConfigurator.RenameHoldingSystem¶

Renames a holding system from the list

Signature RenameHoldingSystem(oldName, newName)

Parameters:	oldName (str) – The old holding system newName (str) – The new holding system

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

RenameUserClassification¶

KinematicConfigurator.RenameUserClassification¶

Renames a user class name from the list

Signature RenameUserClassification(oldName, newName)

Parameters:	oldName (str) – The old user class name newName (str) – The new user class name

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

SetName¶

KinematicConfigurator.SetName¶

Sets the custom name of the kinematic model

Signature SetName(name)

Parameters:	name (str) – The new kinematic model name

New in version NX7.5.0.

License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”) OR resource_manager_nx (“Teamcenter Resource Manager”)