OffsetPath Class¶
-
class
NXOpen.Routing.
OffsetPath
¶ Bases:
NXOpen.NXObject
,NXOpen.Routing.IPath
The Routing OffsetPath object is the set of information needed to define an offset route.
To obtain an instance of this class use
NXOpen.Routing.OffsetPathCollection
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
BendRadius | Returns or sets the bend radius for an offset object. |
BendRatio | Returns or sets the bend ratio for an offset object. |
ControlPointEnd | Returns or sets the end ControlPoint for an IPath object. |
ControlPointStart | Returns or sets the start ControlPoint for an IPath object. |
CopyCornerFlag | Returns or sets the copy corner flag for an offset object. |
IsMaster | Returns or sets the isMaster state for this offset object. |
IsOccurrence | Returns whether this object is an occurrence or not. |
IsSlave | Returns or sets the isSlave state for this offset object. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
MaintainStockFlag | Returns or sets the use maintain stock flag for an offset object. |
Name | Returns the custom name of the object. |
OffsetVector | Returns or sets the vector for an offset 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. |
UseBendRatio | Returns or sets the use bend ratio flag for an offset object. |
Methods¶
Method | Description |
---|---|
AddSegmentsToList | Adds segment(s) to an IPath object. |
CreateAttributeIterator | Create an attribute iterator @return A new attribute iterator object |
DelSegmentsFromList | Removes segment(s) from the IPath 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. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetMasterPath | The master path object for this offset object. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetOffsetPathSegments | The path segments for an offset object. |
GetOffsetPaths | Returns the list of all of the offset paths for a master path @return list of all of the offset paths in this master object |
GetOffsetReferenceAxes | The reference axes for an offset object. |
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. |
GetSegmentList | Returns the list of all of the segments contained in the IPath @return list of all of the segments in this IPath object |
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 @return |
Prints a representation of this object to the system log file. | |
RemovePathAssociativityFromParent | Breaks the associativity of a child ( slave ) path to its parent ( master ) path. |
RemovePathAssociativityToImmediateChildren | Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetMasterPath | The master path object for this offset object. |
SetName | Sets the custom name of the object. |
SetOffsetPathSegments | The path segments for an offset object. |
SetOffsetReferenceAxes | The reference axes for an offset 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. |
Property Detail¶
BendRadius¶
-
OffsetPath.
BendRadius
¶ Returns or sets the bend radius for an offset object.
-------------------------------------
Getter Method
Signature
BendRadius()
Returns: Return type: float New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
BendRadius(radius)
Parameters: radius (float) – New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
BendRatio¶
-
OffsetPath.
BendRatio
¶ Returns or sets the bend ratio for an offset object.
-------------------------------------
Getter Method
Signature
BendRatio()
Returns: Return type: float New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
BendRatio(ratio)
Parameters: ratio (float) – New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
ControlPointEnd¶
-
OffsetPath.
ControlPointEnd
¶ Returns or sets the end ControlPoint for an IPath object.
-------------------------------------
Getter Method
Signature
ControlPointEnd()
Returns: end ControlPoint for the IPath object Return type: NXOpen.Routing.ControlPoint
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
ControlPointEnd(end)
Parameters: end ( NXOpen.Routing.ControlPoint
) – end ControlPoint for the IPath objectNew in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
ControlPointStart¶
-
OffsetPath.
ControlPointStart
¶ Returns or sets the start ControlPoint for an IPath object.
-------------------------------------
Getter Method
Signature
ControlPointStart()
Returns: start ControlPoint for the IPath object Return type: NXOpen.Routing.ControlPoint
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
ControlPointStart(start)
Parameters: start ( NXOpen.Routing.ControlPoint
) – start ControlPoint for the IPath objectNew in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
CopyCornerFlag¶
-
OffsetPath.
CopyCornerFlag
¶ Returns or sets the copy corner flag for an offset object.
-------------------------------------
Getter Method
Signature
CopyCornerFlag()
Returns: Return type: bool New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
CopyCornerFlag(copyCorner)
Parameters: copyCorner (bool) – New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
IsMaster¶
-
OffsetPath.
IsMaster
¶ Returns or sets the isMaster state for this offset object.
-------------------------------------
Getter Method
Signature
IsMaster()
Returns: the state of the offset path object Return type: bool New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
IsMaster(masterState)
Parameters: masterState (bool) – the state of the offset path object New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
IsOccurrence¶
-
OffsetPath.
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.
IsSlave¶
-
OffsetPath.
IsSlave
¶ Returns or sets the isSlave state for this offset object.
-------------------------------------
Getter Method
Signature
IsSlave()
Returns: Return type: bool New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
IsSlave(masterState)
Parameters: masterState (bool) – the state of the offset path object New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
JournalIdentifier¶
-
OffsetPath.
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.
MaintainStockFlag¶
-
OffsetPath.
MaintainStockFlag
¶ Returns or sets the use maintain stock flag for an offset object.
-------------------------------------
Getter Method
Signature
MaintainStockFlag()
Returns: Return type: bool New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
MaintainStockFlag(maintainStock)
Parameters: maintainStock (bool) – New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Name¶
-
OffsetPath.
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.
OffsetVector¶
-
OffsetPath.
OffsetVector
¶ Returns or sets the vector for an offset object.
-------------------------------------
Getter Method
Signature
OffsetVector()
Returns: vector for the offset object Return type: NXOpen.Vector3d
New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
OffsetVector(vector)
Parameters: vector ( NXOpen.Vector3d
) – vector for the offset objectNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
OwningComponent¶
-
OffsetPath.
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¶
-
OffsetPath.
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¶
-
OffsetPath.
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.
UseBendRatio¶
-
OffsetPath.
UseBendRatio
¶ Returns or sets the use bend ratio flag for an offset object.
-------------------------------------
Getter Method
Signature
UseBendRatio()
Returns: Return type: bool New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
UseBendRatio(ratioState)
Parameters: ratioState (bool) – New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
Method Detail¶
AddSegmentsToList¶
-
OffsetPath.
AddSegmentsToList
¶ Adds segment(s) to an IPath object.
Signature
AddSegmentsToList(objs)
Parameters: objs (list of NXOpen.Routing.ISegment
) – list of segments that are to be addedNew in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
DelSegmentsFromList¶
-
OffsetPath.
DelSegmentsFromList
¶ Removes segment(s) from the IPath object.
Signature
DelSegmentsFromList(objs)
Parameters: objs (list of NXOpen.Routing.ISegment
) – list of segments that are to be deletedNew in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
FindObject¶
-
OffsetPath.
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.
GetMasterPath¶
-
OffsetPath.
GetMasterPath
¶ The master path object for this offset object.
Signature
GetMasterPath()
Returns: master path for this offset object Return type: NXOpen.Routing.IPath
New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetOffsetPathSegments¶
-
OffsetPath.
GetOffsetPathSegments
¶ The path segments for an offset object.
Signature
GetOffsetPathSegments()
Returns: segment list for the offset object Return type: list of NXOpen.Routing.ISegment
New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetOffsetPaths¶
-
OffsetPath.
GetOffsetPaths
¶ Returns the list of all of the offset paths for a master path
Signature
GetOffsetPaths()
Returns: list of all of the offset paths in this master object Return type: list of NXOpen.Routing.IPath
New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetOffsetReferenceAxes¶
-
OffsetPath.
GetOffsetReferenceAxes
¶ The reference axes for an offset object.
Signature
GetOffsetReferenceAxes()
Returns: a tuple Return type: A tuple consisting of (orgin, xVector, yVector). orgin is a NXOpen.Point3d
. origin for the offset object xVector is aNXOpen.Vector3d
. X reference axes for the offset object yVector is aNXOpen.Vector3d
. Y reference axes for the offset objectNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
GetSegmentList¶
-
OffsetPath.
GetSegmentList
¶ Returns the list of all of the segments contained in the IPath
Signature
GetSegmentList()
Returns: list of all of the segments in this IPath object Return type: list of NXOpen.Routing.ISegment
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
Print¶
-
OffsetPath.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemovePathAssociativityFromParent¶
-
OffsetPath.
RemovePathAssociativityFromParent
¶ Breaks the associativity of a child ( slave ) path to its parent ( master ) path.
Signature
RemovePathAssociativityFromParent()
New in version NX5.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
RemovePathAssociativityToImmediateChildren¶
-
OffsetPath.
RemovePathAssociativityToImmediateChildren
¶ Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths.
Signature
RemovePathAssociativityToImmediateChildren()
New in version NX5.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SetMasterPath¶
-
OffsetPath.
SetMasterPath
¶ The master path object for this offset object.
Signature
SetMasterPath(masterPath)
Parameters: masterPath ( NXOpen.Routing.IPath
) – master path for this offset objectNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SetName¶
-
OffsetPath.
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.
SetOffsetPathSegments¶
-
OffsetPath.
SetOffsetPathSegments
¶ The path segments for an offset object.
Signature
SetOffsetPathSegments(segments)
Parameters: segments (list of NXOpen.Routing.ISegment
) – segment list for the offset objectNew in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
SetOffsetReferenceAxes¶
-
OffsetPath.
SetOffsetReferenceAxes
¶ The reference axes for an offset object.
Signature
SetOffsetReferenceAxes(orgin, xVector, yVector)
Parameters: - orgin (
NXOpen.Point3d
) – origin for the offset object - xVector (
NXOpen.Vector3d
) – X reference axes for the offset object - yVector (
NXOpen.Vector3d
) – Y reference axes for the offset object
New in version NX4.0.0.
License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)
- orgin (