NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Routing.RunCollection Class Reference

Represents a collection of NXOpen.Routing.Run objects. More...

Inheritance diagram for NXOpen.Routing.RunCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe NXOpen.Routing.Run CreateRun (string runId, string runType, NXOpen.NXObject[] from, NXOpen.NXObject[] to, NXOpen.NXObject[] member)
 Creates a fully defined NXOpen.Routing.Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly. More...
 
unsafe NXOpen.Routing.Run CreateRun (string runId, string runType, NXOpen.Routing.CharacteristicList attributes, NXOpen.Routing.RunItem[] fromItems, NXOpen.Routing.RunItem[] toItems, NXOpen.Routing.RunItem[] memberItems)
 Creates a NXOpen.Routing.Run with items that are not assigned to components in the assembly. More...
 
unsafe NXOpen.Routing.Run CreateRun (string runId, string runType, NXOpen.Routing.CharacteristicList attributes)
 Creates an empty NXOpen.Routing.Run using just a unique Run identifier and a type. More...
 
unsafe NXOpen.NXObject[] FindPath (NXOpen.NXObject[] source, NXOpen.NXObject[] target)
 Find a run path connecting all input From items to the To items. More...
 
NXOpen.Routing.Run[] ToArray ()
 Returns an array of NXOpen.Routing.Run objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen.Routing.Run objects.

To obtain an instance of this class, refer to NXOpen.Routing.RouteManager

Created in NX4.0.0

Member Function Documentation

unsafe NXOpen.Routing.Run NXOpen.Routing.RunCollection.CreateRun ( string  runId,
string  runType,
NXOpen.NXObject[]  from,
NXOpen.NXObject[]  to,
NXOpen.NXObject[]  member 
)
inline

Creates a fully defined NXOpen.Routing.Run object whose "From" item(s), "To" item(s), and "Member" item(s) are assigned to components in the assembly.

Created in NX4.0.0

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

Parameters
runIdUnique identifier of the Run
runTypeType of the Run
fromArray of "From" items. Must be NXOpen.Routing.Port , NXOpen.Routing.Run or NXOpen.Routing.ControlPoint
toArray of "To" items. Must be NXOpen.Routing.Port , NXOpen.Routing.Run or NXOpen.Routing.ControlPoint
memberArray of "Member" items. Must be NXOpen.Assemblies.Component , NXOpen.Routing.ISegment or Routing.Stock
Returns
unsafe NXOpen.Routing.Run NXOpen.Routing.RunCollection.CreateRun ( string  runId,
string  runType,
NXOpen.Routing.CharacteristicList  attributes,
NXOpen.Routing.RunItem[]  fromItems,
NXOpen.Routing.RunItem[]  toItems,
NXOpen.Routing.RunItem[]  memberItems 
)
inline

Creates a NXOpen.Routing.Run with items that are not assigned to components in the assembly.

Created in NX7.5.4

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

Parameters
runIdUnique identifier of the Run
runTypeType of the Run
attributesRun attributes
fromItemsArray of "From" items.
toItemsArray of "To" items.
memberItemsArray of "Member" items.
Returns
unsafe NXOpen.Routing.Run NXOpen.Routing.RunCollection.CreateRun ( string  runId,
string  runType,
NXOpen.Routing.CharacteristicList  attributes 
)
inline

Creates an empty NXOpen.Routing.Run using just a unique Run identifier and a type.

Created in NX7.5.4

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

Parameters
runIdUnique identifier of the Run
runTypeType of the Run
attributesRun attributes
Returns
override int NXOpen.Routing.RunCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.NXObject [] NXOpen.Routing.RunCollection.FindPath ( NXOpen.NXObject[]  source,
NXOpen.NXObject[]  target 
)
inline

Find a run path connecting all input From items to the To items.

Created in NX8.0.2

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

Parameters
sourceArray of from items. Must be NXOpen.Routing.Port , NXOpen.Routing.Run or NXOpen.Routing.ControlPoint
targetArray of to items. Must be NXOpen.Routing.Port , NXOpen.Routing.Run or NXOpen.Routing.ControlPoint
Returns
Array of member items. Must be NXOpen.Assemblies.Component , NXOpen.Routing.ISegment or Routing.Stock
NXOpen.Routing.Run [] NXOpen.Routing.RunCollection.ToArray ( )
inline

Returns an array of NXOpen.Routing.Run objects.

Property Documentation

Tag NXOpen.Routing.RunCollection.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.