Run Class

class NXOpen.Routing.Run

Bases: NXOpen.NXObject

Routing Run object references components and stocks which comprise a piping run.

To create an instance of this class us Routing.RunCollection.CreateRun()

New in version NX4.0.0.

Properties

Property Description
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
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.

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteRunPath This will delete the Run path and member items in a run
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
DetectRunSpools This will detect spools in a run
Edit Edits an existing run with new items.
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
FlipComponent Flips a component that is part of a run by rotating the component so that it’s input and output ports reverse.
GetActiveStatus Get status of Run, Active or Inactive
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetCharacteristics Get all of the characteristics values on the this object.
GetCharacteristicsWithId Get all of the characteristics values on the this object, including RunId.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetFromItemData Retrieves the data of the From items of a run
GetFromItems Retrieves the from items of a run.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetMemberItemData Retrieves the data of the Member items of a run
GetMembers Retrieves the member items of a run.
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.
GetRoutingSystem Ask the NXOpen.Routing.RoutingSystem run belongs to
GetRunCompareStatus Ask the compare status of run
GetRunId Retrieves the run_id of run
GetRunStatus Ask the status of run
GetRunType Retrieves the run type of run
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.
GetToItemData Retrieves the data of the To items of a run
GetToItems Retrieves the to items of a run.
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
MakeActive Set a Run as Active.
MakeInactive Set a Run as Inactive and the Active Specification will be changed to Default Specification of the discipline, if no discipline is being used then the Active Specification will be set to None.
Print Prints a representation of this object to the system log file.
RunSegmentGetFlowDirection Get flow direction of a run segment
RunSegmentReverseFlowDirection Reverse flow direction of a run segment
RunSegmentSetFlowDirection Set flow direction of a run segment
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetCharacteristics Set all of the characteristics values on this object.
SetName Sets the custom name of the object.
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.

Enumerations

RunCompareStatus Enumeration Represents discrepancies in the run compared to another run
RunFlipStatus Enumeration Represents result of flip component
RunStatus Enumeration Represents the status of a run

Property Detail

IsOccurrence

Run.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

Run.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

Run.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

Run.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

Run.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

Run.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

DeleteRunPath

Run.DeleteRunPath

This will delete the Run path and member items in a run

Signature DeleteRunPath()

New in version NX8.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

DetectRunSpools

Run.DetectRunSpools

This will detect spools in a run

Signature DetectRunSpools()

Returns:
Return type:list of NXOpen.ObjectList

New in version NX5.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Edit

Run.Edit

Overloaded method Edit

  • Edit(runId, runType, from, to, member)
  • Edit(runId, runType, fromItems, toItems, memberItems)

-------------------------------------

Edits an existing run with new items. NOTE: Removes any existing items in the run and adds these new items

Signature Edit(runId, runType, from, to, member)

Parameters:
Returns:

Valid, broken or incomplete run
Return type:

NXOpen.Routing.RunStatus

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

-------------------------------------

Edits an existing run with new run item data. NOTE: Removes any existing items in the run and adds these new items.

Signature Edit(runId, runType, fromItems, toItems, memberItems)

Parameters:

New in version NX7.5.4.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

-------------------------------------

FindObject

Run.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.

FlipComponent

Run.FlipComponent

Flips a component that is part of a run by rotating the component so that it’s input and output ports reverse.

Signature FlipComponent(component)

Parameters:component (NXOpen.Assemblies.Component) –
Returns:Flip Component status
Return type:NXOpen.Routing.RunFlipStatus

New in version NX8.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetActiveStatus

Run.GetActiveStatus

Get status of Run, Active or Inactive

Signature GetActiveStatus()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetCharacteristics

Run.GetCharacteristics

Get all of the characteristics values on the this object.

Signature GetCharacteristics()

Returns:
Return type:NXOpen.Routing.CharacteristicList

New in version NX7.5.4.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetCharacteristicsWithId

Run.GetCharacteristicsWithId

Get all of the characteristics values on the this object, including RunId.

Signature GetCharacteristicsWithId()

Returns:
Return type:NXOpen.Routing.CharacteristicList

New in version NX8.5.3.

License requirements: routing_base (“Routing Basic”)

GetFromItemData

Run.GetFromItemData

Retrieves the data of the “From” items of a run

Signature GetFromItemData()

Returns:Array of data for the “From” items.
Return type:list of NXOpen.Routing.RunItem

New in version NX7.5.4.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetFromItems

Run.GetFromItems

Retrieves the from items of a run.

From items are extracted ports or run

Signature GetFromItems()

Returns:All from items of the run
Return type:list of NXOpen.NXObject

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetMemberItemData

Run.GetMemberItemData

Retrieves the data of the “Member” items of a run

Signature GetMemberItemData()

Returns:Array of data for the “Member” items.
Return type:list of NXOpen.Routing.RunItem

New in version NX7.5.4.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetMembers

Run.GetMembers

Retrieves the member items of a run.

Member items are part occurrence of ports, stocks, or segments.

Signature GetMembers()

Returns:All member items of the run
Return type:list of NXOpen.NXObject

New in version NX9.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetRoutingSystem

Run.GetRoutingSystem

Ask the NXOpen.Routing.RoutingSystem run belongs to

Signature GetRoutingSystem()

Returns:RoutingSystem run belongs to
Return type:NXOpen.Routing.RoutingSystem

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetRunCompareStatus

Run.GetRunCompareStatus

Ask the compare status of run

Signature GetRunCompareStatus()

Returns:Run compare status
Return type:NXOpen.Routing.RunCompareStatus

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetRunId

Run.GetRunId

Retrieves the run_id of run

Signature GetRunId()

Returns:Run id of run
Return type:str

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetRunStatus

Run.GetRunStatus

Ask the status of run

Signature GetRunStatus()

Returns:Valid, broken or incomplete run
Return type:NXOpen.Routing.RunStatus

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetRunType

Run.GetRunType

Retrieves the run type of run

Signature GetRunType()

Returns:Run type of run
Return type:str

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetToItemData

Run.GetToItemData

Retrieves the data of the “To” items of a run

Signature GetToItemData()

Returns:Array of data for the “To” items.
Return type:list of NXOpen.Routing.RunItem

New in version NX7.5.4.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

GetToItems

Run.GetToItems

Retrieves the to items of a run.

To items are extracted ports or run

Signature GetToItems()

Returns:All to items of the run
Return type:list of NXOpen.NXObject

New in version NX4.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

MakeActive

Run.MakeActive

Set a Run as Active.

All the newly created segments and parts through Linear Path, Spline Path, Heal Path and parts placed through Place Part will be added as members to the Active Run. The specification of the Run will be set as Active Specification. The previous active run will be made Inactive. Use NXOpen.Routing.Run.MakeInactive() to make a Run as Inactive.

Signature MakeActive()

New in version NX8.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

MakeInactive

Run.MakeInactive

Set a Run as Inactive and the Active Specification will be changed to Default Specification of the discipline, if no discipline is being used then the Active Specification will be set to None.

Use NXOpen.Routing.Run.MakeActive() to make a Run as Active.

Signature MakeInactive()

New in version NX8.5.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Print

Run.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RunSegmentGetFlowDirection

Run.RunSegmentGetFlowDirection

Get flow direction of a run segment

Signature RunSegmentGetFlowDirection(segment)

Parameters:segment (NXOpen.Routing.ISegment) –
Returns:
Return type:int

New in version NX5.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RunSegmentReverseFlowDirection

Run.RunSegmentReverseFlowDirection

Reverse flow direction of a run segment

Signature RunSegmentReverseFlowDirection(segment)

Parameters:segment (NXOpen.Routing.ISegment) –

New in version NX5.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RunSegmentSetFlowDirection

Run.RunSegmentSetFlowDirection

Set flow direction of a run segment

Signature RunSegmentSetFlowDirection(segment, flowState)

Parameters:

New in version NX5.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetCharacteristics

Run.SetCharacteristics

Set all of the characteristics values on this object.

Signature SetCharacteristics(values)

Parameters:values (NXOpen.Routing.CharacteristicList) –

New in version NX7.5.4.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

SetName

Run.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.