NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Assemblies::PositioningGroupBuilder Class Reference

Represents builder class for positioning group which is used to store constraints for design element. More...

Inheritance diagram for NXOpen::Assemblies::PositioningGroupBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool MakeActive ()
 Returns the option to specify whether a newly created positioning group should be made active after creation or not. More...
 
NXOpen::Assemblies::PositioningTaskOwningPositioningTask ()
 Returns the owning positioning task. More...
 
NXOpen::SelectDisplayableObjectListPositioningGroupDataMembers ()
 Returns the members for positioning group
Created in NX10.0.0. More...
 
NXString PositioningGroupName ()
 Returns the name of positioning group. More...
 
void SetMakeActive (bool makeActive)
 Sets the option to specify whether a newly created positioning group should be made active after creation or not. More...
 
void SetOwningPositioningTask (NXOpen::Assemblies::PositioningTask *positioningTask)
 Sets the owning positioning task. More...
 
void SetPositioningGroupName (const NXString &nameOfPositioningGroup)
 Sets the name of positioning group. More...
 
void SetPositioningGroupName (const char *nameOfPositioningGroup)
 Sets the name of positioning group. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents builder class for positioning group which is used to store constraints for design element.


To create a new instance of this class, use NXOpen::CollaborativeContentManager::CreatePositioningGroupBuilder
Default values.

Property Value

MakeActive

1


Created in NX10.0.0.

Member Function Documentation

bool NXOpen::Assemblies::PositioningGroupBuilder::MakeActive ( )

Returns the option to specify whether a newly created positioning group should be made active after creation or not.


Created in NX10.0.0.

License requirements : None

NXOpen::Assemblies::PositioningTask* NXOpen::Assemblies::PositioningGroupBuilder::OwningPositioningTask ( )

Returns the owning positioning task.

During creation set method should be called with the positioning task in which new NXOpen::Assemblies::PositioningGroup has to be created. During edit operation set method should not be called. An error would be raised if during edit operation set method is called with a positioning task which is different from the owning positioning task of NXOpen::Assemblies::PositioningGroup .


Created in NX10.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::PositioningGroupBuilder::PositioningGroupDataMembers ( )

Returns the members for positioning group
Created in NX10.0.0.



License requirements : None

NXString NXOpen::Assemblies::PositioningGroupBuilder::PositioningGroupName ( )

Returns the name of positioning group.

The user of this API is responcible to free the text pointer
Created in NX10.0.0.

License requirements : None

void NXOpen::Assemblies::PositioningGroupBuilder::SetMakeActive ( bool  makeActive)

Sets the option to specify whether a newly created positioning group should be made active after creation or not.


Created in NX10.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
makeActivemakeactive
void NXOpen::Assemblies::PositioningGroupBuilder::SetOwningPositioningTask ( NXOpen::Assemblies::PositioningTask positioningTask)

Sets the owning positioning task.

During creation set method should be called with the positioning task in which new NXOpen::Assemblies::PositioningGroup has to be created. During edit operation set method should not be called. An error would be raised if during edit operation set method is called with a positioning task which is different from the owning positioning task of NXOpen::Assemblies::PositioningGroup .


Created in NX10.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
positioningTaskThis parameter may not be NULL.
void NXOpen::Assemblies::PositioningGroupBuilder::SetPositioningGroupName ( const NXString nameOfPositioningGroup)

Sets the name of positioning group.

The user of this API is responcible to free the text pointer
Created in NX10.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
nameOfPositioningGroupnameofpositioninggroup
void NXOpen::Assemblies::PositioningGroupBuilder::SetPositioningGroupName ( const char *  nameOfPositioningGroup)

Sets the name of positioning group.

The user of this API is responcible to free the text pointer
Created in NX10.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
nameOfPositioningGroupnameofpositioninggroup

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