BasePart Class

class NXOpen.BasePart

Bases: NXOpen.NXObject

Base class for an NX part.

Use the NXOpen.PartCollection class to load or create a part. Use NXOpen.PartCollection.WorkComponentOption to obtain the current work part.

New in version NX4.0.0.

Properties

Property Description
ComponentAssembly Returns the component assembly.
FieldManager Returns the field main.
FullPath Returns the full path of the part.
IsFullyLoaded Returns the load status of a part.
IsOccurrence Returns whether this object is an occurrence or not.
IsReadOnly Returns the read-only status of a part.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Leaf Returns the leaf name of the part.
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
PartPreviewMode Returns or sets the preview mode
PartUnits Returns the units of the part file.
Prototype Returns the prototype of this object if it is an occurrence.
SaveDisplayFacets Returns or sets whether display quality facets are saved in the part file
Tag Returns the Tag for this object.
UniqueIdentifier Returns or sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open.

Methods

Method Description
AssignPermanentName Saves a temporary part with the given name.
CanBeDisplayPart Returns true if the part can be displayed and false if not displayed @return
Close Closes an open part.
CompleteStructure Make additions necessary to complete the incomplete assembly structure of the input part
CreateDynamicSectionBuilder Creates a NXOpen.Display.DynamicSectionBuilder The base part must be a displayable part, otherwise an exception will be thrown.
CreateEffectivityConditionBuilder Creates a NXOpen.EffectivityConditionBuilder @return
CreateFacetSettingsBuilder Creates a builder for the Facet Settings dialog @return
CreateGatewayGroupBuilder Creates a Groups builder @return GroupBuilder object
CreatePerspectiveOptionsBuilder Creates a builder for the Perspective Options dialog @return
CreateReferenceSet Creates a NXOpen.ReferenceSet object @return New reference set object
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteReferenceSet Deletes a NXOpen.ReferenceSet object
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes encountered with the given Type with option to update or not.
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAllReferenceSets Get all the NXOpen.ReferenceSet objects in this part.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetCollaborativeContentType The collaborative content type of this part.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetHistoryInformation Get history of part @return list of history data for the part.
GetIncompleteStatus Inquire whether the provided part is flagged as being incomplete @return
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetMakeUniqueName Gets the Unique name on a part for the Make Unique operation @return
GetPreviewImage Get the preview image This will return the graphic preview image of the part (when available).
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.
GetTransientStatus Inquire whether the provided part is flagged as being transient @return
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, of the given type.
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.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object.
LoadFeatureDataForSelection Ensure that feature data is loaded for a part.
LoadFully Ensures that this part is fully loaded.
LoadThisPartFully Ensures that this part is fully loaded.
Print Prints a representation of this object to the system log file.
RegenerateDisplayFacets Regenerates display specific cached facets in the part.
ReinstateTransience Reinstate the transient status to the formerly transient input part
RemoveTransience Remove the transient status from the input part
Reopen Reopens a loaded part.
ReopenAs Reopens a loaded part.
ReverseBlankAll Reverse blank all the objects in the part.
Save Saves the part whether it is modified or not.
SaveAs Creates copy of target part.
SaveBookmark Saves a bookmark file.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetMakeUniqueName Sets the unique name on part for the Make Unique operation
SetName Sets the custom name of 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.

Enumerations

BasePartBookmarkOption Enumeration Controls the information written to a bookmark file.
BasePartCloseAfterSave Enumeration Used to specify whether a part should be closed after it is saved.
BasePartCloseModified Enumeration Indicates how part close should handle component parts when they are modified
BasePartCloseWholeTree Enumeration Used to specify whether or not to close a part’s components during a close operation.
BasePartCollaborativeContentType Enumeration Represents the collaborative content type corresponding to this part
BasePartPartPreview Enumeration Specifies the preview mode of the part file.
BasePartSaveComponents Enumeration Used to specify whether a part’s components should be saved (if modified) when the part is saved.
BasePartUnits Enumeration The units of the part file.

Structs

BasePartHistoryEventInformation_Struct Struct Contains part history event information
BasePartIncompleteStatus_Struct Struct Incomplete part return data
BasePartTransientStatus_Struct Struct Transient part return data

Property Detail

ComponentAssembly

BasePart.ComponentAssembly

Returns the component assembly.

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

Getter Method

Signature ComponentAssembly()

Returns:
Return type:NXOpen.Assemblies.ComponentAssembly

New in version NX3.0.0.

License requirements: None.

FieldManager

BasePart.FieldManager

Returns the field main.

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

Getter Method

Signature FieldManager()

Returns:
Return type:NXOpen.Fields.FieldManager

New in version NX4.0.0.

License requirements: None.

FullPath

BasePart.FullPath

Returns the full path of the part.

When called in a managed environment, this will give the same value as NXOpen.BasePart.Leaf.

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

Getter Method

Signature FullPath()

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

IsFullyLoaded

BasePart.IsFullyLoaded

Returns the load status of a part.

Set to true if part is fully loaded and set to false if the part is partially loaded.

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

Getter Method

Signature IsFullyLoaded()

Returns:
Return type:bool

New in version NX3.0.0.

License requirements: None.

IsOccurrence

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

IsReadOnly

BasePart.IsReadOnly

Returns the read-only status of a part.

Set to true if part is read-only and set to false if the part is modifiable.

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

Getter Method

Signature IsReadOnly()

Returns:
Return type:bool

New in version NX5.0.2.

License requirements: None.

JournalIdentifier

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

Leaf

BasePart.Leaf

Returns the leaf name of the part.

When called in a managed environment, this will give the Item ID and Revision (prior to NX8.5 this method only returned the Item ID).

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

Getter Method

Signature Leaf()

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Name

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

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

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

PartPreviewMode

BasePart.PartPreviewMode

Returns or sets the preview mode

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

Getter Method

Signature PartPreviewMode()

Returns:
Return type:NXOpen.BasePartPartPreview

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature PartPreviewMode(mode)

Parameters:mode (NXOpen.BasePartPartPreview) –

New in version NX3.0.0.

License requirements: None.

PartUnits

BasePart.PartUnits

Returns the units of the part file.

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

Getter Method

Signature PartUnits()

Returns:
Return type:NXOpen.BasePartUnits

New in version NX3.0.0.

License requirements: None.

Prototype

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

SaveDisplayFacets

BasePart.SaveDisplayFacets

Returns or sets whether display quality facets are saved in the part file

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

Getter Method

Signature SaveDisplayFacets()

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SaveDisplayFacets(saveDisplayFacets)

Parameters:saveDisplayFacets (bool) –

New in version NX9.0.0.

License requirements: None.

UniqueIdentifier

BasePart.UniqueIdentifier

Returns or sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open.

When set if the input value is the empty string a new unqiue uid is allocated for the part otherwise the supplied uid is used.

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

Getter Method

Signature UniqueIdentifier()

Returns:
Return type:str

New in version NX6.0.5.

License requirements: None.

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

Setter Method

Signature UniqueIdentifier(identifier)

Parameters:identifier (str) –

New in version NX6.0.5.

License requirements: None.

Method Detail

AssignPermanentName

BasePart.AssignPermanentName

Saves a temporary part with the given name.

Signature AssignPermanentName(newFileName)

Parameters:newFileName (str) – name of new part file to create NOTE: The full Unicode character set is not supported for this parameter.

New in version NX5.0.0.

License requirements: None.

CanBeDisplayPart

BasePart.CanBeDisplayPart

Returns true if the part can be displayed and false if not displayed

Signature CanBeDisplayPart()

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

Close

BasePart.Close

Closes an open part.

Signature Close(wholeTree, closeModified, responses)

Parameters:

New in version NX4.0.0.

License requirements: None.

CompleteStructure

BasePart.CompleteStructure

Make additions necessary to complete the incomplete assembly structure of the input part

Signature CompleteStructure()

New in version NX4.0.0.

License requirements: None.

CreateDynamicSectionBuilder

BasePart.CreateDynamicSectionBuilder

Creates a NXOpen.Display.DynamicSectionBuilder The base part must be a displayable part, otherwise an exception will be thrown.

By default, the section builder uses the current work view. The current work view must be a modeling view, otherwise an exception will be thrown.

Signature CreateDynamicSectionBuilder(loadFromView)

Parameters:loadFromView (bool) – If true, reads section information from working view. Otherwise, default section is created.
Returns:
Return type:NXOpen.Display.DynamicSectionBuilder

New in version NX5.0.0.

Deprecated since version NX6.0.0: Use NXOpen.BasePart.DynamicSections` instead.

License requirements: None.

CreateEffectivityConditionBuilder

BasePart.CreateEffectivityConditionBuilder

Overloaded method CreateEffectivityConditionBuilder

  • CreateEffectivityConditionBuilder(cd, effectivityFormula)
  • CreateEffectivityConditionBuilder(cd, validationBasisFormula, effectivityFormula)

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

Creates a NXOpen.EffectivityConditionBuilder

Signature CreateEffectivityConditionBuilder(cd, effectivityFormula)

Parameters:
Returns:
Return type:

NXOpen.EffectivityConditionBuilder

New in version NX8.5.0.

License requirements: None.

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

Creates a NXOpen.EffectivityConditionBuilder with initializing validation basis formula

Signature CreateEffectivityConditionBuilder(cd, validationBasisFormula, effectivityFormula)

Parameters:
Returns:
Return type:

NXOpen.EffectivityConditionBuilder

New in version NX9.0.0.

License requirements: None.

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

CreateFacetSettingsBuilder

BasePart.CreateFacetSettingsBuilder

Creates a builder for the Facet Settings dialog

Signature CreateFacetSettingsBuilder()

Returns:
Return type:NXOpen.Display.FacetSettingsBuilder

New in version NX8.0.0.

License requirements: None.

CreateGatewayGroupBuilder

BasePart.CreateGatewayGroupBuilder

Creates a Groups builder

Signature CreateGatewayGroupBuilder(group)

Parameters:group (NXOpen.Group) –
Returns:GroupBuilder object
Return type:NXOpen.GroupBuilder

New in version NX5.0.0.

License requirements: None.

CreatePerspectiveOptionsBuilder

BasePart.CreatePerspectiveOptionsBuilder

Creates a builder for the Perspective Options dialog

Signature CreatePerspectiveOptionsBuilder()

Returns:
Return type:NXOpen.Display.PerspectiveOptionsBuilder

New in version NX8.0.0.

License requirements: None.

CreateReferenceSet

BasePart.CreateReferenceSet

Creates a NXOpen.ReferenceSet object

Signature CreateReferenceSet()

Returns:New reference set object
Return type:NXOpen.ReferenceSet

New in version NX6.0.0.

License requirements: None.

DeleteReferenceSet

BasePart.DeleteReferenceSet

Deletes a NXOpen.ReferenceSet object

Signature DeleteReferenceSet(referenceSetObject)

Parameters:referenceSetObject (NXOpen.ReferenceSet) – Reference set object to be deleted

New in version NX6.0.0.

License requirements: None.

FindObject

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

GetAllReferenceSets

BasePart.GetAllReferenceSets

Get all the NXOpen.ReferenceSet objects in this part.

Does not include the default reference sets Empty and Entire Part.

Signature GetAllReferenceSets()

Returns:
Return type:list of NXOpen.ReferenceSet

New in version NX7.5.0.

License requirements: None.

GetCollaborativeContentType

BasePart.GetCollaborativeContentType

The collaborative content type of this part.

It will return NXOpen.BasePart.CollaborativeContentTypeNotAssigned for the part that does not represent any collaborative content.

Signature GetCollaborativeContentType()

Returns:
Return type:NXOpen.BasePartCollaborativeContentType

New in version NX8.5.0.

License requirements: None.

GetHistoryInformation

BasePart.GetHistoryInformation

Get history of part

Signature GetHistoryInformation()

Returns:list of history data for the part. The list is sorted in

descending order on version number. :rtype: list of NXOpen.BasePartHistoryEventInformation_Struct

New in version NX4.0.0.

License requirements: None.

GetIncompleteStatus

BasePart.GetIncompleteStatus

Inquire whether the provided part is flagged as being incomplete

Signature GetIncompleteStatus()

Returns:
Return type:NXOpen.BasePartIncompleteStatus_Struct

New in version NX4.0.0.

License requirements: None.

GetMakeUniqueName

BasePart.GetMakeUniqueName

Gets the Unique name on a part for the Make Unique operation

Signature GetMakeUniqueName()

Returns:
Return type:str

New in version NX8.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

GetPreviewImage

BasePart.GetPreviewImage

Get the preview image This will return the graphic preview image of the part (when available).

The call returns the image width and height and a single array of integer RGB pixels. The total number of pixels is width * height. Each 32 bit integer pixel contains 8 bit values for the red, green and blue color components and the alpha channel is not used and set to 255. The byte order corresponds to the .NET method System.Drawing.Color.FromArgb, so the order is ARGB. For Java the byte order and data corresponds to the BufferedImage type TYPE_INT_RGB. The pixels at an xy location can be found as (y*width+x) where x is from 0 to width-1, and y indexes from 0 to height-1. The RGB pixels can be loaded into an appropriate image tool such as the Java BufferedImage class for display.

Note: this will return the modeling preview image only.

Signature GetPreviewImage()

Returns:a tuple
Return type:A tuple consisting of (width, height, pixels). width is a int. image width height is a int. image height pixels is a list of int. Array of pixels

New in version NX5.0.2.

License requirements: None.

GetTransientStatus

BasePart.GetTransientStatus

Inquire whether the provided part is flagged as being transient

Signature GetTransientStatus()

Returns:
Return type:NXOpen.BasePartTransientStatus_Struct

New in version NX4.0.0.

License requirements: None.

LoadFeatureDataForSelection

BasePart.LoadFeatureDataForSelection

Ensure that feature data is loaded for a part.

Signature LoadFeatureDataForSelection()

Returns:If the part could not be loaded, this object contains the error information.
Return type:NXOpen.PartLoadStatus

New in version NX6.0.1.

License requirements: None.

LoadFully

BasePart.LoadFully

Ensures that this part is fully loaded.

If the part is already fully loaded (NXOpen.BasePart.IsFullyLoaded returns true) then this method has no effect.

Signature LoadFully()

Returns:If the part could not be loaded, this object contains the error information.
Return type:NXOpen.PartLoadStatus

New in version NX5.0.0.

License requirements: None.

LoadThisPartFully

BasePart.LoadThisPartFully

Ensures that this part is fully loaded.

If the part is already fully loaded (NXOpen.BasePart.IsFullyLoaded returns true) then this method has no effect. Does not load any components regardless of the current load option.

Signature LoadThisPartFully()

Returns:If the part could not be loaded, this object contains the error information.
Return type:NXOpen.PartLoadStatus

New in version NX5.0.0.

License requirements: None.

Print

BasePart.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RegenerateDisplayFacets

BasePart.RegenerateDisplayFacets

Regenerates display specific cached facets in the part.

Signature RegenerateDisplayFacets(regenerateChildren)

Parameters:regenerateChildren (bool) – Should the children of this part have their cached display facets regenerated also

New in version NX9.0.0.

License requirements: None.

ReinstateTransience

BasePart.ReinstateTransience

Reinstate the transient status to the formerly transient input part

Signature ReinstateTransience()

New in version NX4.0.0.

License requirements: None.

RemoveTransience

BasePart.RemoveTransience

Remove the transient status from the input part

Signature RemoveTransience()

New in version NX4.0.0.

License requirements: None.

Reopen

BasePart.Reopen

Reopens a loaded part.

Signature Reopen(wholeTree, closeModified, responses)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (reloadedPart, reopenReport). reloadedPart is a NXOpen.BasePart. The reloaded part reopenReport is a NXOpen.PartReopenReport. Report containing results of reopen command

New in version NX4.0.0.

License requirements: None.

ReopenAs

BasePart.ReopenAs

Reopens a loaded part.

Signature ReopenAs(fileName, closeModified, responses)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (reloadedPart, reopenReport). reloadedPart is a NXOpen.BasePart. The reloaded part reopenReport is a NXOpen.PartReopenReport. Report containing results of reopen command

New in version NX4.0.0.

License requirements: None.

ReverseBlankAll

BasePart.ReverseBlankAll

Reverse blank all the objects in the part.

Signature ReverseBlankAll()

New in version NX4.0.0.

License requirements: None.

Save

BasePart.Save

Saves the part whether it is modified or not.

Signature Save(saveComponentParts, close)

Parameters:
Returns:

Parts that could not be saved and their associated errors.
Return type:

NXOpen.PartSaveStatus

New in version NX4.0.0.

License requirements: None.

SaveAs

BasePart.SaveAs

Creates copy of target part.

Note for using this in managed environment: This is **deprecated in NX10</b> for “Save As of master parts” operation. This API should only be used in case of Save As Non Master parts and Save As New Item Type Operations. In managed environment, for Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder. This API will not support Save As if there are duplicate item ids in database.

Signature SaveAs(newFileName)

Parameters:newFileName (str) – name of new part file to create NOTE: The full Unicode character set is not supported for this parameter.
Returns:Parts that could could not saved and their associated errors.
Return type:NXOpen.PartSaveStatus

New in version NX4.0.0.

License requirements: None.

SaveBookmark

BasePart.SaveBookmark

Saves a bookmark file.

Signature SaveBookmark(fileName, option)

Parameters:

New in version NX4.0.0.

License requirements: None.

SetMakeUniqueName

BasePart.SetMakeUniqueName

Sets the unique name on part for the Make Unique operation

Signature SetMakeUniqueName(newUniqueName)

Parameters:newUniqueName (str) – NOTE: The full Unicode character set is not supported for this parameter.

New in version NX8.0.0.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SetName

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