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

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

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

Public Member Functions

unsafe void ConvertToFeatures ()
 Cycles through all the NXOpen.Routing.Port objects and creates a NXOpen.Routing.FeaturePort object for NXOpen.Routing.FittingPort object, NXOpen.Routing.FixturePort object, NXOpen.Routing.MultiPort object, and NXOpen.Routing.TerminalPort object. More...
 
unsafe NXOpen.Routing.ExtractPort CreateExtractPort (NXOpen.Routing.Port port)
 Creates a NXOpen.Routing.ExtractPort . More...
 
unsafe NXOpen.Routing.ExtractPort CreateExtractPort (NXOpen.Routing.Port port, bool allowMultipleConnections)
 Creates a NXOpen.Routing.ExtractPort . More...
 
unsafe NXOpen.Routing.Port[] GetComponentPorts (NXOpen.Assemblies.Component component)
 Given a component, returns the port occurrences that belong to it. More...
 
unsafe NXOpen.Routing.Port[] GetObjectPorts (NXOpen.NXObject entity)
 Given any NXObject , returns any port occurrences that belong to it. More...
 
NXOpen.Routing.Port[] ToArray ()
 Returns an array of NXOpen.Routing.Port objects. More...
 
unsafe void UpdatePortObjectLocations ()
 Ensures that all NXOpen.Routing.Port objects have the correct locations based on their associated ports. 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.Port objects.

Iterating this collection only returns live uncondemned objects contained in the owning part of the collection. Note that NXOpen.Routing.Port is a smart object and many smart objects are condemned as they only exist to support other objects and are not displayed.

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

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Routing.PortCollection.ConvertToFeatures ( )
inline

Cycles through all the NXOpen.Routing.Port objects and creates a NXOpen.Routing.FeaturePort object for NXOpen.Routing.FittingPort object, NXOpen.Routing.FixturePort object, NXOpen.Routing.MultiPort object, and NXOpen.Routing.TerminalPort object.

Created in NX6.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Routing.ExtractPort NXOpen.Routing.PortCollection.CreateExtractPort ( NXOpen.Routing.Port  port)
inline

Creates a NXOpen.Routing.ExtractPort .

Default allows multiple connections to this port.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
portPort to extract from
Returns
Extracted Port
unsafe NXOpen.Routing.ExtractPort NXOpen.Routing.PortCollection.CreateExtractPort ( NXOpen.Routing.Port  port,
bool  allowMultipleConnections 
)
inline

Creates a NXOpen.Routing.ExtractPort .

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters
portPort to extract from
allowMultipleConnectionsDoes this fitting port allow multiple wires to be routed to it?
Returns
Extracted Port
override int NXOpen.Routing.PortCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Routing.Port [] NXOpen.Routing.PortCollection.GetComponentPorts ( NXOpen.Assemblies.Component  component)
inline

Given a component, returns the port occurrences that belong to it.

Returns a null reference (Nothing in Visual Basic) otherwise.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters
component
Returns
unsafe NXOpen.Routing.Port [] NXOpen.Routing.PortCollection.GetObjectPorts ( NXOpen.NXObject  entity)
inline

Given any NXObject , returns any port occurrences that belong to it.

Returns a null reference (Nothing in Visual Basic) otherwise.

The type of ports returned depends on the type of object given.

If given a NXOpen.Routing.ISegment , if there is stock on the segment, returns the ports from stock. If there is no stock, returns any fitting ports at the segment ends.

If given a NXOpen.Routing.Stock , returns the ports at ends of stock.

If given a NXOpen.Routing.Port , returns itself.

if given a NXOpen.Routing.ControlPoint , returns any fitting ports at the Control Point.

If given a part, returns any ports in the part.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
entity
Returns
NXOpen.Routing.Port [] NXOpen.Routing.PortCollection.ToArray ( )
inline

Returns an array of NXOpen.Routing.Port objects.

unsafe void NXOpen.Routing.PortCollection.UpdatePortObjectLocations ( )
inline

Ensures that all NXOpen.Routing.Port objects have the correct locations based on their associated ports.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Property Documentation

Tag NXOpen.Routing.PortCollection.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.