NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Routing::PortConnectionCollection Class Reference

Represents a collection of NXOpen::Routing::PortConnection objects. More...

Inheritance diagram for NXOpen::Routing::PortConnectionCollection:
NXOpen::TaggedObjectCollection

Classes

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

Public Types

enum  PortsStatus { PortsStatusCanConnect, PortsStatusCannotConnect }
 Option to check if two ports can be connected by creating a NXOpen::Routing::PortConnection object. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::Routing::PortConnectionCollection::PortsStatus CanPortsConnect (NXOpen::Routing::Port *port1, NXOpen::Routing::Port *port2)
 Determines if the two ports can be connected using a NXOpen::Routing::PortConnection object. More...
 
NXOpen::Routing::PortConnectionCreatePortConnection (NXOpen::Routing::Port *port1, NXOpen::Routing::Port *port2)
 Creates a NXOpen::Routing::PortConnection object. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Routing::PortConnectionGetConnectionFromPort (NXOpen::Routing::Port *port)
 Returns the NXOpen::Routing::PortConnection the given part participates in, if any. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Routing::PortConnection objects.


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

Created in NX4.0.0.

Member Enumeration Documentation

Option to check if two ports can be connected by creating a NXOpen::Routing::PortConnection object.

Enumerator
PortsStatusCanConnect 

The Ports can be connected using Port Connection object.

PortsStatusCannotConnect 

The Ports cannot be connected using Port Connection object.

Member Function Documentation

iterator NXOpen::Routing::PortConnectionCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Routing::PortConnectionCollection::PortsStatus NXOpen::Routing::PortConnectionCollection::CanPortsConnect ( NXOpen::Routing::Port port1,
NXOpen::Routing::Port port2 
)

Determines if the two ports can be connected using a NXOpen::Routing::PortConnection object.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
port1first Port to be connected by the Port Connection object
port2second Port to be connected by the Port Connection object
NXOpen::Routing::PortConnection* NXOpen::Routing::PortConnectionCollection::CreatePortConnection ( NXOpen::Routing::Port port1,
NXOpen::Routing::Port port2 
)

Creates a NXOpen::Routing::PortConnection object.

Returns

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
port1first Port to be connected by the Port Connection object
port2second Port to be connected by the Port Connection object
iterator NXOpen::Routing::PortConnectionCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Routing::PortConnection* NXOpen::Routing::PortConnectionCollection::GetConnectionFromPort ( NXOpen::Routing::Port port)

Returns the NXOpen::Routing::PortConnection the given part participates in, if any.

Returns

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")
Parameters
portport
tag_t NXOpen::Routing::PortConnectionCollection::Tag ( ) const

Returns the tag of this object.


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