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. UseNXOpen.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. |
HasWriteAccess | Returns the write-access status of a part independent of the load state. |
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. |
CgfxAttrs |
|
CgfxMattex |
|
WCS |
|
Arcs |
|
Parabolas |
|
AnalysisManager |
|
MeasureManager |
|
Layers |
|
Xforms |
|
Offsets |
|
Planes |
|
Hyperbolas |
|
Curves |
|
Points |
|
Ellipses |
|
Lines |
|
InfiniteLines |
|
Splines |
|
Polylines |
|
NXMatrices |
|
Scalars |
|
Fonts |
|
Datums |
|
Views |
|
ExpressionGroups |
|
Expressions |
|
UnitCollection |
|
Directions |
|
ModelingViews |
|
LayerCategories |
|
RuleManager |
|
Preferences |
|
Axes |
|
Lights |
|
Sections |
|
ScCollectors |
|
CoordinateSystems |
|
Layouts |
|
PDMPart |
|
Cameras |
|
DynamicSections |
|
Decals |
|
UserDefinedObjectManager |
|
Functions |
|
SelPref |
|
PlotManager |
|
PropertiesManager |
|
BaseFeatures |
|
Colors |
|
Optimization |
|
MaterialManager |
|
DesignStudy |
|
SaveOptions |
|
Validations |
|
Assemblies |
|
AssemblyManager |
|
SHEDObjs |
|
TrueStudioObjs |
|
Grids |
|
ImageCaptureManager |
|
CAMFeatures |
|
RequirementChecks |
|
Requirements |
|
Images |
|
ImagesData |
|
ConvertToPMIBuilderManager |
|
PointClouds |
|
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 |
CreateAttributeIterator | Create an attribute iterator @return A new attribute iterator object |
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 on the object, if any, that satisfy the given iterator |
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 |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
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, 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 |
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. |
Prints a representation of this object to the system log file. | |
RegenerateDisplayFacets | Regenerates display specific transient 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.
HasWriteAccess¶
-
BasePart.
HasWriteAccess
¶ Returns the write-access status of a part independent of the load state.
Set to true if current user has write access on the part, otherwise set to false.
-------------------------------------
Getter Method
Signature
HasWriteAccess()
Returns: Return type: bool New in version NX11.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.
CgfxAttrs¶
CgfxMattex¶
WCS¶
-
BasePart.
WCS
¶ Returns the WCS instance belonging to this part
Signature
WCS()
New in version NX3.0.0.
Returns: Return type: NXOpen.WCS
Arcs¶
-
BasePart.
Arcs
¶ Returns the ArcCollection instance belonging to this part
Signature
Arcs()
New in version NX3.0.0.
Returns: Return type: NXOpen.ArcCollection
Parabolas¶
-
BasePart.
Parabolas
¶ Returns the ParabolaCollection instance belonging to this part
Signature
Parabolas()
New in version NX3.0.0.
Returns: Return type: NXOpen.ParabolaCollection
AnalysisManager¶
-
BasePart.
AnalysisManager
¶ Returns the GeometricAnalysisManager for part
Signature
AnalysisManager()
New in version NX5.0.0.
Returns: Return type: NXOpen.GeometricAnalysis.AnalysisManager
MeasureManager¶
-
BasePart.
MeasureManager
¶ Returns the measure manager for this part
Signature
MeasureManager()
New in version NX3.0.0.
Returns: Return type: NXOpen.MeasureManager
Layers¶
-
BasePart.
Layers
¶ Returns the LayerManager for this part
Signature
Layers()
New in version NX3.0.0.
Returns: Return type: NXOpen.Layer.LayerManager
Xforms¶
-
BasePart.
Xforms
¶ Returns the XformCollection instance belonging to this part
Signature
Xforms()
New in version NX3.0.0.
Returns: Return type: NXOpen.XformCollection
Offsets¶
-
BasePart.
Offsets
¶ Returns the OffsetCollection instance belonging to this part
Signature
Offsets()
New in version NX3.0.0.
Returns: Return type: NXOpen.OffsetCollection
Planes¶
-
BasePart.
Planes
¶ Return a collection of Planes
Signature
Planes()
New in version NX3.0.0.
Returns: Return type: NXOpen.PlaneCollection
Hyperbolas¶
-
BasePart.
Hyperbolas
¶ Returns the HyperbolaCollection instance belonging to this part
Signature
Hyperbolas()
New in version NX3.0.0.
Returns: Return type: NXOpen.HyperbolaCollection
Curves¶
-
BasePart.
Curves
¶ Returns the CurveCollection instance belonging to this part
Signature
Curves()
New in version NX3.0.0.
Returns: Return type: NXOpen.CurveCollection
Points¶
-
BasePart.
Points
¶ Returns the PointCollection instance belonging to this part
Signature
Points()
New in version NX3.0.0.
Returns: Return type: NXOpen.PointCollection
Ellipses¶
-
BasePart.
Ellipses
¶ Returns the EllipseCollection instance belonging to this part
Signature
Ellipses()
New in version NX3.0.0.
Returns: Return type: NXOpen.EllipseCollection
Lines¶
-
BasePart.
Lines
¶ Returns the LineCollection instance belonging to this part
Signature
Lines()
New in version NX3.0.0.
Returns: Return type: NXOpen.LineCollection
InfiniteLines¶
-
BasePart.
InfiniteLines
¶ Returns the InfiniteLineCollection instance belonging to this part
Signature
InfiniteLines()
New in version NX7.5.0.
Returns: Return type: NXOpen.InfiniteLineCollection
Splines¶
-
BasePart.
Splines
¶ Returns the SplineCollection instance belonging to this part
Signature
Splines()
New in version NX5.0.0.
Returns: Return type: NXOpen.SplineCollection
Polylines¶
-
BasePart.
Polylines
¶ Returns the PolylineCollection instance belonging to this part
Signature
Polylines()
New in version NX10.0.0.
Returns: Return type: NXOpen.PolylineCollection
NXMatrices¶
-
BasePart.
NXMatrices
¶ Returns the NXMatrixCollection instance belonging to this part
Signature
NXMatrices()
New in version NX3.0.0.
Returns: Return type: NXOpen.NXMatrixCollection
Scalars¶
-
BasePart.
Scalars
¶ Returns the ScalarCollection instance belonging to this part
Signature
Scalars()
New in version NX3.0.0.
Returns: Return type: NXOpen.ScalarCollection
Fonts¶
-
BasePart.
Fonts
¶ Returns the FontCollection instance belonging to this part
Signature
Fonts()
New in version NX3.0.0.
Returns: Return type: NXOpen.FontCollection
Datums¶
-
BasePart.
Datums
¶ Returns the DatumCollection instance belonging to this part
Signature
Datums()
New in version NX3.0.0.
Returns: Return type: NXOpen.DatumCollection
Views¶
-
BasePart.
Views
¶ Returns the ViewCollection instance belonging to this part
Signature
Views()
New in version NX3.0.0.
Returns: Return type: NXOpen.ViewCollection
ExpressionGroups¶
-
BasePart.
ExpressionGroups
¶ Returns the ExpressionCollection instance belonging to this part
Signature
ExpressionGroups()
New in version NX10.0.0.
Returns: Return type: NXOpen.ExpressionGroupCollection
Expressions¶
-
BasePart.
Expressions
¶ Returns the ExpressionCollection instance belonging to this part
Signature
Expressions()
New in version NX3.0.0.
Returns: Return type: NXOpen.ExpressionCollection
UnitCollection¶
-
BasePart.
UnitCollection
¶ Returns a collection of Units
Signature
UnitCollection()
New in version NX3.0.0.
Returns: Return type: NXOpen.UnitCollection
Directions¶
-
BasePart.
Directions
¶ Returns the DirectionCollection instance belonging to this part
Signature
Directions()
New in version NX3.0.0.
Returns: Return type: NXOpen.DirectionCollection
ModelingViews¶
-
BasePart.
ModelingViews
¶ Returns the ModelingViewCollection instance belonging to this part
Signature
ModelingViews()
New in version NX3.0.0.
Returns: Return type: NXOpen.ModelingViewCollection
LayerCategories¶
-
BasePart.
LayerCategories
¶ Returns a collection of layer categories
Signature
LayerCategories()
New in version NX3.0.0.
Returns: Return type: NXOpen.Layer.CategoryCollection
RuleManager¶
-
BasePart.
RuleManager
¶ Returns the rule manager for this part
Signature
RuleManager()
New in version NX3.0.0.
Returns: Return type: NXOpen.RuleManager
Preferences¶
-
BasePart.
Preferences
¶ Returns the PartPreferences instance belonging to this part
Signature
Preferences()
New in version NX3.0.0.
Returns: Return type: NXOpen.Preferences.PartPreferences
Axes¶
-
BasePart.
Axes
¶ Returns the AxisCollection instance belonging to this part
Signature
Axes()
New in version NX3.0.0.
Returns: Return type: NXOpen.AxisCollection
Lights¶
-
BasePart.
Lights
¶ Returns the LightCollection instance belonging to this part
Signature
Lights()
New in version NX3.0.0.
Returns: Return type: NXOpen.LightCollection
Sections¶
-
BasePart.
Sections
¶ Returns the SectionCollection instance belonging to this part
Signature
Sections()
New in version NX3.0.0.
Returns: Return type: NXOpen.SectionCollection
ScCollectors¶
-
BasePart.
ScCollectors
¶ Returns the ScCollectorCollection instance belonging to this part
Signature
ScCollectors()
New in version NX3.0.0.
Returns: Return type: NXOpen.ScCollectorCollection
CoordinateSystems¶
-
BasePart.
CoordinateSystems
¶ Returns the CoordinateSystemCollection instance belonging to this part
Signature
CoordinateSystems()
New in version NX3.0.0.
Returns: Return type: NXOpen.CoordinateSystemCollection
Layouts¶
-
BasePart.
Layouts
¶ Returns the LayoutCollection instance belonging to this part
Signature
Layouts()
New in version NX3.0.0.
Returns: Return type: NXOpen.LayoutCollection
PDMPart¶
-
BasePart.
PDMPart
¶ Returns the instance of the PDM.
PdmPart class
Signature
PDMPart()
New in version NX3.0.0.
Returns: Return type: NXOpen.PDM.PdmPart
Cameras¶
-
BasePart.
Cameras
¶ Returns the Display.
CameraCollection instance belonging to this part
Signature
Cameras()
New in version NX3.0.0.
Returns: Return type: NXOpen.Display.CameraCollection
DynamicSections¶
-
BasePart.
DynamicSections
¶ Returns the Display.
DynamicSectionCollection instance belonging to this part
Signature
DynamicSections()
New in version NX6.0.0.
Returns: Return type: NXOpen.Display.DynamicSectionCollection
Decals¶
-
BasePart.
Decals
¶ Returns the Display.
DecalCollection instance belonging to this part
Signature
Decals()
New in version NX3.0.0.
Returns: Return type: NXOpen.Display.DecalCollection
UserDefinedObjectManager¶
-
BasePart.
UserDefinedObjectManager
¶ Returns the
NXOpen.UserDefinedObjects.UserDefinedObjectManager
belonging to this sessionSignature
UserDefinedObjectManager()
New in version NX3.0.0.
Returns: Return type: NXOpen.UserDefinedObjects.UserDefinedObjectManager
Functions¶
-
BasePart.
Functions
¶ Returns the CAE.
FunctionCollection for this part
Signature
Functions()
New in version NX5.0.0.
Returns: Return type: NXOpen.CAE.FunctionCollection
SelPref¶
-
BasePart.
SelPref
¶ Returns the Display.
SelPrefCollection instance belonging to this part
Signature
SelPref()
New in version NX3.0.0.
Returns: Return type: NXOpen.Display.SelPrefCollection
PlotManager¶
-
BasePart.
PlotManager
¶ Returns the PlotManager instance belonging to this part
Signature
PlotManager()
New in version NX3.0.0.
Returns: Return type: NXOpen.PlotManager
PropertiesManager¶
-
BasePart.
PropertiesManager
¶ Returns the PropertiesManager instance belonging to this part
Signature
PropertiesManager()
New in version NX8.0.0.
Returns: Return type: NXOpen.PropertiesManager
BaseFeatures¶
-
BasePart.
BaseFeatures
¶ Returns the FeatureCollection instance belonging to this part
Signature
BaseFeatures()
New in version NX3.0.0.
Returns: Return type: NXOpen.Features.BaseFeatureCollection
Colors¶
-
BasePart.
Colors
¶ Manages the standard NX colors
Signature
Colors()
New in version NX3.0.0.
Returns: Return type: NXOpen.ColorManager
Optimization¶
-
BasePart.
Optimization
¶ Returns the optimization instance belonging to this part
Signature
Optimization()
New in version NX3.0.0.
Returns: Return type: NXOpen.Optimization.OptimizationCollection
MaterialManager¶
-
BasePart.
MaterialManager
¶ Returns the Material Manager belonging to this Part
Signature
MaterialManager()
New in version NX3.0.0.
Returns: Return type: NXOpen.MaterialManager
DesignStudy¶
-
BasePart.
DesignStudy
¶ Returns the design study instance belonging to this part
Signature
DesignStudy()
New in version NX3.0.0.
Returns: Return type: NXOpen.Optimization.DesignStudyCollection
SaveOptions¶
-
BasePart.
SaveOptions
¶ Returns the PartSaveOptions instance belonging to this part
Signature
SaveOptions()
New in version NX3.0.0.
Returns: Return type: NXOpen.PartSaveOptions
Validations¶
-
BasePart.
Validations
¶ Returns the validation for this part
Signature
Validations()
New in version NX3.0.0.
Returns: Return type: NXOpen.ValidationCollection
Assemblies¶
-
BasePart.
Assemblies
¶ Returns the
NXOpen.Assemblies.ProductOutlineManager
belonging to this sessionSignature
Assemblies()
New in version NX6.0.0.
Returns: Return type: NXOpen.Assemblies.ProductOutlineManager
AssemblyManager¶
-
BasePart.
AssemblyManager
¶ Returns the
NXOpen.Assemblies.AssemblyManager
belonging to this sessionSignature
AssemblyManager()
New in version NX6.0.0.
Returns: Return type: NXOpen.Assemblies.AssemblyManager
SHEDObjs¶
-
BasePart.
SHEDObjs
¶ Returns the Display.
TrueShadingCollection instance belonging to this part
Signature
SHEDObjs()
New in version NX3.0.0.
Returns: Return type: NXOpen.Display.TrueShadingCollection
TrueStudioObjs¶
-
BasePart.
TrueStudioObjs
¶ Returns the Display.
TrueStudioCollection instance belonging to this part
Signature
TrueStudioObjs()
New in version NX8.0.0.
Returns: Return type: NXOpen.Display.TrueStudioCollection
Grids¶
-
BasePart.
Grids
¶ Returns the Display.
GridCollection instance belonging to this part
Signature
Grids()
New in version NX6.0.0.
Returns: Return type: NXOpen.Display.GridCollection
ImageCaptureManager¶
-
BasePart.
ImageCaptureManager
¶ Returns the Gateway.
ImageCaptureManager instance belonging to this part
Signature
ImageCaptureManager()
New in version NX7.5.0.
Returns: Return type: NXOpen.Gateway.ImageCaptureManager
CAMFeatures¶
-
BasePart.
CAMFeatures
¶ Returns the CAMFeatureCollection instance belonging to this part
Signature
CAMFeatures()
New in version NX7.5.0.
Returns: Return type: NXOpen.CAM.CAMFeatureCollection
RequirementChecks¶
-
BasePart.
RequirementChecks
¶ Returns the RequirementCheckCollection instance belonging to this part
Signature
RequirementChecks()
New in version NX8.5.0.
Returns: Return type: NXOpen.Validate.RequirementCheckCollection
Requirements¶
-
BasePart.
Requirements
¶ Returns the RequirementCollection instance belonging to this part
Signature
Requirements()
New in version NX8.5.0.
Returns: Return type: NXOpen.Validate.RequirementCollection
Images¶
-
BasePart.
Images
¶ Returns the Display.
ImageCollection instance belonging to this part
Signature
Images()
New in version NX9.0.0.
Returns: Return type: NXOpen.Display.ImageCollection
ImagesData¶
-
BasePart.
ImagesData
¶ Returns the Display.
ImageDataCollection instance belonging to this part
Signature
ImagesData()
New in version NX9.0.0.
Returns: Return type: NXOpen.Display.ImageDataCollection
ConvertToPMIBuilderManager¶
-
BasePart.
ConvertToPMIBuilderManager
¶ Returns the Drawings.
BuilderManager belonging to this part
Signature
ConvertToPMIBuilderManager()
New in version NX11.0.0.
Returns: Return type: NXOpen.Drawings.ConvertToPMIBuilderManager
PointClouds¶
-
BasePart.
PointClouds
¶ Returns the Display.
PointCloudCollection instance belonging to this part
Signature
PointClouds()
New in version NX11.0.0.
Returns: Return type: NXOpen.Display.PointCloudCollection
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 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: - wholeTree (
NXOpen.BasePartCloseWholeTree
) – If true, unloads all components of the part. If false, unloads only the top-level part - closeModified (
NXOpen.BasePartCloseModified
) – Behavior of close if component parts are modified. - responses (
NXOpen.PartCloseResponses
) – Class representing list of parts to close or leave open if modified. Only used if closed_modified is set toNXOpen.BasePartCloseModified.UseResponses
. IfNXOpen.BasePartCloseModified.UseResponses
is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. SeeNXOpen.PartCloseResponses
for how to add responses to this class.
New in version NX4.0.0.
License requirements: None.
- wholeTree (
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: - cd (
NXOpen.CollaborativeDesign
) – - effectivityFormula (str) –
Returns: Return type: New in version NX8.5.0.
License requirements: None.
-------------------------------------
Creates a
NXOpen.EffectivityConditionBuilder
with initializing validation basis formulaSignature
CreateEffectivityConditionBuilder(cd, validationBasisFormula, effectivityFormula)
Parameters: - cd (
NXOpen.CollaborativeDesign
) – - validationBasisFormula (str) –
- effectivityFormula (str) –
Returns: Return type: 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
objectSignature
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
objectSignature
DeleteReferenceSet(referenceSetObject)
Parameters: referenceSetObject ( NXOpen.ReferenceSet
) – Reference set object to be deletedNew 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
¶ Overloaded method RegenerateDisplayFacets
RegenerateDisplayFacets(regenerateChildren)
RegenerateDisplayFacets(deleteSavedDisplayFacets, regenerateChildren)
-------------------------------------
Regenerates display specific transient cached facets in the part. This does not change display facets that are saved in the part file.
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.
Deprecated since version NX11.0.0: Use
NXOpen.BasePart.RegenerateDisplayFacets()
overload instead.License requirements: None.
-------------------------------------
Regenerates display specific cached facets in the part.
Display facets that are currently saved in the part can be deleted along with the transient display facets. Transient display facets are held in memory for reuse. Deleting saved display facets will mark the part as modified.
Signature
RegenerateDisplayFacets(deleteSavedDisplayFacets, regenerateChildren)
Parameters: - deleteSavedDisplayFacets (bool) – Indicates if saved display facets should be deleted
- regenerateChildren (bool) – Indicates if the children of this part have their cached display facets regenerated
New in version NX11.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: - wholeTree (
NXOpen.BasePartCloseWholeTree
) – If true, unloads all components of the part. If false, unloads only the top-level part - closeModified (
NXOpen.BasePartCloseModified
) – Behavior of close if component parts are modified. - responses (
NXOpen.PartCloseResponses
) – Class representing list of parts to close or leave open if modified. Only used if closed_modified is set toNXOpen.BasePartCloseModified.UseResponses
. IfNXOpen.BasePartCloseModified.UseResponses
is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. SeeNXOpen.PartCloseResponses
for how to add responses to this class.
Returns: a tuple
Return type: A tuple consisting of (reloadedPart, reopenReport). reloadedPart is a
NXOpen.BasePart
. The reloaded part reopenReport is aNXOpen.PartReopenReport
. Report containing results of reopen commandNew in version NX4.0.0.
License requirements: None.
- wholeTree (
ReopenAs¶
-
BasePart.
ReopenAs
¶ Reopens a loaded part.
Signature
ReopenAs(fileName, closeModified, responses)
Parameters: - fileName (str) – name of part file to open
- closeModified (
NXOpen.BasePartCloseModified
) – Behavior of close if component parts are modified. - responses (
NXOpen.PartCloseResponses
) – Class representing list of parts to close or leave open if modified. Only used if closed_modified is set toNXOpen.BasePartCloseModified.UseResponses
. IfNXOpen.BasePartCloseModified.UseResponses
is set, then any parts that are candidates for being closed that are not in this list will be closed whether modified or not. SeeNXOpen.PartCloseResponses
for how to add responses to this class.
Returns: a tuple
Return type: A tuple consisting of (reloadedPart, reopenReport). reloadedPart is a
NXOpen.BasePart
. The reloaded part reopenReport is aNXOpen.PartReopenReport
. Report containing results of reopen commandNew 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: - saveComponentParts (
NXOpen.BasePartSaveComponents
) – The part’s components are saved if modified if this parameter is set toNXOpen.BasePartSaveComponents.True
. - close (
NXOpen.BasePartCloseAfterSave
) – The part is closed if this parameter is set toNXOpen.BasePartCloseAfterSave.True
.
Returns: Parts that could not be saved and their associated errors.
Return type: New in version NX4.0.0.
License requirements: None.
- saveComponentParts (
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 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: - fileName (str) – Name of bookmark file.
- option (
NXOpen.BasePartBookmarkOption
) – See definitions ofNXOpen.BasePartBookmarkOption
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) – 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.