ComponentPattern Class

class NXOpen.Assemblies.ComponentPattern

Bases: NXOpen.NXObject

Represents the component pattern class.

Input to this class can be PSM facet objects.

To create or edit an instance of this class, use NXOpen.Assemblies.ComponentPatternBuilder

New in version NX9.0.0.

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
ChangeReferencePatternTemplate	Changes the template component of a reference pattern to a pattern member at indices (firstBaseInstanceIndex, secondBaseInstanceIndex).
CreateAttributeIterator	Create an attribute iterator
Delete	Deletes the component pattern 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
DisplayInformation	Displays the information of the component pattern.
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAllPatternMembers	Returns all the pattern members.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComponentsToPattern	Gets all the Assemblies.Component that are selected for component pattern.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPatternDeferredStatus	Gets the deferred status of the component pattern.
GetPatternName	Gets the component pattern name.
GetPatternSuppressedStatus	Gets the suppressed status of the component pattern.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
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.
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
LoadRelatedGeometry	Loads the parts containing data referenced by this pattern, including the parts that are patterned and parts containing the objects that define the pattern parameters.
Print	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.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
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.
Suppress	Suppresses the component pattern object.
Unsuppress	Unsuppresses the component pattern object.

Property Detail

IsOccurrence

ComponentPattern.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

ComponentPattern.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

ComponentPattern.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

ComponentPattern.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

ComponentPattern.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.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

ComponentPattern.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.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

ChangeReferencePatternTemplate

ComponentPattern.ChangeReferencePatternTemplate

Changes the template component of a reference pattern to a pattern member at indices (firstBaseInstanceIndex, secondBaseInstanceIndex).

Signature ChangeReferencePatternTemplate(firstBaseInstanceIndex, secondBaseInstanceIndex)

Parameters:

• firstBaseInstanceIndex (int) –
• secondBaseInstanceIndex (int) –

New in version NX9.0.0.

License requirements: None.

Delete

ComponentPattern.Delete

Deletes the component pattern object.

Signature Delete(deleteComponents)

Parameters:deleteComponents (bool) –

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

DisplayInformation

ComponentPattern.DisplayInformation

Displays the information of the component pattern.

Signature DisplayInformation()

New in version NX9.0.0.

License requirements: None.

FindObject

ComponentPattern.FindObject

Finds the NXOpen.NXObject with 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.INXObject

New in version NX3.0.0.

License requirements: None.

GetAllPatternMembers

ComponentPattern.GetAllPatternMembers

Returns all the pattern members.

Signature GetAllPatternMembers()

Returns: Return type:list of NXOpen.Assemblies.PatternMember

New in version NX9.0.0.

License requirements: None.

GetComponentsToPattern

ComponentPattern.GetComponentsToPattern

Gets all the Assemblies.Component that are selected for component pattern.

Signature GetComponentsToPattern()

Returns: Return type:list of NXOpen.Assemblies.Component

New in version NX9.0.0.

License requirements: None.

GetPatternDeferredStatus

ComponentPattern.GetPatternDeferredStatus

Gets the deferred status of the component pattern.

Signature GetPatternDeferredStatus()

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

GetPatternName

ComponentPattern.GetPatternName

Gets the component pattern name.

Signature GetPatternName()

Returns: Return type:str

New in version NX9.0.0.

License requirements: None.

GetPatternSuppressedStatus

ComponentPattern.GetPatternSuppressedStatus

Gets the suppressed status of the component pattern.

Signature GetPatternSuppressedStatus()

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

LoadRelatedGeometry

ComponentPattern.LoadRelatedGeometry

Loads the parts containing data referenced by this pattern, including the parts that are patterned and parts containing the objects that define the pattern parameters.

Signature LoadRelatedGeometry()

Returns:Error information for any part that could not be loaded. Return type:NXOpen.PartLoadStatus

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Print

ComponentPattern.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

ComponentPattern.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.

Suppress

ComponentPattern.Suppress

Suppresses the component pattern object.

Signature Suppress()

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Unsuppress

ComponentPattern.Unsuppress

Unsuppresses the component pattern object.

Signature Unsuppress()

New in version NX9.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)