PmiNote Class¶
-
class
NXOpen.Annotations.
PmiNote
¶ Bases:
NXOpen.Annotations.BaseNote
Represents a PMI note
To create or edit an instance of this class, use
NXOpen.Annotations.PmiNoteBuilder
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
AnnotationOrigin | Returns or sets the origin (location) of the annotation. |
AnnotationPlane | Returns or sets the annotation plane. |
Color | Returns or sets the color of the object. |
HasAssociativeOrigin | Returns a flag indicating whether the origin is associative |
Index | Returns or sets the index. |
IsBlanked | Returns the blank status of this object. |
IsMirrored | Returns a flag indicating whether the annotation is mirrored |
IsOccurrence | Returns whether this object is an occurrence or not. |
IsRetained | Returns a flag indicating whether the annotation is retained |
IsVertical | Returns or sets a flag indicating whether the note is vertical. |
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. |
LeaderOrientation | Returns or sets the leader orientation for the annotation. |
LineFont | Returns or sets the line font of the object. |
LineWidth | Returns or sets the line width of the object. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
NumberOfAssociativities | Returns the number of associativities for the annotation. |
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 |
---|---|
Blank | Blanks the 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 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. |
GetAssociatedObject | Returns the associated object @return Associated object |
GetAssociativeOrigin | Gets data that specifies the origin’s associativity @return associativity data |
GetAssociativity | Returns the associativity at specified index. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetBusinessModifiers | Returns the business modifiers @return List of business modifiers |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetInferredAnnotationPlane | Returns the inferred annotation plane @return |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetLetteringPreferences | Returns the lettering preferences for the annotation @return |
GetLineAndArrowPreferences | Returns the line and arrow preferences for the annotation @return |
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. |
GetSharedAssociatedObject | Returns the shared associated objects @return Shared associated objects |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetSymbolPreferences | Returns the symbol preferences for the annotation @return |
GetText | Returns the drafting aid’s text @return |
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, 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. |
GetUserSymbolPreferences | Returns the user symbol preferences @return |
GetUserSymbolSize | Gets the user symbol size |
GetViews | Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects. |
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. |
Highlight | Highlights the object. |
InsertIntoStack | Inserts the annotation into a stack. |
Prints a representation of this object to the system log file. | |
RedisplayObject | Redisplays the object in all views. |
RemoveViewDependency | Remove dependency on all views from an object. |
SetAssociatedObject | Sets the associated object. |
SetAssociativeOrigin | Associates the annotation’s origin to the specified geometry. |
SetAssociativity | Sets the associativity at specified index. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetBusinessModifiers | Sets the business modifiers. |
SetLetteringPreferences | Sets the lettering preferences for the annotation. |
SetLineAndArrowPreferences | Sets the line and arrow preferences for the annotation. |
SetName | Sets the custom name of the object. |
SetNameLocation | Sets the location of the object’s name. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetSymbolPreferences | Sets the symbol preferences for the annotation. |
SetText | Sets the drafting aid’s text. |
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. |
SetUserSymbolPreferences | Sets the user symbol preferences. |
SetUserSymbolSize | Sets the user symbol size. |
SetViews | Sets the views that the PMI display instance object is displayed in. |
Unblank | Unblanks the object. |
Unhighlight | Unhighlights the object. |
UpdateFromRule | Updates the specified note from the KF rule. |
Property Detail¶
Index¶
-
PmiNote.
Index
¶ Returns or sets the index.
It is a unique integer assigned to a PMI object.
NOTE: The set 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.
-------------------------------------
Getter Method
Signature
Index()
Returns: Unique integer assigned to the PMI object Return type: int New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Index(index)
Parameters: index (int) – New integer for PMI object New in version NX4.0.0.
License requirements: geometric_tol (“GDT”)
IsMirrored¶
-
PmiNote.
IsMirrored
¶ Returns a flag indicating whether the annotation is mirrored
-------------------------------------
Getter Method
Signature
IsMirrored()
Returns: Mirrored flag Return type: bool New in version NX8.5.0.
License requirements: None.
IsOccurrence¶
-
PmiNote.
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¶
-
PmiNote.
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¶
-
PmiNote.
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¶
-
PmiNote.
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¶
-
PmiNote.
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¶
-
PmiNote.
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¶
-
PmiNote.
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.
GetAssociatedObject¶
-
PmiNote.
GetAssociatedObject
¶ Returns the associated object
Signature
GetAssociatedObject()
Returns: Associated object Return type: NXOpen.Annotations.AssociatedObject
New in version NX4.0.0.
License requirements: None.
GetBusinessModifiers¶
-
PmiNote.
GetBusinessModifiers
¶ Returns the business modifiers
Signature
GetBusinessModifiers()
Returns: List of business modifiers Return type: list of NXOpen.Annotations.BusinessModifier
New in version NX4.0.0.
License requirements: None.
Print¶
-
PmiNote.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetAssociatedObject¶
-
PmiNote.
SetAssociatedObject
¶ Sets the associated 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
SetAssociatedObject(assocObj)
Parameters: assocObj ( NXOpen.Annotations.AssociatedObject
) – New associated objectNew in version NX4.0.0.
License requirements: geometric_tol (“GDT”)
SetBusinessModifiers¶
-
PmiNote.
SetBusinessModifiers
¶ Sets the business modifiers.
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
SetBusinessModifiers(businessModifiers)
Parameters: businessModifiers (list of NXOpen.Annotations.BusinessModifier
) – List of new business modifiersNew in version NX4.0.0.
License requirements: geometric_tol (“GDT”)
SetName¶
-
PmiNote.
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.