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

Represents a NXOpen::Positioning::ComponentConstraintGroupBuilder builder
To create a new instance of this class, use NXOpen::Assemblies::ComponentAssembly::CreateConstraintGroupBuilder
Default values. More...

Inheritance diagram for NXOpen::Positioning::ComponentConstraintGroupBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Positioning::ComponentConstraintGroup::ConstraintsCollectionType ConstraintCollectionType ()
 Returns the constraint collection types
Created in NX8.0.1. More...
 
NXString ConstraintGroupName ()
 Returns the name of constraint group
Created in NX8.0.1. More...
 
NXOpen::Assemblies::ComponentGetContextComponent ()
 Gets the context component which is used to decide the displayed constraints that can be in the selected constraints list. More...
 
bool RememberComponentState ()
 Returns the toggle to remember selected component
Created in NX8.0.1. More...
 
NXOpen::SelectDisplayableObjectListSelectedComponentList ()
 Returns the selected components list
Created in NX8.0.1. More...
 
NXOpen::SelectDisplayableObjectListSelectedConstraintsList ()
 Returns the selected constraint list
Created in NX8.0.1. More...
 
void SetConstraintCollectionType (NXOpen::Positioning::ComponentConstraintGroup::ConstraintsCollectionType constraintCollectionType)
 Sets the constraint collection types
Created in NX8.0.1. More...
 
void SetConstraintGroupName (const NXString &nameOfConstraintGroup)
 Sets the name of constraint group
Created in NX8.0.1. More...
 
void SetConstraintGroupName (const char *nameOfConstraintGroup)
 Sets the name of constraint group
Created in NX8.0.1. More...
 
void SetRememberComponentState (bool rememberComponentState)
 Sets the toggle to remember selected component
Created in NX8.0.1. 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 a NXOpen::Positioning::ComponentConstraintGroupBuilder builder
To create a new instance of this class, use NXOpen::Assemblies::ComponentAssembly::CreateConstraintGroupBuilder
Default values.

Property Value

ConstraintCollectionType

BetweenSelectedComponents

RememberComponentState

true


Created in NX8.0.1.

Member Function Documentation

NXOpen::Positioning::ComponentConstraintGroup::ConstraintsCollectionType NXOpen::Positioning::ComponentConstraintGroupBuilder::ConstraintCollectionType ( )

Returns the constraint collection types
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

NXString NXOpen::Positioning::ComponentConstraintGroupBuilder::ConstraintGroupName ( )

Returns the name of constraint group
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::Assemblies::Component* NXOpen::Positioning::ComponentConstraintGroupBuilder::GetContextComponent ( )

Gets the context component which is used to decide the displayed constraints that can be in the selected constraints list.

The context component is only set by the creator and can be NULL. If the context component is NULL the displayed constraints will be in same part as the constraint group.

Returns

Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")
bool NXOpen::Positioning::ComponentConstraintGroupBuilder::RememberComponentState ( )

Returns the toggle to remember selected component
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::SelectDisplayableObjectList* NXOpen::Positioning::ComponentConstraintGroupBuilder::SelectedComponentList ( )

Returns the selected components list
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::SelectDisplayableObjectList* NXOpen::Positioning::ComponentConstraintGroupBuilder::SelectedConstraintsList ( )

Returns the selected constraint list
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

void NXOpen::Positioning::ComponentConstraintGroupBuilder::SetConstraintCollectionType ( NXOpen::Positioning::ComponentConstraintGroup::ConstraintsCollectionType  constraintCollectionType)

Sets the constraint collection types
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
constraintCollectionTypeconstraintcollectiontype
void NXOpen::Positioning::ComponentConstraintGroupBuilder::SetConstraintGroupName ( const NXString nameOfConstraintGroup)

Sets the name of constraint group
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
nameOfConstraintGroupnameofconstraintgroup
void NXOpen::Positioning::ComponentConstraintGroupBuilder::SetConstraintGroupName ( const char *  nameOfConstraintGroup)

Sets the name of constraint group
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
nameOfConstraintGroupnameofconstraintgroup
void NXOpen::Positioning::ComponentConstraintGroupBuilder::SetRememberComponentState ( bool  rememberComponentState)

Sets the toggle to remember selected component
Created in NX8.0.1.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
rememberComponentStateremembercomponentstate

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