KinematicSinumerikCaBuilder Class¶
-
class
NXOpen.SIM.
KinematicSinumerikCaBuilder
¶ Bases:
NXOpen.Builder
This class is used for edit sinumerik collision avoidance properties.
Calling
Builder.Commit
on this builder will only return None.Use the
KinematicConfigurator
class to create a KinematicSinumerikCaBuilder object.New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
DetailLevel | Returns or sets the detail level for this protection area |
MagazineIndex | Returns or sets the magazine index for this automatic protection area |
MagazineLocationIndex | Returns or sets the magazine location index for this automatic protection area |
PlcBit | Returns or sets the PLC bit for this protection area |
PlcInitState | Returns or sets the initial PLC state for this protection area |
PlcUsage | Returns or sets the PLC usage for this protection area |
TOIndex | Returns or sets the TO-index for this automatic protection area |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
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¶
KinematicSinumerikCaBuilderPlcInitStateTypes Enumeration | The init state types |
KinematicSinumerikCaBuilderPlcUsageTypes Enumeration | The usage types |
Property Detail¶
DetailLevel¶
-
KinematicSinumerikCaBuilder.
DetailLevel
¶ Returns or sets the detail level for this protection area
-------------------------------------
Getter Method
Signature
DetailLevel()
Returns: the detail level value 0-3 Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DetailLevel(level)
Parameters: level (int) – the detail value value 0-3 New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
MagazineIndex¶
-
KinematicSinumerikCaBuilder.
MagazineIndex
¶ Returns or sets the magazine index for this automatic protection area
-------------------------------------
Getter Method
Signature
MagazineIndex()
Returns: the magazine index Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MagazineIndex(index)
Parameters: index (int) – the magazine index New in version NX10.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
MagazineLocationIndex¶
-
KinematicSinumerikCaBuilder.
MagazineLocationIndex
¶ Returns or sets the magazine location index for this automatic protection area
-------------------------------------
Getter Method
Signature
MagazineLocationIndex()
Returns: the magazine location index Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MagazineLocationIndex(index)
Parameters: index (int) – the magazine location index New in version NX10.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
PlcBit¶
-
KinematicSinumerikCaBuilder.
PlcBit
¶ Returns or sets the PLC bit for this protection area
-------------------------------------
Getter Method
Signature
PlcBit()
Returns: the plc bit value 0-63 Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlcBit(bit)
Parameters: bit (int) – the plc bit value 0-63 New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
PlcInitState¶
-
KinematicSinumerikCaBuilder.
PlcInitState
¶ Returns or sets the initial PLC state for this protection area
-------------------------------------
Getter Method
Signature
PlcInitState()
Returns: the init state Return type: NXOpen.SIM.KinematicSinumerikCaBuilderPlcInitStateTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlcInitState(state)
Parameters: state ( NXOpen.SIM.KinematicSinumerikCaBuilderPlcInitStateTypes
) – the init stateNew in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
PlcUsage¶
-
KinematicSinumerikCaBuilder.
PlcUsage
¶ Returns or sets the PLC usage for this protection area
-------------------------------------
Getter Method
Signature
PlcUsage()
Returns: the usage Return type: NXOpen.SIM.KinematicSinumerikCaBuilderPlcUsageTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlcUsage(usage)
Parameters: usage ( NXOpen.SIM.KinematicSinumerikCaBuilderPlcUsageTypes
) – the usageNew in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
TOIndex¶
-
KinematicSinumerikCaBuilder.
TOIndex
¶ Returns or sets the TO-index for this automatic protection area
-------------------------------------
Getter Method
Signature
TOIndex()
Returns: the TO number Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TOIndex(index)
Parameters: index (int) – the TO number New in version NX10.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
Method Detail¶
Validate¶
-
KinematicSinumerikCaBuilder.
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.