ComponentConstraintGroup Class¶
-
class
NXOpen.Positioning.ComponentConstraintGroup¶ Bases:
NXOpen.NXObjectConstraint group which represents a group of component constraints in NX.
New in version NX8.0.1.
Properties¶
| Property | Description |
|---|---|
| IsOccurrence | Returns whether this object is an occurrence or not. |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Name | Returns the custom name of the object. |
| OwningComponent | Returns the owning component, if this object is an occurrence. |
| OwningPart | Returns the owning part of this object |
| Prototype | Returns the prototype of this object if it is an occurrence. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| CreateAttributeIterator | Create an attribute iterator @return A new attribute iterator object |
| DeleteAllAttributesByType | Deletes all attributes of a specific type. |
| DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
| DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
| DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
| FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetConstraintCollectionType | Gets the type of constraint collection that is performed using the defining components. |
| GetDefiningComponents | Returns the defining components within the group. |
| GetDefiningConstraints | Returns the defining constraints within the group. |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetMemberConstraints | Returns the member constraints present in the group. |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetRealAttribute | Gets a real attribute by title. |
| GetRealUserAttribute | Gets a real attribute by Title and array Index. |
| GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
| GetRememberComponentState | Gets the state which indicates if defining components are remembered when updating the member constraints. |
| GetStringAttribute | Gets a string attribute value by title. |
| GetStringUserAttribute | Gets a string attribute by Title and array Index. |
| GetTimeAttribute | Gets a time attribute by title. |
| GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
| GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
| GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
| GetUserAttributeLock | Determine the lock of the given attribute. |
| GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
| GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
| GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator @return |
| Prints a representation of this object to the system log file. | |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetConstraintCollectionType | Sets the type of constraint collection that is performed using the defining components. |
| SetDefiningComponents | Sets the defining constraints within the group. |
| SetDefiningConstraints | Sets the defining constraints within the group. |
| SetName | Sets the custom name of the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| SetRememberComponentState | Sets the state which indicates if defining components are remembered when updating the member constraints. |
| SetTimeAttribute | Creates or modifies a time attribute. |
| SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
| SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
| SetUserAttributeLock | Lock or unlock the given attribute. |
| UpdateMemberConstraints | Updates the member constraints so that they match the definition implied by the defining constraints, defining components and associated constraint collection type. |
Enumerations¶
| ComponentConstraintGroupConstraintsCollectionType Enumeration | the enum to define constraint collection type |
Property Detail¶
IsOccurrence¶
-
ComponentConstraintGroup.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrence()Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
ComponentConstraintGroup.JournalIdentifier¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------Getter Method
Signature
JournalIdentifier()Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
ComponentConstraintGroup.Name¶ Returns the custom name of the object.
-------------------------------------Getter Method
Signature
Name()Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
ComponentConstraintGroup.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponent()Returns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
ComponentConstraintGroup.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPart()Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
ComponentConstraintGroup.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
Prototype()Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
ComponentConstraintGroup.FindObject¶ Finds the
NXOpen.NXObjectwith the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObjectNew in version NX3.0.0.
License requirements: None.
GetConstraintCollectionType¶
-
ComponentConstraintGroup.GetConstraintCollectionType¶ Gets the type of constraint collection that is performed using the defining components.
Signature
GetConstraintCollectionType()Returns: Return type: NXOpen.Positioning.ComponentConstraintGroupConstraintsCollectionTypeNew in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetDefiningComponents¶
-
ComponentConstraintGroup.GetDefiningComponents¶ Returns the defining components within the group.
Signature
GetDefiningComponents()Returns: Defining components Return type: list of NXOpen.Assemblies.ComponentNew in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetDefiningConstraints¶
-
ComponentConstraintGroup.GetDefiningConstraints¶ Returns the defining constraints within the group.
Signature
GetDefiningConstraints()Returns: Defining constraints Return type: list of NXOpen.Positioning.ComponentConstraintNew in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetMemberConstraints¶
-
ComponentConstraintGroup.GetMemberConstraints¶ 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.
Signature
GetMemberConstraints()Returns: Member constraints Return type: list of NXOpen.Positioning.ComponentConstraintNew in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
GetRememberComponentState¶
-
ComponentConstraintGroup.GetRememberComponentState¶ Gets the state which indicates if defining components are remembered when updating the member constraints.
Signature
GetRememberComponentState()Returns: Return type: bool New in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
Print¶
-
ComponentConstraintGroup.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetConstraintCollectionType¶
-
ComponentConstraintGroup.SetConstraintCollectionType¶ Sets the type of constraint collection that is performed using the defining components.
Signature
SetConstraintCollectionType(constraintCollectionType)Parameters: constraintCollectionType ( NXOpen.Positioning.ComponentConstraintGroupConstraintsCollectionType) –New in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetDefiningComponents¶
-
ComponentConstraintGroup.SetDefiningComponents¶ Sets the defining constraints within the group.
Signature
SetDefiningComponents(constraints)Parameters: constraints (list of NXOpen.Assemblies.Component) – Defining componentsNew in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetDefiningConstraints¶
-
ComponentConstraintGroup.SetDefiningConstraints¶ Sets the defining constraints within the group.
Signature
SetDefiningConstraints(constraints)Parameters: constraints (list of NXOpen.Positioning.ComponentConstraint) – Defining constraintsNew in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetName¶
-
ComponentConstraintGroup.SetName¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)Parameters: name (str) – New in version NX3.0.0.
License requirements: None.
SetRememberComponentState¶
-
ComponentConstraintGroup.SetRememberComponentState¶ Sets the state which indicates if defining components are remembered when updating the member constraints.
Signature
SetRememberComponentState(rememberComponentState)Parameters: rememberComponentState (bool) – New in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)
UpdateMemberConstraints¶
-
ComponentConstraintGroup.UpdateMemberConstraints¶ Updates the member constraints so that they match the definition implied by the defining constraints, defining components and associated constraint collection type.
Signature
UpdateMemberConstraints()Returns: True if the member constraints have been changed by update Return type: bool New in version NX8.0.1.
License requirements: assemblies (“ASSEMBLIES MODULE”)