NX Open C++ Reference Guide
Classes | Public Member Functions | 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

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
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...
 
NXOpen::Routing::ExtractPortCreateExtractPort (NXOpen::Routing::Port *port)
 Creates a NXOpen::Routing::ExtractPort . More...
 
NXOpen::Routing::ExtractPortCreateExtractPort (NXOpen::Routing::Port *port, bool allowMultipleConnections)
 Creates a NXOpen::Routing::ExtractPort . More...
 
NXOpen::Routing::StockOffsetPortCreateStockOffsetPort (NXOpen::Assemblies::Component *partOccurrence, NXOpen::Routing::Port *portPrototype)
 Create a Stock Offset Port. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
tag_t Tag () const
 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. Condemned objects will be deleted when their references go away.
To obtain an instance of this class, refer to NXOpen::Routing::RouteManager

Created in NX4.0.0.

Member Function Documentation

iterator NXOpen::Routing::PortCollection::begin ( )

Returns an iterator addressing the first element.

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


Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::ExtractPort* NXOpen::Routing::PortCollection::CreateExtractPort ( NXOpen::Routing::Port port)

Creates a NXOpen::Routing::ExtractPort .

Default allows multiple connections to this port.

Returns
Extracted Port
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
portPort to extract from
NXOpen::Routing::ExtractPort* NXOpen::Routing::PortCollection::CreateExtractPort ( NXOpen::Routing::Port port,
bool  allowMultipleConnections 
)

Creates a NXOpen::Routing::ExtractPort .

Returns
Extracted Port
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?
NXOpen::Routing::StockOffsetPort* NXOpen::Routing::PortCollection::CreateStockOffsetPort ( NXOpen::Assemblies::Component partOccurrence,
NXOpen::Routing::Port portPrototype 
)

Create a Stock Offset Port.

Returns
The stock offset port in the work part.
Deprecated:
Deprecated in NX8.0.2. Use the NXOpen::Routing::StockOffsetPortCollection::CreateStockOffsetPort on the NXOpen::Routing::StockOffsetPortCollection class instead.


Created in NX7.5.4.

License requirements : routing_base ("Routing Basic")

Parameters
partOccurrenceThe part occurrence from which to create the stock offset port.
portPrototypeThe prototype of the stock offset port in the part occurrence.
iterator NXOpen::Routing::PortCollection::end ( )

Returns an iterator addressing one past the last element.

tag_t NXOpen::Routing::PortCollection::Tag ( ) const

Returns the tag of this object.


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