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

Inheritance diagram for NXOpen.Routing.Run:

Public Types
enum	Status { Valid, Broken, Incomplete }
	Represents the status of a run More...

enum	CompareStatus { None, Ok, MissingRun, ExtraRun, MissingItem, ExtraItem, Discrepancy }
	Represents discrepancies in the run compared to another run More...

enum	FlipStatus { Success, NotTwoPorts, UnequalConstraints, PortPositionMismatch, FlowTypeMismatch, FollowsFlow, RunFlowNotDefined, CannotFlip }
	Represents result of flip component More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe string	GetRunId ()
	Retrieves the run_id of run More...

unsafe string	GetRunType ()
	Retrieves the run type of run More...

unsafe NXOpen.NXObject[]	GetFromItems ()
	Retrieves the from items of a run. More...

unsafe NXOpen.Routing.RunItem[]	GetFromItemData ()
	Retrieves the data of the "From" items of a run More...

unsafe NXOpen.NXObject[]	GetToItems ()
	Retrieves the to items of a run. More...

unsafe NXOpen.Routing.RunItem[]	GetToItemData ()
	Retrieves the data of the "To" items of a run More...

unsafe NXOpen.Routing.RunItem[]	GetMemberItemData ()
	Retrieves the data of the "Member" items of a run More...

unsafe NXOpen.Routing.Run.Status	Edit (string runId, string runType, NXOpen.NXObject[] from, NXOpen.NXObject[] to, NXOpen.NXObject[] member)
	Edits an existing run with new items. More...

unsafe void	Edit (string runId, string runType, NXOpen.Routing.RunItem[] fromItems, NXOpen.Routing.RunItem[] toItems, NXOpen.Routing.RunItem[] memberItems)
	Edits an existing run with new run item data. More...

unsafe NXOpen.Routing.Run.Status	GetRunStatus ()
	Ask the status of run More...

unsafe NXOpen.Routing.RoutingSystem	GetRoutingSystem ()
	Ask the NXOpen.Routing.RoutingSystem run belongs to More...

unsafe NXOpen.Routing.Run.CompareStatus	GetRunCompareStatus ()
	Ask the compare status of run More...

unsafe int	RunSegmentGetFlowDirection (NXOpen.Routing.ISegment segment)
	Get flow direction of a run segment More...

unsafe void	RunSegmentSetFlowDirection (NXOpen.Routing.ISegment segment, int flowState)
	Set flow direction of a run segment More...

unsafe void	RunSegmentReverseFlowDirection (NXOpen.Routing.ISegment segment)
	Reverse flow direction of a run segment More...

unsafe NXOpen.ObjectList[]	DetectRunSpools ()
	This will detect spools in a run More...

unsafe void	DeleteRunPath ()
	This will delete the Run path and member items in a run More...

unsafe NXOpen.Routing.CharacteristicList	GetCharacteristics ()
	Get all of the characteristics values on the this object. More...

unsafe void	SetCharacteristics (NXOpen.Routing.CharacteristicList values)
	Set all of the characteristics values on this object. More...

unsafe NXOpen.Routing.Run.FlipStatus	FlipComponent (NXOpen.Assemblies.Component component)
	Flips a component that is part of a run by rotating the component so that it's input and output ports reverse. More...

unsafe void	MakeActive ()
	Set a Run as Active. More...

unsafe void	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. More...

unsafe bool	GetActiveStatus ()
	Get status of Run, Active or Inactive More...

unsafe NXOpen.NXObject[]	GetMembers ()
	Retrieves the member items of a run. More...

unsafe NXOpen.Routing.CharacteristicList	GetCharacteristicsWithId ()
	Get all of the characteristics values on the this object, including RunId. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

Additional Inherited Members
Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Detailed Description

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

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

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.Routing.Run.CompareStatus

Represents discrepancies in the run compared to another run

Enumerator
None	Run has no compare status. Compare operation is not invoked yet
Ok	No missing, extra or discrepancy items
MissingRun	Entire run is missing
ExtraRun	Entire run is extra
MissingItem	Item or items are missing from the run
ExtraItem	Extra item or items present in the run
Discrepancy	Items have characteristics discrepancies

enum NXOpen.Routing.Run.FlipStatus

Represents result of flip component

Enumerator
Success	Component is flipped.
NotTwoPorts	Given component ports are not equal to two ports.
UnequalConstraints	Each ports has different number of constraints.
PortPositionMismatch	Ports are not collinear and opposite or perpendicular.
FlowTypeMismatch	Ports are defined with ambiguous flow types.
FollowsFlow	Ports correctly aligned with flow. No flipping done.
RunFlowNotDefined	Flow is not defined on Run. Component can't be flipped.
CannotFlip	Run is deleted or there are no segments attached to component. Component cannot be flipped.

enum NXOpen.Routing.Run.Status

Represents the status of a run

Enumerator

Valid

Run is valid.

All items are connected and all segments have stocks assigned on them

Broken

Run is broken.

All items are not connected end to end

Incomplete

Run is incomplete.

Some segments do not have stock assigned on them

Member Function Documentation

unsafe void NXOpen.Routing.Run.DeleteRunPath ( )

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

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe NXOpen.ObjectList [] NXOpen.Routing.Run.DetectRunSpools ( )

This will detect spools in a run

Created in NX5.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.Run.Status NXOpen.Routing.Run.Edit	(	string	runId,
		string	runType,
		NXOpen.NXObject[]	from,
		NXOpen.NXObject[]	to,
		NXOpen.NXObject[]	member
	)

Edits an existing run with new items.

NOTE: Removes any existing items in the run and adds these new items

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

runId	Unique identifier of the Run
runType	Type of the Run
from	Array of to items. Must be NXOpen.Routing.Port , NXOpen.Routing.Run or NXOpen.Routing.ControlPoint
to	Array of to items. Must be NXOpen.Routing.Port , NXOpen.Routing.Run or NXOpen.Routing.ControlPoint
member	Array of member items. Must be NXOpen.Assemblies.Component , NXOpen.Routing.ISegment or Routing.Stock

Returns: Valid, broken or incomplete run

unsafe void NXOpen.Routing.Run.Edit	(	string	runId,
		string	runType,
		NXOpen.Routing.RunItem[]	fromItems,
		NXOpen.Routing.RunItem[]	toItems,
		NXOpen.Routing.RunItem[]	memberItems
	)

Edits an existing run with new run item data.

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

Created in NX7.5.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

runId	Unique identifier of the Run
runType	Type of the Run
fromItems	Array of "From" item data.
toItems	Array of "To" item data.
memberItems	Array of "Member" item data.

unsafe NXOpen.Routing.Run.FlipStatus NXOpen.Routing.Run.FlipComponent ( NXOpen.Assemblies.Component component )

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

Created in NX8.5.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

component

Returns: Flip Component status

unsafe bool NXOpen.Routing.Run.GetActiveStatus ( )

Get status of Run, Active or Inactive

Created in NX8.5.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.Run.GetCharacteristics ( )

Get all of the characteristics values on the this object.

Created in NX7.5.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.Run.GetCharacteristicsWithId ( )

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

Created in NX8.5.3

License requirements: routing_base ("Routing Basic")

Returns

unsafe NXOpen.Routing.RunItem [] NXOpen.Routing.Run.GetFromItemData ( )

Retrieves the data of the "From" items of a run

Created in NX7.5.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of data for the "From" items.

unsafe NXOpen.NXObject [] NXOpen.Routing.Run.GetFromItems ( )

Retrieves the from items of a run.

From items are extracted ports or run

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: All from items of the run

unsafe NXOpen.Routing.RunItem [] NXOpen.Routing.Run.GetMemberItemData ( )

Retrieves the data of the "Member" items of a run

Created in NX7.5.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of data for the "Member" items.

unsafe NXOpen.NXObject [] NXOpen.Routing.Run.GetMembers ( )

Retrieves the member items of a run.

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

Created in NX9.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: All member items of the run

unsafe NXOpen.Routing.RoutingSystem NXOpen.Routing.Run.GetRoutingSystem ( )

Ask the NXOpen.Routing.RoutingSystem run belongs to

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: RoutingSystem run belongs to

unsafe NXOpen.Routing.Run.CompareStatus NXOpen.Routing.Run.GetRunCompareStatus ( )

Ask the compare status of run

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Run compare status

unsafe string NXOpen.Routing.Run.GetRunId ( )

Retrieves the run_id of run

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Run id of run

unsafe NXOpen.Routing.Run.Status NXOpen.Routing.Run.GetRunStatus ( )

Ask the status of run

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Valid, broken or incomplete run

unsafe string NXOpen.Routing.Run.GetRunType ( )

Retrieves the run type of run

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Run type of run

unsafe NXOpen.Routing.RunItem [] NXOpen.Routing.Run.GetToItemData ( )

Retrieves the data of the "To" items of a run

Created in NX7.5.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of data for the "To" items.

unsafe NXOpen.NXObject [] NXOpen.Routing.Run.GetToItems ( )

Retrieves the to items of a run.

To items are extracted ports or run

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: All to items of the run

unsafe void NXOpen.Routing.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.

Created in NX8.5.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe void NXOpen.Routing.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.

Created in NX8.5.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe int NXOpen.Routing.Run.RunSegmentGetFlowDirection ( NXOpen.Routing.ISegment segment )

Get flow direction of a run segment

Created in NX5.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

segment

Returns

unsafe void NXOpen.Routing.Run.RunSegmentReverseFlowDirection ( NXOpen.Routing.ISegment segment )

Reverse flow direction of a run segment

Created in NX5.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

segment

unsafe void NXOpen.Routing.Run.RunSegmentSetFlowDirection	(	NXOpen.Routing.ISegment	segment,
		int	flowState
	)

Set flow direction of a run segment

Created in NX5.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

segment
flowState

unsafe void NXOpen.Routing.Run.SetCharacteristics ( NXOpen.Routing.CharacteristicList values )

Set all of the characteristics values on this object.

Created in NX7.5.4

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

values

The documentation for this class was generated from the following file:

dotnet_pool/Routing_Run.cs

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation