KinematicComponentBuilder Class¶
-
class
NXOpen.SIM.
KinematicComponentBuilder
¶ Bases:
NXOpen.Builder
Represents the KinematicComponentBuilder class object
To create a new instance of this class, use
NXOpen.SIM.KinematicComponentCollection.CreateHeadBaseComponentBuilder()
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AdjustRegister | Returns or sets the adjust register |
AdjustRegisterType | Returns or sets the adjust register type |
CutcomRegister | Returns or sets the cutcom register |
CutcomRegisterType | Returns or sets the cutcom register type |
CutterId | Returns or sets the cutter id string to identify a cutter within a multitool |
DeviceId | Returns or sets the device id |
HolderId | Returns or sets the holder id |
HolderIdString | Returns or sets the holder id in string |
JunctionList | Returns the junction list |
Name | Returns or sets the kim component’s name |
NumberOfTools | Returns or sets the number of tools |
Tag | Returns the Tag for this object. |
WorkPositionAngle | Returns or sets the working position angle |
WorkPositionAngleType | Returns or sets the working position angle type |
Methods¶
Method | Description |
---|---|
AddChannelName | Adds a channel name to the component |
AddGeometry | Adds a single geometry element |
AddHoldingSystem | Adds a holding system to the component |
AddSystemClass | Add a system class |
AddUserClassName | Adds a user class to the component |
Commit | Commits any edits that have been applied to the builder. |
DeleteAllGeometries | Deletes all geometry elements from the component |
DeleteAllSystemClasses | Delete all system classes of the component |
DeleteChannelName | Deletes a channel name from the component |
DeleteGeometry | Deletes a single geometry element from the component |
DeleteHoldingSystem | Deletes a holding system from the component |
DeleteSystemClass | Delete a system class |
DeleteUserClassName | Deletes a user class from the component |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetChannelNames | Get a list of channel names of the component |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetGeometries | Returns the geometry elements assigned to this component |
GetHoldingSystems | Get a list of holding systems of the component |
GetObject | Returns the object currently being edited by this builder. |
GetSaveIpw | Does the system save an IPW with the component? |
GetSystemClasses | Returns the component’s system classes |
GetUserClassNames | Get a list of user classes of the component |
IsOfSystemClass | Test if the compomnent is a member of the given system class |
RenameChannelName | Renames a channel name from the component |
RenameHoldingSystem | Renames a holding system from the component |
RenameUserClass | Renames a user class from the component |
SetGeometries | Sets geometry elements for the component |
SetSaveIpw | Save an IPW with the component |
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¶
KinematicComponentBuilderRegisterTypes Enumeration | The register types |
KinematicComponentBuilderSystemClass Enumeration | The SIM KIM system classes |
KinematicComponentBuilderWorkPositionAngleTypes Enumeration | The Working Position Angle type |
Property Detail¶
AdjustRegister¶
-
KinematicComponentBuilder.
AdjustRegister
¶ Returns or sets the adjust register
-------------------------------------
Getter Method
Signature
AdjustRegister
Returns: the adjust regsiter Return type: int 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”)
-------------------------------------
Setter Method
Signature
AdjustRegister
Parameters: adjustReg (int) – the adjust regsiter 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”)
AdjustRegisterType¶
-
KinematicComponentBuilder.
AdjustRegisterType
¶ Returns or sets the adjust register type
-------------------------------------
Getter Method
Signature
AdjustRegisterType
Returns: the adjust register type Return type: NXOpen.SIM.KinematicComponentBuilderRegisterTypes
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”)
-------------------------------------
Setter Method
Signature
AdjustRegisterType
Parameters: regType ( NXOpen.SIM.KinematicComponentBuilderRegisterTypes
) – the adjust register typeNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
CutcomRegister¶
-
KinematicComponentBuilder.
CutcomRegister
¶ Returns or sets the cutcom register
-------------------------------------
Getter Method
Signature
CutcomRegister
Returns: the cutcom register Return type: int 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”)
-------------------------------------
Setter Method
Signature
CutcomRegister
Parameters: cutcomReg (int) – the cutcom register 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”)
CutcomRegisterType¶
-
KinematicComponentBuilder.
CutcomRegisterType
¶ Returns or sets the cutcom register type
-------------------------------------
Getter Method
Signature
CutcomRegisterType
Returns: the cutcom register type Return type: NXOpen.SIM.KinematicComponentBuilderRegisterTypes
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”)
-------------------------------------
Setter Method
Signature
CutcomRegisterType
Parameters: regType ( NXOpen.SIM.KinematicComponentBuilderRegisterTypes
) – the cutcom register typeNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
CutterId¶
-
KinematicComponentBuilder.
CutterId
¶ Returns or sets the cutter id string to identify a cutter within a multitool
-------------------------------------
Getter Method
Signature
CutterId
Returns: the cutter id string Return type: str New in version NX11.0.1.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------
Setter Method
Signature
CutterId
Parameters: cutterIdString (str) – the new cutter id string New in version NX11.0.1.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
DeviceId¶
-
KinematicComponentBuilder.
DeviceId
¶ Returns or sets the device id
-------------------------------------
Getter Method
Signature
DeviceId
Returns: the component’s device id Return type: 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”)
-------------------------------------
Setter Method
Signature
DeviceId
Parameters: deviceId (str) – the new device id 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”)
HolderId¶
-
KinematicComponentBuilder.
HolderId
¶ Returns or sets the holder id
-------------------------------------
Getter Method
Signature
HolderId
Returns: the holder id Return type: int 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”)
-------------------------------------
Setter Method
Signature
HolderId
Parameters: holderId (int) – the holder id 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”)
HolderIdString¶
-
KinematicComponentBuilder.
HolderIdString
¶ Returns or sets the holder id in string
-------------------------------------
Getter Method
Signature
HolderIdString
Returns: the holder id in string Return type: str New in version NX7.5.5.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
-------------------------------------
Setter Method
Signature
HolderIdString
Parameters: holderIdString (str) – the new holder id in string New in version NX7.5.5.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
JunctionList¶
-
KinematicComponentBuilder.
JunctionList
¶ Returns the junction list
-------------------------------------
Getter Method
Signature
JunctionList
Returns: Return type: NXOpen.SIM.KinematicJunctionBuilderList
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”)
Name¶
-
KinematicComponentBuilder.
Name
¶ Returns or sets the kim component’s name
-------------------------------------
Getter Method
Signature
Name
Returns: The component’s name Return type: 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”)
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – the component’s new 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”)
NumberOfTools¶
-
KinematicComponentBuilder.
NumberOfTools
¶ Returns or sets the number of tools
-------------------------------------
Getter Method
Signature
NumberOfTools
Returns: the max number of tools Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfTools
Parameters: numTools (int) – the number of tools New in version NX8.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
WorkPositionAngle¶
-
KinematicComponentBuilder.
WorkPositionAngle
¶ Returns or sets the working position angle
-------------------------------------
Getter Method
Signature
WorkPositionAngle
Returns: the working position angle Return type: float 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”)
-------------------------------------
Setter Method
Signature
WorkPositionAngle
Parameters: angle (float) – the working position angle 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”)
WorkPositionAngleType¶
-
KinematicComponentBuilder.
WorkPositionAngleType
¶ Returns or sets the working position angle type
-------------------------------------
Getter Method
Signature
WorkPositionAngleType
Returns: The working position angle type Return type: NXOpen.SIM.KinematicComponentBuilderWorkPositionAngleTypes
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”)
-------------------------------------
Setter Method
Signature
WorkPositionAngleType
Parameters: type ( NXOpen.SIM.KinematicComponentBuilderWorkPositionAngleTypes
) – The working position angle typeNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
Method Detail¶
AddChannelName¶
-
KinematicComponentBuilder.
AddChannelName
¶ Adds a channel name to the component
Signature
AddChannelName(channel)
Parameters: channel (str) – The channel name to add 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”)
AddGeometry¶
-
KinematicComponentBuilder.
AddGeometry
¶ Adds a single geometry element
Signature
AddGeometry(geo)
Parameters: geo ( NXOpen.NXObject
) – The geometry element to addNew 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”)
AddHoldingSystem¶
-
KinematicComponentBuilder.
AddHoldingSystem
¶ Adds a holding system to the component
Signature
AddHoldingSystem(holdSys)
Parameters: holdSys (str) – The holding system to add 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”)
AddSystemClass¶
-
KinematicComponentBuilder.
AddSystemClass
¶ Add a system class
Signature
AddSystemClass(sysClass)
Parameters: sysClass ( NXOpen.SIM.KinematicComponentBuilderSystemClass
) – the system class to addNew 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”)
AddUserClassName¶
-
KinematicComponentBuilder.
AddUserClassName
¶ Adds a user class to the component
Signature
AddUserClassName(uclass)
Parameters: uclass (str) – The user cass to add 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”)
DeleteAllGeometries¶
-
KinematicComponentBuilder.
DeleteAllGeometries
¶ Deletes all geometry elements from the component
Signature
DeleteAllGeometries()
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”)
DeleteAllSystemClasses¶
-
KinematicComponentBuilder.
DeleteAllSystemClasses
¶ Delete all system classes of the component
Signature
DeleteAllSystemClasses()
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”)
DeleteChannelName¶
-
KinematicComponentBuilder.
DeleteChannelName
¶ Deletes a channel name from the component
Signature
DeleteChannelName(channel)
Parameters: channel (str) – The channel name 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”)
DeleteGeometry¶
-
KinematicComponentBuilder.
DeleteGeometry
¶ Deletes a single geometry element from the component
Signature
DeleteGeometry(geo)
Parameters: geo ( NXOpen.NXObject
) – The geometry to removeNew 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¶
-
KinematicComponentBuilder.
DeleteHoldingSystem
¶ Deletes a holding system from the component
Signature
DeleteHoldingSystem(holdSys)
Parameters: holdSys (str) – The holding system 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”)
DeleteSystemClass¶
-
KinematicComponentBuilder.
DeleteSystemClass
¶ Delete a system class
Signature
DeleteSystemClass(sysClasses)
Parameters: sysClasses ( NXOpen.SIM.KinematicComponentBuilderSystemClass
) – the system class to deleteNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
DeleteUserClassName¶
-
KinematicComponentBuilder.
DeleteUserClassName
¶ Deletes a user class from the component
Signature
DeleteUserClassName(uclass)
Parameters: uclass (str) – The user cass 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”)
GetChannelNames¶
-
KinematicComponentBuilder.
GetChannelNames
¶ Get a list of channel names of the component
Signature
GetChannelNames()
Returns: The channel names of the component 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”)
GetGeometries¶
-
KinematicComponentBuilder.
GetGeometries
¶ Returns the geometry elements assigned to this component
Signature
GetGeometries()
Returns: The geometry elements Return type: list of NXOpen.NXObject
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¶
-
KinematicComponentBuilder.
GetHoldingSystems
¶ Get a list of holding systems of the component
Signature
GetHoldingSystems()
Returns: The channel names of the component 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”)
GetSaveIpw¶
-
KinematicComponentBuilder.
GetSaveIpw
¶ Does the system save an IPW with the component?
Signature
GetSaveIpw()
Returns: Return type: bool New in version NX11.0.1.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)
GetSystemClasses¶
-
KinematicComponentBuilder.
GetSystemClasses
¶ Returns the component’s system classes
Signature
GetSystemClasses()
Returns: the component’s system classes Return type: list of NXOpen.SIM.KinematicComponentBuilderSystemClass
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”)
GetUserClassNames¶
-
KinematicComponentBuilder.
GetUserClassNames
¶ Get a list of user classes of the component
Signature
GetUserClassNames()
Returns: The user classes of the component 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”)
IsOfSystemClass¶
-
KinematicComponentBuilder.
IsOfSystemClass
¶ Test if the compomnent is a member of the given system class
Signature
IsOfSystemClass(sysClass)
Parameters: sysClass ( NXOpen.SIM.KinematicComponentBuilderSystemClass
) – the system class to testReturns: TRUE if component is of the system class Return type: bool 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”)
RenameChannelName¶
-
KinematicComponentBuilder.
RenameChannelName
¶ Renames a channel name from the component
Signature
RenameChannelName(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¶
-
KinematicComponentBuilder.
RenameHoldingSystem
¶ Renames a holding system from the component
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”)
RenameUserClass¶
-
KinematicComponentBuilder.
RenameUserClass
¶ Renames a user class from the component
Signature
RenameUserClass(oldName, newName)
Parameters: - oldName (str) – The old user class
- newName (str) – The new user class
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”)
SetGeometries¶
-
KinematicComponentBuilder.
SetGeometries
¶ Sets geometry elements for the component
Signature
SetGeometries(geos)
Parameters: geos (list of NXOpen.NXObject
) – the geometry elementsNew in version NX7.5.0.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)
SetSaveIpw¶
-
KinematicComponentBuilder.
SetSaveIpw
¶ Save an IPW with the component
Signature
SetSaveIpw(saveIpw)
Parameters: saveIpw (bool) – New in version NX11.0.1.
License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”)
Validate¶
-
KinematicComponentBuilder.
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.