public interface PortConnection extends NXObject
PortConnectionCollection.createPortConnection(nxopen.routing.Port, nxopen.routing.Port)
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() |
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
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.
|
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, 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, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
PortConnection.PortsData getPorts() throws NXException, RemoteException
NXException
RemoteException
void setPorts(Port port1, Port port2) throws NXException, RemoteException
port1
- first port to be connected by the Port Connection objectport2
- second port to be connected by the Port Connection objectNXException
RemoteException
double getEngagement() throws NXException, RemoteException
NXException
RemoteException
void setEngagement(double engagement) throws NXException, RemoteException
engagement
- engagement distance to be set between the ports
connected by the Port Connection objectNXException
RemoteException
boolean isValid() throws NXException, RemoteException
NXException
RemoteException
boolean arePortsAligned() throws NXException, RemoteException
NXException
RemoteException
void overrideValidity(PortConnection.OverriddenValidity overriddenValidity) throws NXException, RemoteException
overriddenValidity
- overridden validity value.NXException
RemoteException
String getOverrideReason() throws NXException, RemoteException
NXException
RemoteException
void setOverrideReason(String reason) throws NXException, RemoteException
reason
- The reason why this connection's validity was overridden.NXException
RemoteException
PortConnection.OverriddenValidity getOverriddenValidity() throws NXException, RemoteException
NXException
RemoteException
void forceValid(String reason) throws NXException, RemoteException
reason
- The reason why this connection was forced to be valid.NXException
RemoteException
void removeForcedValidity() throws NXException, RemoteException
NXException
RemoteException
boolean isForcedValid() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.