NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::Electrical::ConnectorDevice Class Reference

The Electrical ConnectorDevice corresponds to a connector instance of Routing::SingleDevice . More...

Inheritance diagram for NXOpen::Routing::Electrical::ConnectorDevice:
NXOpen::Routing::SingleDevice NXOpen::Routing::RouteObject NXOpen::Routing::RootObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  Assign { AssignNone, AssignAuto, AssignManual }
 Assignment method. More...
enum  ComponentType {
  ComponentTypeNone, ComponentTypeConnector, ComponentTypeSplice, ComponentTypeDevice,
  ComponentTypeOther
}
 Component type. More...

Public Member Functions

NXString ComponentName ()
 Returns the component name.
NXOpen::Routing::Electrical::ConnectorDevice::ComponentType ConnectorType ()
 Returns the connector type.
std::vector
< NXOpen::Routing::Electrical::Connection * > 
FindConnections ()
 Find connections.
std::vector
< NXOpen::Routing::CharacteristicList * > 
FindMatchingParts ()
 Find parts matching the connector device.
NXOpen::Routing::Electrical::CableDeviceFindNearestCableDevice ()
 Get the nearest Routing::Electrical::CableDevice encountered up the parent-child hierarchy.
NXOpen::Routing::Electrical::HarnessDeviceFindNearestHarnessDevice ()
 Get the nearest Routing::Electrical::HarnessDevice encountered up the parent-child hierarchy.
NXOpen::Routing::PortFindPlacer (double *placerPos)
 Searches for a placement port for the connector device.
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
FindRoutedStockDevices ()
 Find routed stock devices.
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
FindStockDevices ()
 Find stock devices.
NXOpen::Routing::Electrical::ConnectorDevice::Assign GetAssignMethod ()
 Get assign method.
NXOpen::Routing::Electrical::ElectricalPartDefinitionShadowGetPartDefinition ()
 Get part definition.
NXOpen::Routing::LogicalTerminalGetTerminal (const NXString &terminalName, bool createTerminal)
 Get Routing::LogicalTerminal given the name of the terminal.
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetTerminals ()
 Get terminals.
bool IsAssigned ()
 Get status of a connector device (assigned or not).
bool IsNxConnector (NXOpen::Routing::Electrical::HarnessDevice *elecHarnessDevice)
 Is the device a connector?
bool IsNxDevice (NXOpen::Routing::Electrical::HarnessDevice *elecHarnessDevice)
 Is the device a NX device?
bool IsUsedInRoutedConnection (NXOpen::Routing::Electrical::HarnessDevice *elecHarnessDevice)
 Is the device used in a routed connection?
void ManuallyAssignConnector (NXOpen::Assemblies::Component *elecConnectorPartOccurrence)
 Assign a connector manually.
NXOpen::Assemblies::ComponentPlaceConnectorOnPort (NXOpen::Routing::CharacteristicList *match, NXOpen::Routing::Port *placer)
 Loads the parts based on the Routing::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.
bool RemoveTerminal (NXOpen::Routing::LogicalTerminal *routeTerminalToRemove)
 Remove a terminal.
void SetComponentName (const NXString &componentName)
 Sets the component name.
void SetConnectorType (NXOpen::Routing::Electrical::ConnectorDevice::ComponentType elecRlistComponent)
 Sets the connector type.
void SetPartDefinition (NXOpen::Routing::Electrical::ElectricalPartDefinitionShadow *elecPartDefinitionShadow)
 Sets part definition.
void UnassignConnector ()
 Unassign connector.

Detailed Description

The Electrical ConnectorDevice corresponds to a connector instance of Routing::SingleDevice .


To create a new instance of this class, use Routing::Electrical::ConnectorDeviceCollection::CreateConnectorDevice

Created in NX4.0.2.


Member Enumeration Documentation

Assignment method.

Enumerator:
AssignNone 

none

AssignAuto 

auto

AssignManual 

manual

Component type.

Enumerator:
ComponentTypeNone 

none

ComponentTypeConnector 

connector

ComponentTypeSplice 

splice

ComponentTypeDevice 

device

ComponentTypeOther 

other


Member Function Documentation

Returns the component name.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the connector type.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Find connections.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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.

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Get the nearest Routing::Electrical::CableDevice encountered up the parent-child hierarchy.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Get the nearest Routing::Electrical::HarnessDevice encountered up the parent-child hierarchy.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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.

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
placerPosplacer pos

Find routed stock devices.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Find stock devices.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Get assign method.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Get part definition.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Get Routing::LogicalTerminal given the name of the terminal.

If a terminal does not exists creates a terminal

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
terminalName
NOTE: The full Unicode character set is not supported for this parameter.
createTerminalTRUE - creates a new terminal if one does not exist with given name

Get terminals.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Get status of a connector device (assigned or not).

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Is the device a connector?

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
elecHarnessDeviceelec harness device

Is the device a NX device?

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
elecHarnessDeviceelec harness device

Is the device used in a routed connection?

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
elecHarnessDeviceelec harness device

Assign a connector manually.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
elecConnectorPartOccurrenceComponent to assign.

Loads the parts based on the Routing::CharacteristicList adds the instance of the part to the current work part and places the instance on the placer.

Returns:

Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
matchmatch
placerplacer

Assign a connector to a proxy port.


Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
proxyAssigned port.

Remove a terminal.

Returns:

Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
routeTerminalToRemoveroute terminal to remove

Sets the component name.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
componentNamecomponent name

Sets the connector type.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
elecRlistComponentelec rlist component

Sets part definition.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
elecPartDefinitionShadowelec part definition shadow

Unassign connector.


Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.