AutomaticTraceline Class — NXOpen Python API Reference 12.0.0 documentation

# AutomaticTraceline Class

class `NXOpen.``AutomaticTraceline`

  Bases: `NXOpen.Traceline`

  Represents an automatic traceline.

  This type of traceline has its shape automatically derived from its defining properties.

  No creator defined due to apiwrap problems

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
Color | Returns or sets the color of the object.
EndDirection | Returns or sets the end direction of the traceline
EndOffset | Returns or sets the end offset of the traceline
EndPoint | Returns or sets the end point of the traceline
IsBlanked | Returns the blank status of this object.
IsOccurrence | Returns whether this object is an occurrence or not.
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.
LineFont | Returns or sets the line font of the object.
LineWidth | Returns or sets the line width of the object.
Mode | Returns or sets the mode of the traceline
Name | Returns the custom name of the object.
NameLocation | Returns the location of the object’s name.
Orientation | Returns or sets the orientation of the traceline
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.
Solution | Returns or sets the solution used in the traceline
StartDirection | Returns or sets the start direction of the traceline
StartOffset | Returns or sets the start offset of the traceline
StartPoint | Returns or sets the start point of the traceline
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AskExplosion | Returns the explosion that the traceline has been created in
AskShape | Returns the object used to represent the shape of the traceline
Blank | Blanks the object.
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.
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.
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given 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.
GetSegmentConstraints | Gets the segment constraints of the traceline
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
Highlight | Highlights the object.
Print | Prints a representation of this object to the system log file.
RedisplayObject | Redisplays the object in all views.
RemoveSegmentConstraint | Removes the segment constraint from the traceline
RemoveViewDependency | Remove dependency on all views from an object.
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetName | Sets the custom name of the object.
SetNameLocation | Sets the location of the object’s name.
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string.
SetSegmentConstraints | Sets the segment constraints of the traceline
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.
Unblank | Unblanks the object.
Unhighlight | Unhighlights the object.

# Enumerations

AutomaticTracelineModeOption Enumeration | Controls the mode used when evaluating an automatic traceline

# Property Detail

## EndDirection

`AutomaticTraceline.``EndDirection`

  Returns or sets the end direction of the traceline

  `-------------------------------------`

  Getter Method

  Signature `EndDirection`

  Returns: | End direction
  Return type: | `NXOpen.Direction`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `EndDirection`

  Parameters: | direction (`NXOpen.Direction`) – New end direction

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## EndOffset

`AutomaticTraceline.``EndOffset`

  Returns or sets the end offset of the traceline

  `-------------------------------------`

  Getter Method

  Signature `EndOffset`

  Returns: | End offset
  Return type: | float

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `EndOffset`

  Parameters: | endOffset (float) – New end offset

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## EndPoint

`AutomaticTraceline.``EndPoint`

  Returns or sets the end point of the traceline

  `-------------------------------------`

  Getter Method

  Signature `EndPoint`

  Returns: | End point
  Return type: | `NXOpen.Point`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `EndPoint`

  Parameters: | point (`NXOpen.Point`) – New end point

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## IsOccurrence

`AutomaticTraceline.``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

`AutomaticTraceline.``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.

## Mode

`AutomaticTraceline.``Mode`

  Returns or sets the mode of the traceline

  `-------------------------------------`

  Getter Method

  Signature `Mode`

  Returns: | Mode
  Return type: | `NXOpen.AutomaticTracelineModeOption`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `Mode`

  Parameters: | mode (`NXOpen.AutomaticTracelineModeOption`) – New mode

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## Name

`AutomaticTraceline.``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.

## Orientation

`AutomaticTraceline.``Orientation`

  Returns or sets the orientation of the traceline

  `-------------------------------------`

  Getter Method

  Signature `Orientation`

  Returns: | Orientation
  Return type: | `NXOpen.Matrix3x3`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `Orientation`

  Parameters: | orientation (`NXOpen.Matrix3x3`) – New orientation

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## OwningComponent

`AutomaticTraceline.``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

`AutomaticTraceline.``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

`AutomaticTraceline.``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.

## Solution

`AutomaticTraceline.``Solution`

  Returns or sets the solution used in the traceline

  `-------------------------------------`

  Getter Method

  Signature `Solution`

  Returns: | Solution used
  Return type: | int

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `Solution`

  Parameters: | solution (int) – New solution to use

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## StartDirection

`AutomaticTraceline.``StartDirection`

  Returns or sets the start direction of the traceline

  `-------------------------------------`

  Getter Method

  Signature `StartDirection`

  Returns: | Start direction
  Return type: | `NXOpen.Direction`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `StartDirection`

  Parameters: | direction (`NXOpen.Direction`) – New start direction

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## StartOffset

`AutomaticTraceline.``StartOffset`

  Returns or sets the start offset of the traceline

  `-------------------------------------`

  Getter Method

  Signature `StartOffset`

  Returns: | Start offset
  Return type: | float

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `StartOffset`

  Parameters: | startOffset (float) – New start offset

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## StartPoint

`AutomaticTraceline.``StartPoint`

  Returns or sets the start point of the traceline

  `-------------------------------------`

  Getter Method

  Signature `StartPoint`

  Returns: | Start point
  Return type: | `NXOpen.Point`

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

  `-------------------------------------`

  Setter Method

  Signature `StartPoint`

  Parameters: | point (`NXOpen.Point`) – New start point

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

# Method Detail

## FindObject

`AutomaticTraceline.``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.

## GetSegmentConstraints

`AutomaticTraceline.``GetSegmentConstraints`

  Gets the segment constraints of the traceline

  Signature `GetSegmentConstraints()`

  Returns: | a tuple
  Return type: | A tuple consisting of (segmentIndices, segmentLengths) segmentIndices is a list of int. Segment indices segmentLengths is a list of float. Segment lengths

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## Print

`AutomaticTraceline.``Print`

  Prints a representation of this object to the system log file.

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## RemoveSegmentConstraint

`AutomaticTraceline.``RemoveSegmentConstraint`

  Removes the segment constraint from the traceline

  Signature `RemoveSegmentConstraint(segmentIndex)`

  Parameters: | segmentIndex (int) – Segment index

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## SetName

`AutomaticTraceline.``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.

## SetSegmentConstraints

`AutomaticTraceline.``SetSegmentConstraints`

  Sets the segment constraints of the traceline

  Signature `SetSegmentConstraints(segmentIndices, segmentLengths)`

  Parameters:

  - segmentIndices (list of int) – Segment indices
  - segmentLengths (list of float) – Segment lengths

  New in version NX4.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)