public interface Connection extends LogicalConnection
LogicalConnection
, restricted to
one From and one To terminal.
Modifier and Type | Interface and Description |
---|---|
static class |
Connection.RouteLevel
Routing level.
|
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
boolean |
addIntermediateTerminal(LogicalTerminal intermediateTerminal)
Add an intermediate terminal to this connection
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
assignPath(Connection.RouteLevel routeLevel,
Path path)
Assigns the given path to this connection and routes the connection on the path using the given routing level.
|
void |
automaticallyRoute(Connection.RouteLevel routeLevel)
Automatically routes this connection on the shortest path using the given routing level.
|
ConnectorDevice |
findFromConnector()
Get the From Connector for this connection.
|
CableDevice |
findNearestCableDevice()
Query this connection to find the nearest harness.
|
HarnessDevice |
findNearestHarnessDevice()
Query this connection to find the nearest harness.
|
SingleDevice |
findNearestParentDevice()
Queries this connection for the nearest parent device.
|
Path[] |
findPaths(Connection.RouteLevel routeLevel)
Returns all the possible paths this connection can use.
|
ConnectorDevice |
findToConnector()
Get the To Connector for this connection.
|
LogicalTerminal |
fromTerminal()
Returns the From terminal.
|
LogicalTerminal[] |
getIntermediateTerminals()
Get the intermediate terminals associated with this connection.
|
String |
getRoutedLevel()
Gets the level used to route this connection.
|
Connection.RouteLevel |
getRoutedLevelEnum()
Similar to
getRoutedLevel() ,
but returns the Connection.RouteLevel enumeration instead of a string. |
String |
getRoutingMethod()
Gets the method used to route this connection.
|
boolean |
isRouted()
Is this connection routed?
|
double |
maximumPathLength()
Returns the maximum path length for this connection.
|
double |
minimumPathLength()
Returns the minimum path length for this connection.
|
String |
pathLengthMultiplier()
Returns the path length multiplier.
|
String |
pathLengthOffset()
Returns the path length offset.
|
boolean |
removeIntermediateTerminal(LogicalTerminal intermediateTerminal)
Remove an intermediate terminal from this connection
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
replaceIntermediateTerminals(LogicalTerminal[] intermediateTerminals)
Replaces the intermediate terminals associated with this connection.
|
void |
setFromTerminal(LogicalTerminal fromTerminal)
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setMaximumPathLength(double pathLength)
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setMinimumPathLength(double pathLength)
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setPathLengthMultiplier(String pathLengthMultiplier)
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setPathLengthOffset(String pathLengthOffset)
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
void |
setToTerminal(LogicalTerminal toTerminal)
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic") . |
LogicalTerminal |
toTerminal()
Returns the To terminal.
|
void |
unroute()
Unroutes this connection.
|
addFromTerminal, addToTerminal, getFromTerminals, getToTerminals, removeFromTerminal, removeToTerminal, replaceFromTerminals, replaceToTerminals
implementedBy
guid, setGuid
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
deleteCharacterstics, getCharacteristics, getDestinationCharacteristics, getIntegerCharacteristic, getRealCharacteristic, getStringCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic2, setCharacteristic2, setCharacteristic2, setCharacteristics, setCharacteristics2
LogicalTerminal fromTerminal() throws NXException, RemoteException
NXException
RemoteException
LogicalTerminal toTerminal() throws NXException, RemoteException
NXException
RemoteException
void setFromTerminal(LogicalTerminal fromTerminal) throws NXException, RemoteException
fromTerminal
- May not be nullNXException
RemoteException
void setToTerminal(LogicalTerminal toTerminal) throws NXException, RemoteException
toTerminal
- May not be nullNXException
RemoteException
LogicalTerminal[] getIntermediateTerminals() throws NXException, RemoteException
Connection
to be valid in NX.
LogicalTerminal
- May be nullNXException
RemoteException
void replaceIntermediateTerminals(LogicalTerminal[] intermediateTerminals) throws NXException, RemoteException
intermediateTerminals
- Collection of intermediate LogicalTerminal
- Use null to remove all intermdiate terminalsNXException
RemoteException
boolean addIntermediateTerminal(LogicalTerminal intermediateTerminal) throws NXException, RemoteException
intermediateTerminal
- Can not be nullLogicalTerminal
added successfully?NXException
RemoteException
boolean removeIntermediateTerminal(LogicalTerminal intermediateTerminal) throws NXException, RemoteException
intermediateTerminal
- may be nullLogicalTerminal
removed successfully?NXException
RemoteException
double minimumPathLength() throws NXException, RemoteException
NXException
RemoteException
void setMinimumPathLength(double pathLength) throws NXException, RemoteException
pathLength
- May be zeroNXException
RemoteException
double maximumPathLength() throws NXException, RemoteException
NXException
RemoteException
void setMaximumPathLength(double pathLength) throws NXException, RemoteException
pathLength
- May be zeroNXException
RemoteException
String pathLengthMultiplier() throws NXException, RemoteException
NXException
RemoteException
void setPathLengthMultiplier(String pathLengthMultiplier) throws NXException, RemoteException
pathLengthMultiplier
- May be zero (cut length will be zero)NXException
RemoteException
String pathLengthOffset() throws NXException, RemoteException
NXException
RemoteException
void setPathLengthOffset(String pathLengthOffset) throws NXException, RemoteException
pathLengthOffset
- May be zeroNXException
RemoteException
String getRoutingMethod() throws NXException, RemoteException
NXException
RemoteException
String getRoutedLevel() throws NXException, RemoteException
NXException
RemoteException
Connection.RouteLevel getRoutedLevelEnum() throws NXException, RemoteException
getRoutedLevel()
,
but returns the Connection.RouteLevel
enumeration instead of a string.
NXException
RemoteException
boolean isRouted() throws NXException, RemoteException
NXException
RemoteException
SingleDevice findNearestParentDevice() throws NXException, RemoteException
NXException
RemoteException
HarnessDevice findNearestHarnessDevice() throws NXException, RemoteException
NXException
RemoteException
CableDevice findNearestCableDevice() throws NXException, RemoteException
NXException
RemoteException
ConnectorDevice findFromConnector() throws NXException, RemoteException
NXException
RemoteException
ConnectorDevice findToConnector() throws NXException, RemoteException
NXException
RemoteException
Path[] findPaths(Connection.RouteLevel routeLevel) throws NXException, RemoteException
routeLevel
- NXException
RemoteException
void unroute() throws NXException, RemoteException
NXException
RemoteException
void automaticallyRoute(Connection.RouteLevel routeLevel) throws NXException, RemoteException
routeLevel
- NXException
RemoteException
void assignPath(Connection.RouteLevel routeLevel, Path path) throws NXException, RemoteException
findPaths(nxopen.routing.electrical.Connection.RouteLevel)
to find all available paths for this connection.
routeLevel
- path
- The path on which to route this connection.NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.