Represents a collection of PortConnection objects. More...

Inheritance diagram for NXOpen::Routing::PortConnectionCollection:

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 PortConnection object. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.

NXOpen::Routing::PortConnectionCollection::PortsStatus	CanPortsConnect (NXOpen::Routing::Port port1, NXOpen::Routing::Port port2)
	Determines if the two ports can be connected using a Port Connection object.

NXOpen::Routing::PortConnection *	CreatePortConnection (NXOpen::Routing::Port port1, NXOpen::Routing::Port port2)
	Creates a PortConnection object.

iterator	end ()
	Returns an iterator addressing one past the last element.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a collection of PortConnection objects.

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

Created in NX4.0.0.

Member Enumeration Documentation

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

Enumerator:

PortsStatusCanConnect	The Ports can be connected using Port Connection object.
PortsStatusCannotConnect	The Ports cannot be connected using Port Connection object.

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 Port Connection object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

port1	first Port to be connected by the Port Connection object
port2	second 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 PortConnection object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

port1	first Port to be connected by the Port Connection object
port2	second Port to be connected by the Port Connection object

iterator NXOpen::Routing::PortConnectionCollection::end ( )

Returns an iterator addressing one past the last element.

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

Returns the tag of this object.

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