PathObjects Class¶
-
class
NXOpen.Fields.
PathObjects
¶ Bases:
NXOpen.SelectObjectList
Contains objects that define a lattice path
Not a KF builder; see Fields.FieldManager methods to create a Fields.PathObjects.
New in version NX6.0.1.
Properties¶
Property | Description |
---|---|
DuplicatesAllowed | Returns whether duplicate objects are allowed in the selection list. |
Size | Returns the number of objects in the list. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Add | Adds an object to the list |
Clear | Removes all items from the list. |
Contains | Returns whether the specified object is already in the list or not. |
GetArray | Returns the list of objects in the selection list. |
GetSelectObjectArray | Returns the list of SelectObjects in the selection list. |
HandleLatestSelDirection | Check the direction of the lastest selection and reverse it if necessary |
Remove | Remove specified object from list. |
RemoveArray | Remove specified objects from list. |
ReverseDirection | Reverses the order of the objects in the path |
ReverseSectionDirection | Reverses the order of the objects in the path |
SetArray | Sets the list of objects in the selection list. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Method Detail¶
HandleLatestSelDirection¶
-
PathObjects.
HandleLatestSelDirection
¶ Check the direction of the lastest selection and reverse it if necessary
Signature
HandleLatestSelDirection()
New in version NX11.0.0.
License requirements: None.
ReverseDirection¶
-
PathObjects.
ReverseDirection
¶ Reverses the order of the objects in the path
Signature
ReverseDirection()
New in version NX6.0.1.
License requirements: None.
ReverseSectionDirection¶
-
PathObjects.
ReverseSectionDirection
¶ Reverses the order of the objects in the path
Signature
ReverseSectionDirection(index)
Parameters: index (int) – New in version NX11.0.0.
License requirements: None.
Validate¶
-
PathObjects.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.