NativePartLogicalObject Class¶
-
class
NXOpen.PDM.
NativePartLogicalObject
¶ Bases:
NXOpen.PDM.LogicalObject
Represents the class that contains information for the objects participating in import operation.
Instances of this class can be accessed through various application specific builders
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Name | Returns the custom name of the object. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
CreateAttributeIterator | Create an attribute iterator @return A new attribute iterator object |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetExistingPartAction | Gets the existing part action defined for this part @return |
GetFinalName | Gets the final name of this logical object. |
GetInitialName | Gets the initial name of this logical object. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
GetValidationMode | Gets the validation mode setting defined for this part @return |
GetValidationRuleSetFileBrowseOption | Gets the validation rule set file browse option defined for this part @return |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator @return |
IsCandidateForImport | Checks if the part represented by this logical object is a candidate for import. |
IsPartNameAutoAssigned | Gets the flag indicating whether part name is autoassigned or not. |
Prints a representation of this object to the system log file. | |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetExistingPartAction | Sets the existing part action defined for this part |
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. |
SetValidationMode | Sets the validation mode setting defined for this part |
SetValidationRuleSetFileBrowseOption | Sets the validation rule set file browse option defined for this part |
Property Detail¶
IsOccurrence¶
-
NativePartLogicalObject.
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¶
-
NativePartLogicalObject.
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¶
-
NativePartLogicalObject.
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¶
-
NativePartLogicalObject.
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¶
-
NativePartLogicalObject.
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¶
-
NativePartLogicalObject.
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¶
FindObject¶
-
NativePartLogicalObject.
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.
GetExistingPartAction¶
-
NativePartLogicalObject.
GetExistingPartAction
¶ Gets the existing part action defined for this part
Signature
GetExistingPartAction()
Returns: Return type: NXOpen.PDM.PartOperationImportBuilderExistingPartAction
New in version NX10.0.0.
License requirements: None.
GetFinalName¶
-
NativePartLogicalObject.
GetFinalName
¶ Gets the final name of this logical object.
Signature
GetFinalName()
Returns: the database name assigned to the part being imported Return type: str New in version NX10.0.0.
License requirements: None.
GetInitialName¶
-
NativePartLogicalObject.
GetInitialName
¶ Gets the initial name of this logical object.
Signature
GetInitialName()
Returns: the filename of added for import Return type: str New in version NX10.0.0.
License requirements: None.
GetValidationMode¶
-
NativePartLogicalObject.
GetValidationMode
¶ Gets the validation mode setting defined for this part
Signature
GetValidationMode()
Returns: Return type: NXOpen.PDM.PartOperationImportBuilderValidation
New in version NX10.0.0.
License requirements: None.
GetValidationRuleSetFileBrowseOption¶
-
NativePartLogicalObject.
GetValidationRuleSetFileBrowseOption
¶ Gets the validation rule set file browse option defined for this part
Signature
GetValidationRuleSetFileBrowseOption()
Returns: Return type: NXOpen.PDM.PartOperationImportBuilderValidationRuleSetFileBrowseOption
New in version NX10.0.0.
License requirements: None.
IsCandidateForImport¶
-
NativePartLogicalObject.
IsCandidateForImport
¶ Checks if the part represented by this logical object is a candidate for import.
The part is not a candidate for import if it is lost or name-only.
Signature
IsCandidateForImport()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
IsPartNameAutoAssigned¶
-
NativePartLogicalObject.
IsPartNameAutoAssigned
¶ Gets the flag indicating whether part name is autoassigned or not.
Signature
IsPartNameAutoAssigned()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Print¶
-
NativePartLogicalObject.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetExistingPartAction¶
-
NativePartLogicalObject.
SetExistingPartAction
¶ Sets the existing part action defined for this part
Signature
SetExistingPartAction(existingPartAction)
Parameters: existingPartAction ( NXOpen.PDM.PartOperationImportBuilderExistingPartAction
) –New in version NX10.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetName¶
-
NativePartLogicalObject.
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.
SetValidationMode¶
-
NativePartLogicalObject.
SetValidationMode
¶ Sets the validation mode setting defined for this part
Signature
SetValidationMode(validationMode)
Parameters: validationMode ( NXOpen.PDM.PartOperationImportBuilderValidation
) –New in version NX10.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SetValidationRuleSetFileBrowseOption¶
-
NativePartLogicalObject.
SetValidationRuleSetFileBrowseOption
¶ Sets the validation rule set file browse option defined for this part
Signature
SetValidationRuleSetFileBrowseOption(browseOption)
Parameters: browseOption ( NXOpen.PDM.PartOperationImportBuilderValidationRuleSetFileBrowseOption
) –New in version NX10.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)