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

Constraint group which represents a group of component constraints in NX. More...

Inheritance diagram for NXOpen::Positioning::ComponentConstraintGroup:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  ConstraintsCollectionType { ConstraintsCollectionTypeBetweenSelectedComponents, ConstraintsCollectionTypeConnectedToSelectedComponents }
 the enum to define constraint collection type More...

Public Member Functions

NXOpen::Positioning::ComponentConstraintGroup::ConstraintsCollectionType GetConstraintCollectionType ()
 Gets the type of constraint collection that is performed using the defining components.
std::vector
< NXOpen::Assemblies::Component * > 
GetDefiningComponents ()
 Returns the defining components within the group.
std::vector
< NXOpen::Positioning::ComponentConstraint * > 
GetDefiningConstraints ()
 Returns the defining constraints within the group.
std::vector
< NXOpen::Positioning::ComponentConstraint * > 
GetMemberConstraints ()
 Returns the member constraints present in the group.
bool GetRememberComponentState ()
 Gets the state which indicates if defining components are remembered when updating the member constraints.
void SetConstraintCollectionType (NXOpen::Positioning::ComponentConstraintGroup::ConstraintsCollectionType constraintCollectionType)
 Sets the type of constraint collection that is performed using the defining components.
void SetDefiningComponents (const std::vector< NXOpen::Assemblies::Component * > &constraints)
 Sets the defining constraints within the group.
void SetDefiningConstraints (const std::vector< NXOpen::Positioning::ComponentConstraint * > &constraints)
 Sets the defining constraints within the group.
void SetRememberComponentState (bool rememberComponentState)
 Sets the state which indicates if defining components are remembered when updating the member constraints.
bool UpdateMemberConstraints ()
 Updates the member constraints so that they match the definition implied by the defining constraints, defining components and associated constraint collection type.

Detailed Description

Constraint group which represents a group of component constraints in NX.


Created in NX8.0.1.


Member Enumeration Documentation

the enum to define constraint collection type

Enumerator:
ConstraintsCollectionTypeBetweenSelectedComponents 

between selected components

ConstraintsCollectionTypeConnectedToSelectedComponents 

connected to selected components


Member Function Documentation

Gets the type of constraint collection that is performed using the defining components.

Returns:

Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the defining components within the group.

Returns:
Defining components
Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the defining constraints within the group.

Returns:
Defining constraints
Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the member constraints present in the group.

The member constraints are generated from the defining constraints and components. This attribute cannot be set directly.

Returns:
Member constraints
Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Gets the state which indicates if defining components are remembered when updating the member constraints.

Returns:

Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Sets the type of constraint collection that is performed using the defining components.


Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
constraintCollectionTypeconstraintcollectiontype

Sets the defining constraints within the group.


Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
constraintsDefining components

Sets the defining constraints within the group.


Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
constraintsDefining constraints

Sets the state which indicates if defining components are remembered when updating the member constraints.


Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
rememberComponentStateremembercomponentstate

Updates the member constraints so that they match the definition implied by the defining constraints, defining components and associated constraint collection type.

Returns:
True if the member constraints have been changed by update
Created in NX8.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

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