ExplodedComponent Class — NXOpen Python API Reference 12.0.0 documentation

# ExplodedComponent Class

class `NXOpen.Assemblies.``ExplodedComponent`

  Bases: `NXOpen.Assemblies.Component`

  Represents a `NXOpen.Assemblies.Component` within an explosion.

  Use the `NXOpen.Assemblies.Explosion` and `NXOpen.Assemblies.Component` to create an exploded component.

  New in version NX9.0.1.

# Properties

Property | Description
--- | ---
CollaborativeContentType | Returns the collaborative content type of this component.
Color | Returns or sets the color of the object.
DesignElementRevision | Returns the `NXOpen.PDM.DesignElementRevision` that corresponds to this component.
DesignSubordinateRevision | Returns the `NXOpen.PDM.DesignSubordinateRevision` that corresponds to this component.
DirectOwner | Returns the `NXOpen.Assemblies.ComponentAssembly` which owns this component as a Top Level component.
DisplayName | Returns the displayable name of the prototype part.
EmptyPartRefsetName | Returns the name of the reference set which represents the empty set.
EntirePartRefsetName | Returns the name of the reference set which represents the entire part.
FixConstraint | Returns a fix `NXOpen.Positioning.ComponentConstraint` of this component.
IsBlanked | Returns the blank status of this object.
IsFixed | Returns the fixed state of this component.
IsOccurrence | Returns whether this object is an occurrence or not.
IsSuppressed | Returns the suppressed state of the component in its controlling arrangement.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Layer | Returns or sets the layer that the object is in.
LineFont | Returns or sets the line font of the object.
LineWidth | Returns or sets the line width of the object.
ModelElementRevision | Returns the `NXOpen.PDM.ModelElementRevision` that corresponds to this component.
Name | Returns the custom name of the object.
NameLocation | Returns the location of the object’s name.
OwningComponent | Returns the owning component, if this object is an occurrence.
OwningPart | Returns the owning part of this object
Parent | Returns the parent of the component.
Prototype | Returns the prototype of this object if it is an occurrence.
ReferenceSet | Returns the name of the reference set used for this component
Subset | Returns the `NXOpen.Assemblies.Subset` that corresponds to this component.
SuppressingArrangement | Returns the `NXOpen.Assemblies.Arrangement` that controls this component’s suppression state.
Tag | Returns the Tag for this object.
UsedArrangement | Returns the Arrangement used for this component.

# Methods

Method | Description
--- | ---
Blank | Blanks the object.
CreateAttributeIterator | Create an attribute iterator
CreateEmptyPartFamilyInstanceSelectionCriteria | Creates an empty `NXOpen.PartFamily.InstanceSelectionCriteria`
DeleteAllAttributesByType | Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title.
DeleteCharacterstics | Removes the input list of characteristics from this object.
DeleteInstanceUserAttribute | Deletes the first attribute encountered with the given Type, Title and Index.
DeleteInstanceUserAttributes | Deletes the attributes encountered with the given Type with option to update or not.
DeletePartFamilyInstanceSelectionCriteria | Deletes `NXOpen.PartFamily.InstanceSelectionCriteria` associated with this component
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
DisplayComponentsExact | Sets an array of components to display using the exact representation.
DisplayComponentsLightweight | Sets an array of components to display using the lightweight representation.
EstablishIsolatedPositionOverride | Ensures there is an isolated positioning override for the `NXOpen.Assemblies.Component` in the given part of the given parent.
EstablishPositionOverride | Ensures there is a positioning override on component in the given part of the given parent.
FindComponentPatterns | Finds `NXOpen.Assemblies.ComponentPattern` associated with this component.
FindObject | Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
FindOccurrence | Given a prototype object, returns the corresponding occurrence in this component
GetArrangements | Outputs the `NXOpen.Assemblies.Arrangement` objects within the `NXOpen.Assemblies.Component`.
GetAsRequiredQuantity | Gets the as-required quantity on this component.
GetAttributeTitlesByType | Gets all the attribute titles of a specific type.
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index.
GetCharacteristics | Get all of the characteristics values on the this object.
GetChildren | Returns the child components of this component However, it does not return non-geometric components (NGCs) To enable this method to also return NGCs, set the following environment variable: UGII_ALLOW_NGC_IN_UGOPEN=YES
GetComponent | Gets the `NXOpen.Assemblies.Component` associated with the exploded component.
GetComponentQuantityType | Gets the quantity type of the components.
GetComponentRepresentationMode | Returns the representation mode for the component’s bodies.
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index.
GetConstraints | Returns the :py:class:`NXOpen.Positioning.ComponentConstraint`s directly connected to this component.
GetDegreesOfFreedom | Returns the `NXOpen.Assemblies.DegreesOfFreedom` for this component.
GetDestinationCharacteristics | Returns the destination characteristics from the input object.
GetExplosion | Gets the `NXOpen.Assemblies.Explosion` associated with the exploded component.
GetInstanceBooleanUserAttribute | Gets a boolean attribute by Title and array Index.
GetInstanceIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetInstanceRealUserAttribute | Gets a real attribute by Title and array Index.
GetInstanceStringUserAttribute | Gets a string attribute by Title and array Index.
GetInstanceTimeUserAttribute | Gets a time attribute by Title and array Index.
GetInstanceUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetInstanceUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetInstanceUserAttributeLock | Determine the lock of the given attribute.
GetInstanceUserAttributes | Gets all the attributes that have been set on the given object.
GetInstanceUserAttributesAsStrings | Gets all the attributes that have been set on the given object.
GetIntegerAttribute | Gets an integer attribute by title.
GetIntegerCharacteristic | Get the value of an integer characteristic associated with the input name.
GetIntegerQuantity | Gets the value of the integer quantity of component.
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetLayerOption | Gets the layer option.
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNonGeometricState | Gets the component state as Geometric or Non-Geometric.
GetPartFamilyInstanceSelectionCriteria | Obtains the:py:class:NXOpen.PartFamily.InstanceSelectionCriteria, if it exists.
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object.
GetPosition | Gets the position of a component
GetPositionOverrideParent | Find the highest level parent in which the position of component is overridden.
GetPositionOverrideType | Gets the type of the highest level positioning override on the component.
GetRealAttribute | Gets a real attribute by title.
GetRealCharacteristic | Get the value of a real characteristic associated with the input name.
GetRealQuantity | Gets the value of real quantity and corresponding units on this component.
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.
GetStringCharacteristic | Get the value of a string characteristic associated with the input name.
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.
HasInstanceUserAttribute | Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator
Highlight | Highlights the object.
IsPositioningIsolated | Get whether positioning for the selected `NXOpen.Assemblies.Component` is isolated in the specified `NXOpen.Assemblies.Arrangement`.
Print | Prints a representation of this object to the system log file.
RecallAndListConstraints | Recalls the :py:class:`NXOpen.Positioning.ComponentConstraint`s previously remembered on the part of this component, creating new constraints from them.
RecallConstraints | Recalls the :py:class:`NXOpen.Positioning.ComponentConstraint`s previously remembered on the part of this component, creating new constraints from them.
RedisplayObject | Redisplays the object in all views.
RemovePositionOverride | Removes the highest level positioning override on component in or below the given parent.
RemoveRememberedConstraints | Remove all the remembered constraints stored on the part of this component.
RemoveViewDependency | Remove dependency on all views from an object.
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetCharacteristic | Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already.
SetCharacteristic2 | Sets or creates an integer type attribute associated with the input title.
SetCharacteristics | Set all of the characteristics values on this object.
SetCharacteristics2 | Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don’t exist already.
SetInstanceBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetInstanceTimeUserAttribute | Creates or modifies a time attribute with the option to update or not.
SetInstanceUserAttribute | Creates or modifies an attribute with the option to update or not.
SetInstanceUserAttributeLock | Lock or unlock the given attribute.
SetLayerOption | Sets the layer option.
SetName | Sets the custom name of the object.
SetNameLocation | Sets the location of the object’s name.
SetPartFamilyInstanceSelectionCriteria | Hooks `NXOpen.PartFamily.InstanceSelectionCriteria` to this component
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object.
SetPositioningIsolated | Set positioning for the selected `NXOpen.Assemblies.Component` as isolated in the specified `NXOpen.Assemblies.Arrangement`.
SetPositioningVaried | Set positioning for the selected :py:class:`NXOpen.Assemblies.Component`s across all possible :py:class:`NXOpen.Assemblies.Arrangement`s.
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.
SetUsedArrangement | Changes the Arrangement used for this component.
SetUserAttribute | Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock | Lock or unlock the given attribute.
Suppress | Suppresses the component in the ComponentAssembly that contains its controlling Arrangement.
Unblank | Unblanks the object.
Unhighlight | Unhighlights the object.
Unsuppress | Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement.
UpdateStructure | Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels, ignoring components already processed by previous calls.

# Property Detail

## IsOccurrence

`ExplodedComponent.``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

`ExplodedComponent.``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

`ExplodedComponent.``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

`ExplodedComponent.``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

`ExplodedComponent.``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

`ExplodedComponent.``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

## DeleteCharacterstics

`ExplodedComponent.``DeleteCharacterstics`

  Removes the input list of characteristics from this object.

  Signature `DeleteCharacterstics(values)`

  Parameters: | values (`NXOpen.Routing.CharacteristicList`) –

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

## FindObject

`ExplodedComponent.``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.

## GetCharacteristics

`ExplodedComponent.``GetCharacteristics`

  Get all of the characteristics values on the this object.

  Signature `GetCharacteristics()`

  Returns: |
  Return type: | `NXOpen.Routing.CharacteristicList`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

## GetComponent

`ExplodedComponent.``GetComponent`

  Gets the `NXOpen.Assemblies.Component` associated with the exploded component.

  Signature `GetComponent()`

  Returns: |
  Return type: | `NXOpen.Assemblies.Component`

  New in version NX9.0.1.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## GetDestinationCharacteristics

`ExplodedComponent.``GetDestinationCharacteristics`

  Returns the destination characteristics from the input object.

  Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

  > - Ports: Reads characteristics from the port.
  > - RCPs: Attempts to find a port at the RCP, reads characteristics from

  the port if it exists, otherwise reads from the stock associated with the rcp.

  > - Segments: Reads characteristics from the stock associated with the segment.
  > - Components: Reads characteristics directly from the component.
  > - Stock: Reads characteristics from the stock or from the stock’s data.

  Signature `GetDestinationCharacteristics()`

  Returns: |
  Return type: | `NXOpen.Routing.CharacteristicList`

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

## GetExplosion

`ExplodedComponent.``GetExplosion`

  Gets the `NXOpen.Assemblies.Explosion` associated with the exploded component.

  Signature `GetExplosion()`

  Returns: |
  Return type: | `NXOpen.Assemblies.Explosion`

  New in version NX9.0.1.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## GetIntegerCharacteristic

`ExplodedComponent.``GetIntegerCharacteristic`

  Get the value of an integer characteristic associated with the input name.

  Signature `GetIntegerCharacteristic(name)`

  Parameters: | name (str) –
  Returns: |
  Return type: | int

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

## GetRealCharacteristic

`ExplodedComponent.``GetRealCharacteristic`

  Get the value of a real characteristic associated with the input name.

  Signature `GetRealCharacteristic(name)`

  Parameters: | name (str) –
  Returns: |
  Return type: | float

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

## GetStringCharacteristic

`ExplodedComponent.``GetStringCharacteristic`

  Get the value of a string characteristic associated with the input name.

  Signature `GetStringCharacteristic(name)`

  Parameters: | name (str) –
  Returns: |
  Return type: | str

  New in version NX4.0.0.

  License requirements: routing_base (“Routing Basic”)

## Print

`ExplodedComponent.``Print`

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

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## SetCharacteristic

`ExplodedComponent.``SetCharacteristic`

  Overloaded method SetCharacteristic

  - `SetCharacteristic(name, value)`
  - `SetCharacteristic(name, value)`
  - `SetCharacteristic(name, value)`

  `-------------------------------------`

  Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to integer if it’s type is not integer.

  Signature `SetCharacteristic(name, value)`

  Parameters:

  - name (str) –
  - value (int) –

  New in version NX4.0.0.

  Deprecated since version NX11.0.0: Use `NXOpen.Routing.ICharacteristic.SetCharacteristic2()` instead.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to real if it’s type is not real.

  Signature `SetCharacteristic(name, value)`

  Parameters:

  - name (str) –
  - value (float) –

  New in version NX4.0.0.

  Deprecated since version NX11.0.0: Use `NXOpen.Routing.ICharacteristic.SetCharacteristic2()` instead.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn’t exist already. Converts the type of an existing characteristic with the same name to string if it’s type is not string.

  Signature `SetCharacteristic(name, value)`

  Parameters:

  - name (str) –
  - value (str) –

  New in version NX4.0.0.

  Deprecated since version NX11.0.0: Use `NXOpen.Routing.ICharacteristic.SetCharacteristic2()` instead.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

## SetCharacteristic2

`ExplodedComponent.``SetCharacteristic2`

  Overloaded method SetCharacteristic2

  - `SetCharacteristic2(title, value)`
  - `SetCharacteristic2(title, value)`
  - `SetCharacteristic2(title, value)`

  `-------------------------------------`

  Sets or creates an integer type attribute associated with the input title. creating a new attribute if one doesn’t exist already.

  If the method is called on a stock `Assemblies.Component`, the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

  If the method is called on a non-stock `Assemblies.Component`, the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

  If the method is called on any non-component object, the method will access or create an attribute on the object itself.

  Signature `SetCharacteristic2(title, value)`

  Parameters:

  - title (str) – Unique title for the Attribute or Characteristic
  - value (int) – New Value to be set on the Attribute

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Sets or creates a double type attribute associated with the input title. creating a new attribute if one doesn’t exist already.

  If the method is called on a stock `Assemblies.Component`, the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

  If the method is called on a non-stock `Assemblies.Component`, the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

  If the method is called on any non-component object, the method will access or create an attribute on the object itself.

  Signature `SetCharacteristic2(title, value)`

  Parameters:

  - title (str) – Unique title for the Attribute or Characteristic
  - value (float) – New Value to be set on the Attribute

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Sets or creates a string type type attribute associated with the input title. creating a new attribute if one doesn’t exist already.

  If the method is called on a stock `Assemblies.Component`, the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

  If the method is called on a non-stock `Assemblies.Component`, the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

  If the method is called on any non-component object, the method will access or create an attribute on the object itself.

  Signature `SetCharacteristic2(title, value)`

  Parameters:

  - title (str) – Unique title for the Attribute or Characteristic
  - value (str) – New Value to be set on the Attribute

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

## SetCharacteristics

`ExplodedComponent.``SetCharacteristics`

  Set all of the characteristics values on this object.

  Signature `SetCharacteristics(values)`

  Parameters: | values (`NXOpen.Routing.CharacteristicList`) –

  New in version NX4.0.0.

  Deprecated since version NX11.0.0: Use `NXOpen.Routing.ICharacteristic.SetCharacteristics2()` instead.

  License requirements: routing_base (“Routing Basic”)

## SetCharacteristics2

`ExplodedComponent.``SetCharacteristics2`

  Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don’t exist already.

  If the method is called on a stock `Assemblies.Component`, the method will create or edit part attributes on the stock part. For legacy parts where the attributes are on the stock component, the attributes will be moved to the stock part.

  If the method is called on a non-stock `Assemblies.Component`, the method will create or edit attributes on the corresponding instance. For legacy parts where the attribute is on the component, the attributes will be moved to the corresponding instance.

  If the method is called on any non-component object, the method will access or create attributes on the object itself.

  Signature `SetCharacteristics2(values)`

  Parameters: | values (`NXOpen.Routing.CharacteristicList`) – `NXOpen.Routing.CharacteristicList` having the titles, types and values of Attributes to be set

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## SetName

`ExplodedComponent.``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.