MachinePocketGroupBuilder Class¶
-
class
NXOpen.CAM.
MachinePocketGroupBuilder
¶ Bases:
NXOpen.CAM.NCGroupBuilder
Represents a MachinePocketGroup Builder
To create a new instance of this class, use
NXOpen.CAM.NCGroupCollection.CreateMachinePocketGroupBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AdjustIdBuilder | Returns the adjust id |
AdjustRegisterType | Returns or sets the adjust register type |
ChannelName | Returns or sets the channel’s name |
CutcomIdBuilder | Returns the cutcom id |
CutcomRegisterType | Returns or sets the cutcom register type |
CycleEvent | Returns the cycle event |
CycleTable | Returns the cycle |
Description | Returns or sets the description |
EndUdeSet | Returns the end ude set |
HoldingSystemsList | Returns the holding systems list |
NumberOfTools | Returns or sets the number of tools |
OptimizationMethod | Returns or sets the optim method |
PocketIdBuilder | Returns the pocket id |
PocketIdStringBuilder | Returns the pocket id in string |
StartUdeSet | Returns the start ude set |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateHoldingSystemBuilder | Creates a new holding system builder @return holding system 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¶
MachinePocketGroupBuilderRegisterType Enumeration | the register type |
Property Detail¶
AdjustIdBuilder¶
-
MachinePocketGroupBuilder.
AdjustIdBuilder
¶ Returns the adjust id
-------------------------------------
Getter Method
Signature
AdjustIdBuilder()
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX6.0.0.
License requirements: None.
AdjustRegisterType¶
-
MachinePocketGroupBuilder.
AdjustRegisterType
¶ Returns or sets the adjust register type
-------------------------------------
Getter Method
Signature
AdjustRegisterType()
Returns: Return type: NXOpen.CAM.MachinePocketGroupBuilderRegisterType
New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
CAM.MachinePocketGroupBuilder.AdjustIdBuilder`
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
AdjustRegisterType(type)
Parameters: type ( NXOpen.CAM.MachinePocketGroupBuilderRegisterType
) –New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
CAM.MachinePocketGroupBuilder.AdjustIdBuilder`
instead.License requirements: cam_base (“CAM BASE”)
ChannelName¶
-
MachinePocketGroupBuilder.
ChannelName
¶ Returns or sets the channel’s name
-------------------------------------
Getter Method
Signature
ChannelName()
Returns: The channel’s name Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ChannelName(name)
Parameters: name (str) – the channel’s name New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
CutcomIdBuilder¶
-
MachinePocketGroupBuilder.
CutcomIdBuilder
¶ Returns the cutcom id
-------------------------------------
Getter Method
Signature
CutcomIdBuilder()
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX6.0.0.
License requirements: None.
CutcomRegisterType¶
-
MachinePocketGroupBuilder.
CutcomRegisterType
¶ Returns or sets the cutcom register type
-------------------------------------
Getter Method
Signature
CutcomRegisterType()
Returns: Return type: NXOpen.CAM.MachinePocketGroupBuilderRegisterType
New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
CAM.MachinePocketGroupBuilder.CutcomIdBuilder`
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CutcomRegisterType(type)
Parameters: type ( NXOpen.CAM.MachinePocketGroupBuilderRegisterType
) –New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
CAM.MachinePocketGroupBuilder.CutcomIdBuilder`
instead.License requirements: cam_base (“CAM BASE”)
HoldingSystemsList¶
-
MachinePocketGroupBuilder.
HoldingSystemsList
¶ Returns the holding systems list
-------------------------------------
Getter Method
Signature
HoldingSystemsList()
Returns: Return type: NXOpen.CAM.HoldingSystemBuilderList
New in version NX6.0.0.
License requirements: None.
NumberOfTools¶
-
MachinePocketGroupBuilder.
NumberOfTools
¶ Returns or sets the number of tools
-------------------------------------
Getter Method
Signature
NumberOfTools()
Returns: The number of tools Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfTools(numTools)
Parameters: numTools (int) – the number of tools New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
PocketIdBuilder¶
-
MachinePocketGroupBuilder.
PocketIdBuilder
¶ Returns the pocket id
-------------------------------------
Getter Method
Signature
PocketIdBuilder()
Returns: Return type: NXOpen.CAM.InheritableIntBuilder
New in version NX5.0.0.
License requirements: None.
PocketIdStringBuilder¶
-
MachinePocketGroupBuilder.
PocketIdStringBuilder
¶ Returns the pocket id in string
-------------------------------------
Getter Method
Signature
PocketIdStringBuilder()
Returns: Return type: NXOpen.CAM.InheritableTextBuilder
New in version NX8.5.0.
License requirements: None.
Method Detail¶
CreateHoldingSystemBuilder¶
-
MachinePocketGroupBuilder.
CreateHoldingSystemBuilder
¶ Creates a new holding system builder
Signature
CreateHoldingSystemBuilder(position, name)
Parameters: - position (int) – position
- name (str) – Holding system name NOTE: The full Unicode character set is not supported for this parameter.
Returns: holding system builder
Return type: New in version NX6.0.0.
License requirements: None.
Validate¶
-
MachinePocketGroupBuilder.
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.