nxopen.routing.electrical

Interface ConnectorDevice

All Superinterfaces:

ICharacteristic, INXObject, NXObject, Remote, RootObject, RouteObject, SingleDevice, TaggedObject

public interface ConnectorDevice
extends SingleDevice

The Electrical ConnectorDevice corresponds to a connector instance of SingleDevice .
To create a new instance of this class, use ConnectorDeviceCollection.createConnectorDevice(nxopen.routing.electrical.ConnectorDevice.ComponentType, java.lang.String)

Created in NX4.0.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectorDevice.Assign Assignment method
static class	ConnectorDevice.ComponentType Component type
static class	ConnectorDevice.FindPlacerData This class holds the data returned from findPlacer()

Nested classes/interfaces inherited from interface nxopen.routing.SingleDevice

SingleDevice.DeleteObjectResult

Nested classes/interfaces inherited from interface nxopen.NXObject

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

Method Summary

Modifier and Type	Method and Description
String	componentName() Returns the component name.
ConnectorDevice.ComponentType	connectorType() Returns the connector type.
Connection[]	findConnections() Find connections.
CharacteristicList[]	findMatchingParts() Find parts matching the connector device.
CableDevice	findNearestCableDevice() Get the nearest CableDevice encountered up the parent-child hierarchy.
HarnessDevice	findNearestHarnessDevice() Get the nearest HarnessDevice encountered up the parent-child hierarchy.
ConnectorDevice.FindPlacerData	findPlacer() Searches for a placement port for the connector device.
ElectricalStockDevice[]	findRoutedStockDevices() Find routed stock devices.
ElectricalStockDevice[]	findStockDevices() Find stock devices.
ConnectorDevice.Assign	getAssignMethod() Get assign method.
ElectricalPartDefinitionShadow	getPartDefinition() Get part definition.
LogicalTerminal	getTerminal(String terminalName, boolean createTerminal) Get LogicalTerminal given the name of the terminal.
LogicalTerminal[]	getTerminals() Get terminals.
boolean	isAssigned() Get status of a connector device (assigned or not).
boolean	isNxConnector(HarnessDevice elecHarnessDevice) Is the device a connector?
boolean	isNxDevice(HarnessDevice elecHarnessDevice) Is the device a NX device?
boolean	isUsedInRoutedConnection(HarnessDevice elecHarnessDevice) Is the device used in a routed connection?
void	manuallyAssignConnector(Component elecConnectorPartOccurrence) Assign a connector manually.
Component	placeConnectorOnPort(CharacteristicList match, nxopen.routing.Port placer) Loads the parts based on the CharacteristicList adds the instance of the part to the current work part and places the instance on the placer.
void	proxyAssignConnector(nxopen.routing.Port proxy) Assign a connector to a proxy port.
boolean	removeTerminal(LogicalTerminal routeTerminalToRemove) Remove a terminal.
void	setComponentName(String componentName) Sets the component name.
void	setConnectorType(ConnectorDevice.ComponentType elecRlistComponent) Sets the connector type.
void	setPartDefinition(ElectricalPartDefinitionShadow elecPartDefinitionShadow) Sets part definition.
void	unassignConnector() Unassign connector.

Methods inherited from interface nxopen.routing.SingleDevice

getImplementedConnections, getItemDefinition, getReferencingDeviceRelshps, getRelatedSingleDevices, getRelatingSingleDevice, manuallyDelete, nxEquivalent, partName, partNumber, setNxEquivalent, setPartName, setPartNumber

Methods inherited from interface nxopen.routing.RootObject

guid, setGuid

Methods inherited from interface nxopen.NXObject

deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, 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

Methods inherited from interface nxopen.routing.ICharacteristic

deleteCharacterstics, getCharacteristics, getDestinationCharacteristics, getIntegerCharacteristic, getRealCharacteristic, getStringCharacteristic, setCharacteristic, setCharacteristic, setCharacteristic, setCharacteristics

Method Detail

getPartDefinition

ElectricalPartDefinitionShadow getPartDefinition()
                                          throws NXException,
                                                 RemoteException

Get part definition.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

setPartDefinition

void setPartDefinition(ElectricalPartDefinitionShadow elecPartDefinitionShadow)
                throws NXException,
                       RemoteException

Sets part definition.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Parameters:

elecPartDefinitionShadow -

Throws:

NXException

RemoteException

getTerminals

LogicalTerminal[] getTerminals()
                        throws NXException,
                               RemoteException

Get terminals.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

removeTerminal

boolean removeTerminal(LogicalTerminal routeTerminalToRemove)
                throws NXException,
                       RemoteException

Remove a terminal.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Parameters:

routeTerminalToRemove -

Throws:

NXException

RemoteException

connectorType

ConnectorDevice.ComponentType connectorType()
                                     throws NXException,
                                            RemoteException

Returns the connector type.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

setConnectorType

void setConnectorType(ConnectorDevice.ComponentType elecRlistComponent)
               throws NXException,
                      RemoteException

Sets the connector type.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Parameters:

elecRlistComponent -

Throws:

NXException

RemoteException

getAssignMethod

ConnectorDevice.Assign getAssignMethod()
                                throws NXException,
                                       RemoteException

Get assign method.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

findNearestHarnessDevice

HarnessDevice findNearestHarnessDevice()
                                throws NXException,
                                       RemoteException

Get the nearest HarnessDevice encountered up the parent-child hierarchy.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

findNearestCableDevice

CableDevice findNearestCableDevice()
                            throws NXException,
                                   RemoteException

Get the nearest CableDevice encountered up the parent-child hierarchy.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

isNxDevice

boolean isNxDevice(HarnessDevice elecHarnessDevice)
            throws NXException,
                   RemoteException

Is the device a NX device?
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.2

Parameters:

elecHarnessDevice -

Throws:

NXException

RemoteException

isNxConnector

boolean isNxConnector(HarnessDevice elecHarnessDevice)
               throws NXException,
                      RemoteException

Is the device a connector?
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.2

Parameters:

elecHarnessDevice -

Throws:

NXException

RemoteException

isUsedInRoutedConnection

boolean isUsedInRoutedConnection(HarnessDevice elecHarnessDevice)
                          throws NXException,
                                 RemoteException

Is the device used in a routed connection?
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
.
Created in NX4.0.2

Parameters:

elecHarnessDevice -

Throws:

NXException

RemoteException

unassignConnector

void unassignConnector()
                throws NXException,
                       RemoteException

Unassign connector.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

manuallyAssignConnector

void manuallyAssignConnector(Component elecConnectorPartOccurrence)
                      throws NXException,
                             RemoteException

Assign a connector manually.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Parameters:

elecConnectorPartOccurrence - Component to assign.

Throws:

NXException

RemoteException

findRoutedStockDevices

ElectricalStockDevice[] findRoutedStockDevices()
                                        throws NXException,
                                               RemoteException

Find routed stock devices.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

isAssigned

boolean isAssigned()
            throws NXException,
                   RemoteException

Get status of a connector device (assigned or not).
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

findStockDevices

ElectricalStockDevice[] findStockDevices()
                                  throws NXException,
                                         RemoteException

Find stock devices.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

findConnections

Connection[] findConnections()
                      throws NXException,
                             RemoteException

Find connections.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

componentName

String componentName()
              throws NXException,
                     RemoteException

Returns the component name.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Throws:

NXException

RemoteException

setComponentName

void setComponentName(String componentName)
               throws NXException,
                      RemoteException

Sets the component name.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX4.0.2

Parameters:

componentName -

Throws:

NXException

RemoteException

getTerminal

LogicalTerminal getTerminal(String terminalName,
                            boolean createTerminal)
                     throws NXException,
                            RemoteException

Get LogicalTerminal given the name of the terminal. If a terminal does not exists creates a terminal
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX5.0.0

Parameters:

terminalName -
NOTE: The full Unicode character set is not supported for this parameter.

createTerminal - TRUE - creates a new terminal if one does not exist with given name

Throws:

NXException

RemoteException

findMatchingParts

CharacteristicList[] findMatchingParts()
                                throws NXException,
                                       RemoteException

Find parts matching the connector device. Searches for "PART_NAME" property on connector device to search for matches in the part tables Returns all matching rows from the part tables.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

findPlacer

ConnectorDevice.FindPlacerData findPlacer()
                                   throws NXException,
                                          RemoteException

Searches for a placement port for the connector device. The placement port is defined in the component list by attribute "DEVICE_PIN" or "EQUIPMENT_PIN". If the attribute is not defined, searches for the first available port on the relating device.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

placeConnectorOnPort

Component placeConnectorOnPort(CharacteristicList match,
                               nxopen.routing.Port placer)
                        throws NXException,
                               RemoteException

Loads the parts based on the CharacteristicList adds the instance of the part to the current work part and places the instance on the placer.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX6.0.0

Parameters:

match -

placer -

Throws:

NXException

RemoteException

proxyAssignConnector

void proxyAssignConnector(nxopen.routing.Port proxy)
                   throws NXException,
                          RemoteException

Assign a connector to a proxy port.
License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

proxy - Assigned port.

Throws:

NXException

RemoteException