NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Routing.Electrical.ConnectorDevice Class Reference

The Electrical ConnectorDevice corresponds to a connector instance of NXOpen.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 NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Assign { None, Auto, Manual }
 Assignment method More...
 
enum  ComponentType {
  None, Connector, Splice, Device,
  Other
}
 Component type More...
 
- Public Types inherited from NXOpen.Routing.SingleDevice
enum  DeleteObjectResult { Ok, StillRouted, StillAssigned, CantDeleteUnknown }
 Deletion result More...
 

Public Member Functions

unsafe
NXOpen.Routing.Electrical.Connection[] 
FindConnections ()
 Find connections. More...
 
unsafe
NXOpen.Routing.CharacteristicList[] 
FindMatchingParts ()
 Find parts matching the connector device. More...
 
unsafe
NXOpen.Routing.Electrical.CableDevice 
FindNearestCableDevice ()
 Get the nearest NXOpen.Routing.Electrical.CableDevice encountered up the parent-child hierarchy. More...
 
unsafe
NXOpen.Routing.Electrical.HarnessDevice 
FindNearestHarnessDevice ()
 Get the nearest NXOpen.Routing.Electrical.HarnessDevice encountered up the parent-child hierarchy. More...
 
unsafe NXOpen.Routing.Port FindPlacer (out double placerPos)
 Searches for a placement port for the connector device. More...
 
unsafe
NXOpen.Routing.Electrical.ElectricalStockDevice[] 
FindRoutedStockDevices ()
 Find routed stock devices. More...
 
unsafe
NXOpen.Routing.Electrical.ElectricalStockDevice[] 
FindStockDevices ()
 Find stock devices. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice.Assign 
GetAssignMethod ()
 Get assign method. More...
 
unsafe
NXOpen.Routing.Electrical.ElectricalPartDefinitionShadow 
GetPartDefinition ()
 Get part definition. More...
 
unsafe
NXOpen.Routing.LogicalTerminal 
GetTerminal (string terminalName, bool createTerminal)
 Get NXOpen.Routing.LogicalTerminal given the name of the terminal. More...
 
unsafe
NXOpen.Routing.LogicalTerminal[] 
GetTerminals ()
 Get terminals. More...
 
unsafe bool IsAssigned ()
 Get status of a connector device (assigned or not). More...
 
unsafe bool IsNxConnector (NXOpen.Routing.Electrical.HarnessDevice elecHarnessDevice)
 Is the device a connector? More...
 
unsafe bool IsNxDevice (NXOpen.Routing.Electrical.HarnessDevice elecHarnessDevice)
 Is the device a NX device? More...
 
unsafe bool IsUsedInRoutedConnection (NXOpen.Routing.Electrical.HarnessDevice elecHarnessDevice)
 Is the device used in a routed connection? More...
 
unsafe void ManuallyAssignConnector (NXOpen.Assemblies.Component elecConnectorPartOccurrence)
 Assign a connector manually. More...
 
unsafe void ManuallyAssignConnectorGroup (NXOpen.Group elecConnectorGroup)
 Assign a connector manually for object NXOpen. More...
 
unsafe NXOpen.Assemblies.Component PlaceConnectorOnPort (NXOpen.Routing.CharacteristicList match, NXOpen.Routing.Port placer)
 Loads the parts based on the NXOpen.Routing.CharacteristicList adds the instance of the part to the current work part and places the instance on the placer. More...
 
unsafe void ProxyAssignConnector (NXOpen.Routing.Port proxy)
 Assign a connector to a proxy port. More...
 
unsafe bool RemoveTerminal (NXOpen.Routing.LogicalTerminal routeTerminalToRemove)
 Remove a terminal. More...
 
unsafe void SetPartDefinition (NXOpen.Routing.Electrical.ElectricalPartDefinitionShadow elecPartDefinitionShadow)
 Sets part definition. More...
 
unsafe void UnassignConnector ()
 Unassign connector. More...
 
- Public Member Functions inherited from NXOpen.Routing.SingleDevice
unsafe
NXOpen.Routing.LogicalConnection[] 
GetImplementedConnections ()
 Gets connections implemented on single device. More...
 
unsafe
NXOpen.Routing.ItemDefinition 
GetItemDefinition ()
 Get item definition. More...
 
unsafe
NXOpen.Routing.DeviceRelationship[] 
GetReferencingDeviceRelshps ()
 Gets referencing device relationships. More...
 
unsafe
NXOpen.Routing.SingleDevice[] 
GetRelatedSingleDevices ()
 Assuming this single device to be the relating single device in a NXOpen.Routing.DeviceRelationship , get associated related single devices. More...
 
unsafe NXOpen.Routing.SingleDevice GetRelatingSingleDevice ()
 Assuming this single device to be the related single device in a NXOpen.Routing.DeviceRelationship , get associated relating single device. More...
 
unsafe
NXOpen.Routing.SingleDevice.DeleteObjectResult 
ManuallyDelete ()
 Deletes the single device. More...
 
- Public Member Functions inherited from NXOpen.Routing.RouteObject
unsafe void DeleteCharacterstics (NXOpen.Routing.CharacteristicList values)
 Removes the input list of characteristics from this object. More...
 
unsafe
NXOpen.Routing.CharacteristicList 
GetCharacteristics ()
 Get all of the characteristics values on the this object. More...
 
unsafe
NXOpen.Routing.CharacteristicList 
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object. More...
 
unsafe int GetIntegerCharacteristic (string name)
 Get the value of an integer characteristic associated with the input name. More...
 
unsafe double GetRealCharacteristic (string name)
 Get the value of a real characteristic associated with the input name. More...
 
unsafe string GetStringCharacteristic (string name)
 Get the value of a string characteristic associated with the input name. More...
 
unsafe void SetCharacteristic (string name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
unsafe void SetCharacteristic (string name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
unsafe void SetCharacteristic (string name, string value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
unsafe void SetCharacteristic2 (string title, int value)
 Sets or creates an integer type attribute associated with the input title. More...
 
unsafe void SetCharacteristic2 (string title, double value)
 Sets or creates a double type attribute associated with the input title. More...
 
unsafe void SetCharacteristic2 (string title, string value)
 Sets or creates a string type type attribute associated with the input title. More...
 
unsafe void SetCharacteristics (NXOpen.Routing.CharacteristicList values)
 Set all of the characteristics values on this object. More...
 
unsafe void SetCharacteristics2 (NXOpen.Routing.CharacteristicList values)
 Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...
 

Properties

unsafe string ComponentName [get, set]
 Returns or sets the component name. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice.ComponentType 
ConnectorType [get, set]
 Returns or sets the connector type. More...
 
- Properties inherited from NXOpen.Routing.SingleDevice
unsafe NXOpen.NXObject NxEquivalent [get, set]
 Returns or sets the NX equivalent object. More...
 
unsafe string PartName [get, set]
 Returns or sets the part name More...
 
unsafe string PartNumber [get, set]
 Returns or sets the part number More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

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

Created in NX4.0.2

Member Enumeration Documentation

Assignment method

Enumerator
None 
Auto 
Manual 

Component type

Enumerator
None 
Connector 
Splice 
Device 
Other 

Member Function Documentation

unsafe NXOpen.Routing.Electrical.Connection [] NXOpen.Routing.Electrical.ConnectorDevice.FindConnections ( )
inline

Find connections.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.CharacteristicList [] NXOpen.Routing.Electrical.ConnectorDevice.FindMatchingParts ( )
inline

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.

Created in NX6.0.0

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

Returns
unsafe NXOpen.Routing.Electrical.CableDevice NXOpen.Routing.Electrical.ConnectorDevice.FindNearestCableDevice ( )
inline

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

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.HarnessDevice NXOpen.Routing.Electrical.ConnectorDevice.FindNearestHarnessDevice ( )
inline

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

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Port NXOpen.Routing.Electrical.ConnectorDevice.FindPlacer ( out double  placerPos)
inline

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.

Created in NX6.0.0

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

Returns
Parameters
placerPos
unsafe NXOpen.Routing.Electrical.ElectricalStockDevice [] NXOpen.Routing.Electrical.ConnectorDevice.FindRoutedStockDevices ( )
inline

Find routed stock devices.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.ElectricalStockDevice [] NXOpen.Routing.Electrical.ConnectorDevice.FindStockDevices ( )
inline

Find stock devices.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.ConnectorDevice.Assign NXOpen.Routing.Electrical.ConnectorDevice.GetAssignMethod ( )
inline

Get assign method.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.ElectricalPartDefinitionShadow NXOpen.Routing.Electrical.ConnectorDevice.GetPartDefinition ( )
inline

Get part definition.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.LogicalTerminal NXOpen.Routing.Electrical.ConnectorDevice.GetTerminal ( string  terminalName,
bool  createTerminal 
)
inline

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

If a terminal does not exists creates a terminal

Created in NX5.0.0

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

Parameters
terminalName
createTerminalTRUE - creates a new terminal if one does not exist with given name
Returns
unsafe NXOpen.Routing.LogicalTerminal [] NXOpen.Routing.Electrical.ConnectorDevice.GetTerminals ( )
inline

Get terminals.

Created in NX4.0.2

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

Returns
unsafe bool NXOpen.Routing.Electrical.ConnectorDevice.IsAssigned ( )
inline

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

Created in NX4.0.2

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

Returns
unsafe bool NXOpen.Routing.Electrical.ConnectorDevice.IsNxConnector ( NXOpen.Routing.Electrical.HarnessDevice  elecHarnessDevice)
inline

Is the device a connector?

Created in NX4.0.2

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

Parameters
elecHarnessDevice
Returns
unsafe bool NXOpen.Routing.Electrical.ConnectorDevice.IsNxDevice ( NXOpen.Routing.Electrical.HarnessDevice  elecHarnessDevice)
inline

Is the device a NX device?

Created in NX4.0.2

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

Parameters
elecHarnessDevice
Returns
unsafe bool NXOpen.Routing.Electrical.ConnectorDevice.IsUsedInRoutedConnection ( NXOpen.Routing.Electrical.HarnessDevice  elecHarnessDevice)
inline

Is the device used in a routed connection?

Created in NX4.0.2

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

Parameters
elecHarnessDevice
Returns
unsafe void NXOpen.Routing.Electrical.ConnectorDevice.ManuallyAssignConnector ( NXOpen.Assemblies.Component  elecConnectorPartOccurrence)
inline

Assign a connector manually.

Created in NX4.0.2

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

Parameters
elecConnectorPartOccurrenceComponent to assign.
unsafe void NXOpen.Routing.Electrical.ConnectorDevice.ManuallyAssignConnectorGroup ( NXOpen.Group  elecConnectorGroup)
inline

Assign a connector manually for object NXOpen.

Group.

Created in NX1899.0.0

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

Parameters
elecConnectorGroupComponent to assign.
unsafe NXOpen.Assemblies.Component NXOpen.Routing.Electrical.ConnectorDevice.PlaceConnectorOnPort ( NXOpen.Routing.CharacteristicList  match,
NXOpen.Routing.Port  placer 
)
inline

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

Created in NX6.0.0

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

Parameters
match
placer
Returns
unsafe void NXOpen.Routing.Electrical.ConnectorDevice.ProxyAssignConnector ( NXOpen.Routing.Port  proxy)
inline

Assign a connector to a proxy port.

Created in NX8.0.0

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

Parameters
proxyAssigned port.
unsafe bool NXOpen.Routing.Electrical.ConnectorDevice.RemoveTerminal ( NXOpen.Routing.LogicalTerminal  routeTerminalToRemove)
inline

Remove a terminal.

Created in NX4.0.2

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

Parameters
routeTerminalToRemove
Returns
unsafe void NXOpen.Routing.Electrical.ConnectorDevice.SetPartDefinition ( NXOpen.Routing.Electrical.ElectricalPartDefinitionShadow  elecPartDefinitionShadow)
inline

Sets part definition.

Created in NX4.0.2

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

Parameters
elecPartDefinitionShadow
unsafe void NXOpen.Routing.Electrical.ConnectorDevice.UnassignConnector ( )
inline

Unassign connector.

Created in NX4.0.2

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

Property Documentation

unsafe string NXOpen.Routing.Electrical.ConnectorDevice.ComponentName
getset

Returns or sets the component name.

Created in NX4.0.2

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe NXOpen.Routing.Electrical.ConnectorDevice.ComponentType NXOpen.Routing.Electrical.ConnectorDevice.ConnectorType
getset

Returns or sets the connector type.

Created in NX4.0.2

License requirements to get this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

License requirements to set this property: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")


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