nxopen.routing

Interface PortConnection

All Superinterfaces:

INXObject, NXObject, Remote, TaggedObject

public interface PortConnection
extends NXObject

The Routing PortConnection object is used by Routing to position ports while placing parts.
To create a new instance of this class, use PortConnectionCollection.createPortConnection(nxopen.routing.Port, nxopen.routing.Port)

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PortConnection.OverriddenValidity Overridden port connection validity
static class	PortConnection.PortsData This class holds the data returned from getPorts()

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
boolean	arePortsAligned() Returns whether the ports in the port connection are aligned correctly.
void	forceValid(String reason) Force the connection to be valid regardless of the port alignment or the overridden value.
double	getEngagement() Returns the engagement distance between the two ports connected by a Port Connection object.
PortConnection.OverriddenValidity	getOverriddenValidity() Returns the overridden validity value of the port connection.
String	getOverrideReason() Gets the reason why a port connection's validity was overridden.
PortConnection.PortsData	getPorts() Returns the two ports connected by a Port Connection object.
boolean	isForcedValid() Returns whether the connection is forced to be valid.
boolean	isValid() Returns whether the connection is valid.
void	overrideValidity(PortConnection.OverriddenValidity overriddenValidity) Overrides the validity of the port connection.
void	removeForcedValidity() Removes the forced validity setting on the connection.
void	setEngagement(double engagement) Sets the engagement distance between the two ports connected by a Port Connection object.
void	setOverrideReason(String reason) Sets the reason why a port connection's validity was overridden.
void	setPorts(Port port1, Port port2) Sets the link between the two ports connected by the Port Connection object.

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

getPorts

PortConnection.PortsData getPorts()
                           throws NXException,
                                  RemoteException

Returns the two ports connected by a Port Connection object.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Throws:

NXException

RemoteException

setPorts

void setPorts(Port port1,
              Port port2)
       throws NXException,
              RemoteException

Sets the link between the two ports connected by the Port Connection object.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

port1 - first port to be connected by the Port Connection object

port2 - second port to be connected by the Port Connection object

Throws:

NXException

RemoteException

getEngagement

double getEngagement()
              throws NXException,
                     RemoteException

Returns the engagement distance between the two ports connected by a Port Connection object.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Returns:

engagement distance between the ports connected by the Port Connection object

Throws:

NXException

RemoteException

setEngagement

void setEngagement(double engagement)
            throws NXException,
                   RemoteException

Sets the engagement distance between the two ports connected by a Port Connection object.
License requirements: routing_base ("Routing Basic")

Created in NX4.0.0

Parameters:

engagement - engagement distance to be set between the ports connected by the Port Connection object

Throws:

NXException

RemoteException

isValid

boolean isValid()
         throws NXException,
                RemoteException

Returns whether the connection is valid. Validity is initially determined by the alignment of the ports but can be overridden by OverrideValidity or ForceValid
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

validity of the current connection.

Throws:

NXException

RemoteException

arePortsAligned

boolean arePortsAligned()
                 throws NXException,
                        RemoteException

Returns whether the ports in the port connection are aligned correctly. Both direction and rotation are evaluated.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

validity of the current connection.

Throws:

NXException

RemoteException

overrideValidity

void overrideValidity(PortConnection.OverriddenValidity overriddenValidity)
               throws NXException,
                      RemoteException

Overrides the validity of the port connection. By default, the validity is determined by evaluating the alignment of the connected ports.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

overriddenValidity - overridden validity value.

Throws:

NXException

RemoteException

getOverrideReason

String getOverrideReason()
                  throws NXException,
                         RemoteException

Gets the reason why a port connection's validity was overridden.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

The reason why this connection's validity was overridden.

Throws:

NXException

RemoteException

setOverrideReason

void setOverrideReason(String reason)
                throws NXException,
                       RemoteException

Sets the reason why a port connection's validity was overridden.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

reason - The reason why this connection's validity was overridden.

Throws:

NXException

RemoteException

getOverriddenValidity

PortConnection.OverriddenValidity getOverriddenValidity()
                                                 throws NXException,
                                                        RemoteException

Returns the overridden validity value of the port connection.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

overridden validity value.

Throws:

NXException

RemoteException

forceValid

void forceValid(String reason)
         throws NXException,
                RemoteException

Force the connection to be valid regardless of the port alignment or the overridden value. The user's login name and the date and time are recorded automatically along with the given reason.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

reason - The reason why this connection was forced to be valid.

Throws:

NXException

RemoteException

removeForcedValidity

void removeForcedValidity()
                   throws NXException,
                          RemoteException

Removes the forced validity setting on the connection. Validity will now be determined based on the alignment or on the overridden validity setting.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Throws:

NXException

RemoteException

isForcedValid

boolean isForcedValid()
               throws NXException,
                      RemoteException

Returns whether the connection is forced to be valid.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

validity of the current connection.

Throws:

NXException

RemoteException