Properties¶
Property | Description |
---|---|
CheckStatus | Returns or sets the node check status. |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Modifiable | Returns or sets the node modifiable property. |
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. |
Title | Returns or sets the node title. |
Methods¶
Method | Description |
---|---|
AddChild | Adds a child node. |
CreateAttributeIterator | Create an attribute iterator |
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. |
GetChildren | Gets children nodes. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetNextNode | Get next node. |
GetNextSiblingNode | Gets next sibling node. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetNodeObjects | Gets the objects represented by the node. |
GetParent | Gets parent node. |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
GetPreviousNode | Get previous node. |
GetPreviousSiblingNode | Gets previous sibling node. |
GetProperty | Gets the node property. |
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. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
Prints a representation of this object to the system log file. | |
RemoveChild | Removes a child node. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetDraggable | Sets the node draggable attribute. |
SetIcon | Sets the node icon. |
SetName | Sets the custom name of the object. |
SetNodeObjects | Sets the objects represented by the node. |
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on 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. |
UpdateProperty | Sets the node property. |
Property Detail¶
CheckStatus¶
Returns or sets the node check status.
-------------------------------------
Getter Method
Signature
CheckStatus
Returns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckStatus
Parameters: checkStatus (bool) – New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
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¶
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.
Modifiable¶
Returns or sets the node modifiable property.
-------------------------------------
Getter Method
Signature
Modifiable
Returns: Return type: bool New in version NX11.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Modifiable
Parameters: modifiable (bool) – New in version NX11.0.2.
License requirements: nx_ship_basic (“Ship Basic Design”)
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¶
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¶
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¶
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.
Title¶
Returns or sets the node title.
-------------------------------------
Getter Method
Signature
Title
Returns: Return type: str New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
Title
Parameters: title (str) – New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
Method Detail¶
AddChild¶
Adds a child node.
Signature
AddChild(name, nodeObjects, createPersistentData)
Parameters: - name (str) –
- nodeObjects (list of
NXOpen.TaggedObject
) – - createPersistentData (bool) –
Returns: Return type: New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
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.
GetChildren¶
Gets children nodes.
Signature
GetChildren()
Returns: Return type: list of NXOpen.ShipDesign.NavigatorNode
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetNextNode¶
Get next node.
If this node has some child nodes, the next node is the first child. Otherwise return next sibling of this node, or its parent node, or its grandparent node…
Signature
GetNextNode()
Returns: Return type: NXOpen.ShipDesign.NavigatorNode
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetNextSiblingNode¶
Gets next sibling node.
Signature
GetNextSiblingNode()
Returns: Return type: NXOpen.ShipDesign.NavigatorNode
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetNodeObjects¶
Gets the objects represented by the node.
Signature
GetNodeObjects()
Returns: Return type: list of NXOpen.TaggedObject
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetParent¶
Gets parent node.
Signature
GetParent()
Returns: Return type: NXOpen.ShipDesign.NavigatorNode
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetPreviousNode¶
Get previous node.
If this node has no prior siblings, the previous node is its parent node if it has. If this node has a prior sibling, the previous node is the last descendant node of this previous sibling.
Signature
GetPreviousNode()
Returns: Return type: NXOpen.ShipDesign.NavigatorNode
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetPreviousSiblingNode¶
Gets previous sibling node.
Signature
GetPreviousSiblingNode()
Returns: Return type: NXOpen.ShipDesign.NavigatorNode
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
GetProperty¶
Gets the node property.
Signature
GetProperty(propertyName)
Parameters: propertyName (str) – Returns: Return type: str New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
Print¶
Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveChild¶
Removes a child node.
Signature
RemoveChild(childNode)
Parameters: childNode ( NXOpen.ShipDesign.NavigatorNode
) –New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
SetDraggable¶
Sets the node draggable attribute.
Signature
SetDraggable(draggable)
Parameters: draggable (bool) – New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
SetIcon¶
Sets the node icon.
Signature
SetIcon(icon)
Parameters: icon (str) – New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
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.
SetNodeObjects¶
Sets the objects represented by the node.
Signature
SetNodeObjects(nodeObjects)
Parameters: nodeObjects (list of NXOpen.TaggedObject
) –New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)
UpdateProperty¶
Sets the node property.
Signature
UpdateProperty(propertyName, propertyValue)
Parameters: - propertyName (str) –
- propertyValue (str) –
New in version NX11.0.1.
License requirements: nx_ship_basic (“Ship Basic Design”)