public interface Port extends SmartObject, IRoutePosition
Modifier and Type | Interface and Description |
---|---|
static class |
Port.ConnectedPortsData
This class holds the data returned from
getConnectedPorts() |
static class |
Port.CreateRotationVector
Used by
FittingPortCollection.createFromCsys(nxopen.CartesianCoordinateSystem, nxopen.routing.Port.CreateRotationVector) and
FixturePortCollection.createFromCsys(nxopen.CartesianCoordinateSystem, nxopen.routing.Port.CreateRotationVector) to determine if
the rotation vector on the port should be created. |
static class |
Port.FlowDirectionType
Allowed types for flow direction
|
static class |
Port.PortType
Specifies the port type
|
SmartObject.UpdateOption, SmartObject.VisibilityOption
DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
Modifier and Type | Method and Description |
---|---|
boolean |
allowMultipleConnections()
Returns the Allow Multiple Connections property for a
Port . |
FeaturePort |
askFeature()
Ask
FeaturePort object associated with
Port . |
WaveRouting |
askWaveFeature()
Ask
WaveRouting object associated with this
Port . |
double |
backwardExtension()
Returns the backward extension value for a port (i.e. the minimum length that
a segment must remain straight going into the back of a
Port )
License requirements: routing_base ("Routing Basic") Created in NX11.0.1 |
Expression |
backwardExtensionObject()
Returns the backward extension object for a port.
|
Expression |
clockIncrementObject()
|
PortConnection |
connect()
Finds another
Port to connect this port to. |
void |
disconnect()
Deletes any
PortConnection objects that reference this port. |
int |
findPortIntegerCharacteristic(String name)
Searches for an integer characteristics on the port, then on the ports component
and prototype port if the port is an occurrence.
|
double |
findPortRealCharacteristic(String name)
Searches for a real characteristics on the port, then on the ports component
and prototype port if the port is an occurrence.
|
String |
findPortStringCharacteristic(String name)
Searches for a string characteristics on the port, then on the ports component
and prototype port if the port is an occurrence.
|
Vector3d |
getAlignmentVector()
Retrieves the alignment vector of Port
License requirements: routing_base ("Routing Basic") . |
double |
getClockIncrement()
The clock angle increment value of
Port
License requirements: routing_base ("Routing Basic") Created in NX4.0.0 |
Component |
getComponent()
If this port is an occurrence, returns the component part to which it belongs.
|
Port.ConnectedPortsData |
getConnectedPorts()
If port is connected to another port, returns both connected ports.
|
ControlPoint |
getControlPoint()
Returns the
ControlPoint to which this port is constrained, if any. |
double |
getCutbackLength()
Returns the cutback length of a port, i.e. the length along the wire from
the port where individual wires leave a bundle to attach to pins
License requirements: routing_base ("Routing Basic") Created in NX4.0.0 |
double |
getEngagement()
Returns the engagement distance of a port, i.e. the distance
behind the port that another fitting or stock may engage
License requirements: routing_base ("Routing Basic") Created in NX4.0.0 |
Point3d |
getEngagementPosition()
Returns the position of the port taking into account the engagement distance.
|
Port.FlowDirectionType |
getFlowDirection()
Get the value of flow direction of
Port
License requirements: routing_base ("Routing Basic") Created in NX5.0.0 |
double |
getForwardExtension()
Returns the forward extension value for a port i.e. the minimum length that
a segment must remain straight coming out of a
Port
License requirements: routing_base ("Routing Basic") Created in NX4.0.0 |
Expression |
getForwardExtensionObject()
Returns the forward extension object for a port.
|
NXObject |
getOccurrence()
Returns the occurrence of the given port.
|
PortConnection |
getPortConnection()
If port is connected to another port, returns the Port Connection that links them.
|
Port.PortType |
getPortType()
Get the type of Port
License requirements: routing_base ("Routing Basic") . |
String |
getReferenceCharacteristic(String name)
Gets a reference characteristic from the port.
|
DisplayableObject |
getRotationObject()
Retrieves the object used to derive the rotation vector of Port
License requirements: routing_base ("Routing Basic") . |
Vector3d |
getRotationVector()
Retrieves the rotation vector of Port
License requirements: routing_base ("Routing Basic") . |
ISegment |
getSegment()
Return the segment the port position and alignment are derived from
Returns null if the port is not derived from segment
License requirements: routing_base ("Routing Basic") . |
Stock |
getStockOfPort()
|
boolean |
isEngagementLocked(Port portToCheck)
Checks to see if ports are engaged.
|
boolean |
isRotationLocked(Port portToCheck)
Checks if ports have their rotation vectors locked.
|
Constraint[] |
lockEngagement(Port portToLock)
Locks the port engagement using dcm3 constraints
License requirements: routing_base ("Routing Basic") . |
Constraint[] |
lockRotation(Port portToLock)
Locks the port rotation vector using dcm3 constraints
License requirements: routing_base ("Routing Basic") . |
void |
reorderFeature()
Reorders the
FeaturePort object associated with
Port after all of the features on which the
port feature depends. |
void |
setAllowMultipleConnections(boolean allowMultipleConnections)
Sets the Allow Multiple Connections property for a
Port . |
void |
setBackwardExtension(double extension)
License requirements: routing_base ("Routing Basic") . |
void |
setBackwardExtensionObject(Expression backwardExtension)
License requirements: routing_base ("Routing Basic") . |
void |
setClockIncrement(double increment)
The clock angle increment value of
Port
License requirements: routing_base ("Routing Basic") Created in NX4.0.0 |
void |
setClockIncrementObject(Expression increment)
License requirements: routing_base ("Routing Basic") . |
void |
setFlowDirection(Port.FlowDirectionType flowDirection)
Set the flow direction value of
Port
License requirements: routing_base ("Routing Basic") Created in NX5.0.0 |
void |
setReferenceCharacteristic(String name,
String value)
Sets a reference characteristics on the port.
|
void |
unlockEngagement(Port portToUnlock)
Unlocks the port engagement
License requirements: routing_base ("Routing Basic") . |
void |
unlockRotation(Port portToUnlock)
Unlocks the port rotation
License requirements: routing_base ("Routing Basic") . |
evaluate, protectFromDelete, releaseDeleteProtection, removeParameters, replaceParameters, setVisibility, update, visibility
blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight
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
point, position, setPoint, setPosition
deleteCharacterstics, getCharacteristics, getDestinationCharacteristics, getIntegerCharacteristic, getRealCharacteristic, getStringCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic2, setCharacteristic2, setCharacteristic2, setCharacteristics, setCharacteristics2
Port.PortType getPortType() throws NXException, RemoteException
NXException
RemoteException
Vector3d getAlignmentVector() throws NXException, RemoteException
NXException
RemoteException
double getClockIncrement() throws NXException, RemoteException
Port
NXException
RemoteException
void setClockIncrement(double increment) throws NXException, RemoteException
Port
increment
- Clock increment value in degreesNXException
RemoteException
Port.FlowDirectionType getFlowDirection() throws NXException, RemoteException
Port
NXException
RemoteException
void setFlowDirection(Port.FlowDirectionType flowDirection) throws NXException, RemoteException
Port
flowDirection
- NXException
RemoteException
Vector3d getRotationVector() throws NXException, RemoteException
NXException
RemoteException
DisplayableObject getRotationObject() throws NXException, RemoteException
NXException
RemoteException
ISegment getSegment() throws NXException, RemoteException
NXException
RemoteException
double getForwardExtension() throws NXException, RemoteException
Port
NXException
RemoteException
Expression getForwardExtensionObject() throws NXException, RemoteException
NXException
RemoteException
double backwardExtension() throws NXException, RemoteException
Port
)
NXException
RemoteException
void setBackwardExtension(double extension) throws NXException, RemoteException
extension
- Port extensionNXException
RemoteException
Expression backwardExtensionObject() throws NXException, RemoteException
NXException
RemoteException
void setBackwardExtensionObject(Expression backwardExtension) throws NXException, RemoteException
backwardExtension
- Backward Extension Expression.NXException
RemoteException
double getEngagement() throws NXException, RemoteException
NXException
RemoteException
Point3d getEngagementPosition() throws NXException, RemoteException
NXException
RemoteException
double getCutbackLength() throws NXException, RemoteException
NXException
RemoteException
int findPortIntegerCharacteristic(String name) throws NXException, RemoteException
name
- NXException
RemoteException
double findPortRealCharacteristic(String name) throws NXException, RemoteException
name
- NXException
RemoteException
String findPortStringCharacteristic(String name) throws NXException, RemoteException
name
- NXException
RemoteException
boolean allowMultipleConnections() throws NXException, RemoteException
Port
.
The property controls the number of connections that can be routed to this
Port
. Although this can be specified in the
Mechanical application, the Electrical application is where this property is most
used.
NXException
RemoteException
void setAllowMultipleConnections(boolean allowMultipleConnections) throws NXException, RemoteException
Port
.
The property controls the number of connections that can be routed to this
Port
. Although this can be specified in the
Mechanical application, the Electrical application is where this property is most
used.
allowMultipleConnections
- Should the multiport allow multiple connections?NXException
RemoteException
String getReferenceCharacteristic(String name) throws NXException, RemoteException
name
- NXException
RemoteException
void setReferenceCharacteristic(String name, String value) throws NXException, RemoteException
name
- value
- NXException
RemoteException
PortConnection connect() throws NXException, RemoteException
Port
to connect this port to. Builds a
PortConnection
object if a connectable port is found. See
PortConnectionCollection.canPortsConnect(nxopen.routing.Port, nxopen.routing.Port)
. Does nothing if
this port already has a PortConnection
object referencing it.
NXException
RemoteException
void disconnect() throws NXException, RemoteException
PortConnection
objects that reference this port.
NXException
RemoteException
Constraint[] lockEngagement(Port portToLock) throws NXException, RemoteException
portToLock
- NXException
RemoteException
Constraint[] lockRotation(Port portToLock) throws NXException, RemoteException
portToLock
- NXException
RemoteException
void unlockEngagement(Port portToUnlock) throws NXException, RemoteException
portToUnlock
- NXException
RemoteException
void unlockRotation(Port portToUnlock) throws NXException, RemoteException
portToUnlock
- NXException
RemoteException
boolean isRotationLocked(Port portToCheck) throws NXException, RemoteException
portToCheck
- NXException
RemoteException
boolean isEngagementLocked(Port portToCheck) throws NXException, RemoteException
portToCheck
- NXException
RemoteException
Expression clockIncrementObject() throws NXException, RemoteException
Port
, i.e. an expression
representing the minimum angle for clocking the
Port
.
NXException
RemoteException
void setClockIncrementObject(Expression increment) throws NXException, RemoteException
increment
- Clock increment expressionNXException
RemoteException
FeaturePort askFeature() throws NXException, RemoteException
FeaturePort
object associated with
Port
. Returns null if the port was created
in preNX6 release and not converted to FeaturePort
or the port is a WAVE-linked port.
To convert Port
object to FeaturePort
object
use PortCollection.convertToFeatures()
.
NXException
RemoteException
WaveRouting askWaveFeature() throws NXException, RemoteException
WaveRouting
object associated with this
Port
. Returns null if the port is not
WAVE-linked.
NXException
RemoteException
void reorderFeature() throws NXException, RemoteException
FeaturePort
object associated with
Port
after all of the features on which the
port feature depends. Does nothing if the port was created
in preNX6 release and not converted to FeaturePort
.
To convert Port
object to FeaturePort
object
use PortCollection.convertToFeatures()
.
NXException
RemoteException
Component getComponent() throws NXException, RemoteException
NXException
RemoteException
Port.ConnectedPortsData getConnectedPorts() throws NXException, RemoteException
NXException
RemoteException
PortConnection getPortConnection() throws NXException, RemoteException
NXException
RemoteException
NXObject getOccurrence() throws NXException, RemoteException
NXException
RemoteException
ControlPoint getControlPoint() throws NXException, RemoteException
ControlPoint
to which this port is constrained, if any.
Returns null otherwise.
NXException
RemoteException
Stock getStockOfPort() throws NXException, RemoteException
StockPort
, returns the Stock
to which this port is attached, if any. Returns null otherwise for all other types of ports.
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.