GroupBuilder Class¶
-
class
NXOpen.
GroupBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.GroupBuilder
To create a new instance of this class, use
NXOpen.BasePart.CreateGatewayGroupBuilder()
Default values.
Property Value ActionType 0 GroupDisplayProperties true New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
ActionType | Returns or sets the action type for this builder to perform. |
ActivegroupOption | Returns or sets the activegroup option is for sketch group as active group in Direct Sketch, Sketch Task Environment or in Drafting Sketch. |
GroupDisplayProperties | Returns or sets the group display option |
GroupInAction | Returns the group in action |
GroupName | Returns or sets the group name |
ObjectsInGroup | Returns the objects in group |
OwningObject | Returns or sets the owning object ie sketch object which currently has to be a sketch |
SketchGroupType | Returns or sets the type of sketch group that gets created |
Tag | Returns the Tag for this object. |
UngroupLevel | Returns or sets the ungroup level |
UniqueMembershipOption | Returns or sets the unique membership option ie umg option |
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¶
GroupBuilderAction Enumeration | Represents the type of action for this builder to perform. |
GroupBuilderSketchType Enumeration | Represents the type of sketch group to be created. |
GroupBuilderUngroupOption Enumeration | Represents the option to control the behavior when deleting a group. |
Property Detail¶
ActionType¶
-
GroupBuilder.
ActionType
¶ Returns or sets the action type for this builder to perform.
- 0 signifies Create New group in Modeling or Drafting
- 1 signifies Add members to existing group in Modeling
- 2 signifies Remove members of existing group in Modeling
- 3 signifies Delete a group in Modeling or in Sketcher
- 4 signifies Edit a group in Modeling or in Sketcher
- 5 signifies Create New sketch group in Direct Sketch, the Sketch Task Environment, or in Drafting Sketch
-------------------------------------
Getter Method
Signature
ActionType()
Returns: Return type: int New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActionType(actionType)
Parameters: actionType (int) – New in version NX5.0.0.
License requirements: None.
ActivegroupOption¶
-
GroupBuilder.
ActivegroupOption
¶ Returns or sets the activegroup option is for sketch group as active group in Direct Sketch, Sketch Task Environment or in Drafting Sketch.
-------------------------------------
Getter Method
Signature
ActivegroupOption()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActivegroupOption(activegroupOption)
Parameters: activegroupOption (bool) – New in version NX5.0.0.
License requirements: None.
GroupDisplayProperties¶
-
GroupBuilder.
GroupDisplayProperties
¶ Returns or sets the group display option
-------------------------------------
Getter Method
Signature
GroupDisplayProperties()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GroupDisplayProperties(gdpOption)
Parameters: gdpOption (bool) – New in version NX7.5.0.
License requirements: None.
GroupInAction¶
-
GroupBuilder.
GroupInAction
¶ Returns the group in action
-------------------------------------
Getter Method
Signature
GroupInAction()
Returns: Return type: NXOpen.SelectGroup
New in version NX5.0.0.
License requirements: None.
GroupName¶
-
GroupBuilder.
GroupName
¶ Returns or sets the group name
-------------------------------------
Getter Method
Signature
GroupName()
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GroupName(groupName)
Parameters: groupName (str) – New in version NX5.0.0.
License requirements: None.
ObjectsInGroup¶
-
GroupBuilder.
ObjectsInGroup
¶ Returns the objects in group
-------------------------------------
Getter Method
Signature
ObjectsInGroup()
Returns: Return type: NXOpen.SelectObjectList
New in version NX5.0.0.
License requirements: None.
OwningObject¶
-
GroupBuilder.
OwningObject
¶ Returns or sets the owning object ie sketch object which currently has to be a sketch
-------------------------------------
Getter Method
Signature
OwningObject()
Returns: Return type: NXOpen.NXObject
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OwningObject(owningObject)
Parameters: owningObject ( NXOpen.NXObject
) –New in version NX6.0.0.
License requirements: None.
SketchGroupType¶
-
GroupBuilder.
SketchGroupType
¶ Returns or sets the type of sketch group that gets created
-------------------------------------
Getter Method
Signature
SketchGroupType()
Returns: Return type: NXOpen.GroupBuilderSketchType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SketchGroupType(groupType)
Parameters: groupType ( NXOpen.GroupBuilderSketchType
) –New in version NX9.0.0.
License requirements: None.
UngroupLevel¶
-
GroupBuilder.
UngroupLevel
¶ Returns or sets the ungroup level
-------------------------------------
Getter Method
Signature
UngroupLevel()
Returns: Return type: NXOpen.GroupBuilderUngroupOption
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UngroupLevel(ungroupLevel)
Parameters: ungroupLevel ( NXOpen.GroupBuilderUngroupOption
) –New in version NX5.0.0.
License requirements: None.
UniqueMembershipOption¶
-
GroupBuilder.
UniqueMembershipOption
¶ Returns or sets the unique membership option ie umg option
-------------------------------------
Getter Method
Signature
UniqueMembershipOption()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UniqueMembershipOption(umgOption)
Parameters: umgOption (bool) – New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
GroupBuilder.
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.