NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GroupBuilder Class Reference

Represents a GroupBuilder
To create a new instance of this class, use BasePart::CreateGatewayGroupBuilder
Default values. More...

Inheritance diagram for NXOpen::GroupBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  Action {
  ActionNewGroup, ActionAddToGroup, ActionRemoveFromGroup, ActionUngroup,
  ActionEditGroup, ActionNewSketchGroup
}
 Represents the type of action for this builder to perform. More...
enum  UngroupOption { UngroupOptionTop, UngroupOptionFull }
 Represents the option to control the behavior when deleting a group. More...

Public Member Functions

int ActionType ()
 Returns the action type for this builder to perform.
bool ActivegroupOption ()
 Returns the activegroup option is for sketch group as active group in Direct Sketch, STE or in Drafting Sketch.
bool GroupDisplayProperties ()
 Returns the group display option
Created in NX7.5.0.
NXOpen::SelectGroupGroupInAction ()
 Returns the group in action
Created in NX5.0.0.
NXString GroupName ()
 Returns the group name
Created in NX5.0.0.
NXOpen::SelectObjectListObjectsInGroup ()
 Returns the objects in group
Created in NX5.0.0.
NXOpen::NXObjectOwningObject ()
 Returns the owning object ie sketch object which currently has to be a sketch
Created in NX6.0.0.
void SetActionType (int actionType)
 Sets the action type for this builder to perform.
void SetActivegroupOption (bool activegroupOption)
 Sets the activegroup option is for sketch group as active group in Direct Sketch, STE or in Drafting Sketch.
void SetGroupDisplayProperties (bool gdpOption)
 Sets the group display option
Created in NX7.5.0.
void SetGroupName (const NXString &groupName)
 Sets the group name
Created in NX5.0.0.
void SetOwningObject (NXOpen::NXObject *owningObject)
 Sets the owning object ie sketch object which currently has to be a sketch
Created in NX6.0.0.
void SetUngroupLevel (NXOpen::GroupBuilder::UngroupOption ungroupLevel)
 Sets the ungroup level
Created in NX5.0.0.
void SetUniqueMembershipOption (bool umgOption)
 Sets the unique membership option ie umg option
Created in NX5.0.0.
NXOpen::GroupBuilder::UngroupOption UngroupLevel ()
 Returns the ungroup level
Created in NX5.0.0.
bool UniqueMembershipOption ()
 Returns the unique membership option ie umg option
Created in NX5.0.0.

Detailed Description

Represents a GroupBuilder
To create a new instance of this class, use BasePart::CreateGatewayGroupBuilder
Default values.

Property Value

GroupDisplayProperties

true


Created in NX5.0.0.


Member Enumeration Documentation

Represents the type of action for this builder to perform.

Enumerator:
ActionNewGroup 

Create New group in Modeling or Drafting.

ActionAddToGroup 

Add members to existing group in Modeling.

ActionRemoveFromGroup 

Remove members of existing group in Modeling.

ActionUngroup 

Delete a group in Modeling or in Sketcher.

ActionEditGroup 

Edit a group in Modeling or in Sketcher.

ActionNewSketchGroup 

Create New sktech group in Direct Sketch, STE or in Drafting Sketch.

Represents the option to control the behavior when deleting a group.

Enumerator:
UngroupOptionTop 

Delete a group.

UngroupOptionFull 

Delete a group recursively.


Member Function Documentation

Returns 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 sktech group in Direct Sketch, STE or in Drafting Sketch


Created in NX5.0.0.

License requirements : None

Returns the activegroup option is for sketch group as active group in Direct Sketch, STE or in Drafting Sketch.


Created in NX5.0.0.

License requirements : None

Returns the group display option
Created in NX7.5.0.



License requirements : None

Returns the group in action
Created in NX5.0.0.



License requirements : None

Returns the group name
Created in NX5.0.0.



License requirements : None

Returns the objects in group
Created in NX5.0.0.



License requirements : None

Returns the owning object ie sketch object which currently has to be a sketch
Created in NX6.0.0.



License requirements : None

void NXOpen::GroupBuilder::SetActionType ( int  actionType)

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 sktech group in Direct Sketch, STE or in Drafting Sketch


Created in NX5.0.0.

License requirements : None

Parameters:
actionTypeactiontype
void NXOpen::GroupBuilder::SetActivegroupOption ( bool  activegroupOption)

Sets the activegroup option is for sketch group as active group in Direct Sketch, STE or in Drafting Sketch.


Created in NX5.0.0.

License requirements : None

Parameters:
activegroupOptionactivegroupoption

Sets the group display option
Created in NX7.5.0.



License requirements : None

Parameters:
gdpOptiongdpoption
void NXOpen::GroupBuilder::SetGroupName ( const NXString groupName)

Sets the group name
Created in NX5.0.0.



License requirements : None

Parameters:
groupNamegroupname

Sets the owning object ie sketch object which currently has to be a sketch
Created in NX6.0.0.



License requirements : None

Parameters:
owningObjectowningobject

Sets the ungroup level
Created in NX5.0.0.



License requirements : None

Parameters:
ungroupLevelungrouplevel

Sets the unique membership option ie umg option
Created in NX5.0.0.



License requirements : None

Parameters:
umgOptionumgoption

Returns the ungroup level
Created in NX5.0.0.



License requirements : None

Returns the unique membership option ie umg option
Created in NX5.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.