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.ElectricalStockDevice Class Reference

The Electrical Stock Device is a non instantiable superclass to classify all electrical stock-based single devices. More...

Inheritance diagram for NXOpen.Routing.Electrical.ElectricalStockDevice:
NXOpen.Routing.StockDevice NXOpen.Routing.SingleDevice NXOpen.Routing.RouteObject NXOpen.Routing.RootObject NXOpen.Routing.ICharacteristic NXOpen.NXObject NXOpen.INXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.Routing.Electrical.CableDevice NXOpen.Routing.Electrical.WireDevice NXOpen.Routing.Electrical.ShieldDevice

Public Types

enum  AutoRouteSel {
  BundleDiameter, LeastBundles, DesignRules, LeastSegments,
  ShortestLength
}
 Auto-route selections. More...
 
enum  RouteLevel { Pin, Comp, Mixed, Partial }
 Routing level. More...
 
enum  RouteTypes { DefaultRoute = -1, AutoRoute, ManualRoute }
 Route types (manual/auto). More...
 

Public Member Functions

unsafe double CalculateCutLength ()
 Calculates and sets cut length on object. More...
 
unsafe void ChangeHarness (NXOpen.Routing.Electrical.HarnessDevice harnessDevice)
 Adds this stockdevice as child of given HarnessDevice. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice 
FindFromConnector ()
 Find the from connector for this stock device. More...
 
unsafe
NXOpen.Routing.Electrical.Connection 
FindImplementedConnection ()
 Find the NXOpen.Routing.Electrical.Connection implemented by this device. More...
 
unsafe
NXOpen.Routing.Electrical.HarnessDefinition 
FindNearestHarnessDefinition ()
 Get nearest NXOpen.Routing.Electrical.HarnessDefinition encountered up the parent-child hierarchy. More...
 
unsafe
NXOpen.Routing.Electrical.HarnessDevice 
FindNearestHarnessDevice ()
 Find the nearest NXOpen.Routing.Electrical.HarnessDevice encountered up the parent-child hierarchy. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice 
FindToConnector ()
 Find the to connector for this stock device. More...
 
unsafe
NXOpen.Routing.Electrical.CableDefinition 
FindTopmostCableDefinition ()
 Get topmost NXOpen.Routing.Electrical.CableDefinition encountered up the parent-child hierarchy. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice[] 
GetIntermediateComponents ()
 Get intermediate components More...
 
unsafe
NXOpen.Routing.LogicalTerminal[] 
GetIntermediateTerminals ()
 Get the intermediate terminals associated to this stock device. More...
 
unsafe bool HasIntermediateComponents ()
 Does this stock device have intermediate components? More...
 
unsafe void ManuallyRoute (NXOpen.Routing.Electrical.ElectricalStockDevice.RouteLevel routeLevel, NXOpen.Routing.ISegment[] segments)
 Manually routes a NXOpen.Routing.Electrical.ElectricalStockDevice . More...
 
- Public Member Functions inherited from NXOpen.Routing.StockDevice
unsafe void LogStockDeviceWiresforConcurrency (NXOpen.Part partTag)
 Log stock device's wire and its segment for concurrency 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 ColorName [get, set]
 Returns or sets the color name. More...
 
unsafe double CutLength [get, set]
 Returns or sets the cut length. More...
 
unsafe int NxColorValue [get, set]
 Returns or sets the NX color value. More...
 
- Properties inherited from NXOpen.Routing.StockDevice
unsafe
NXOpen.Routing.StockDefinition 
StockDefinition [get, set]
 Returns or sets the stock definition. More...
 
unsafe double StockLength [get, set]
 Returns or sets the stock length. 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 Stock Device is a non instantiable superclass to classify all electrical stock-based single devices.

Creator not available in KF.

Created in NX4.0.2

Member Enumeration Documentation

Auto-route selections.

Enumerator
BundleDiameter 
LeastBundles 
DesignRules 
LeastSegments 
ShortestLength 

Routing level.

Enumerator
Pin 
Comp 
Mixed 
Partial 

Route types (manual/auto).

Enumerator
DefaultRoute 
AutoRoute 
ManualRoute 

Member Function Documentation

unsafe double NXOpen.Routing.Electrical.ElectricalStockDevice.CalculateCutLength ( )
inline

Calculates and sets cut length on object.

Created in NX4.0.2

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

Returns
Calculated cut length
unsafe void NXOpen.Routing.Electrical.ElectricalStockDevice.ChangeHarness ( NXOpen.Routing.Electrical.HarnessDevice  harnessDevice)
inline

Adds this stockdevice as child of given HarnessDevice.

Created in NX5.0.0

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

Parameters
harnessDevice
unsafe NXOpen.Routing.Electrical.ConnectorDevice NXOpen.Routing.Electrical.ElectricalStockDevice.FindFromConnector ( )
inline

Find the from connector for this stock device.

If there is no from connector, a null reference (Nothing in Visual Basic) is returned.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.Connection NXOpen.Routing.Electrical.ElectricalStockDevice.FindImplementedConnection ( )
inline

Find the NXOpen.Routing.Electrical.Connection implemented by this device.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.HarnessDefinition NXOpen.Routing.Electrical.ElectricalStockDevice.FindNearestHarnessDefinition ( )
inline

Get nearest NXOpen.Routing.Electrical.HarnessDefinition 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.ElectricalStockDevice.FindNearestHarnessDevice ( )
inline

Find 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.Electrical.ConnectorDevice NXOpen.Routing.Electrical.ElectricalStockDevice.FindToConnector ( )
inline

Find the to connector for this stock device.

If there is no to connector, a null reference (Nothing in Visual Basic) is returned.

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.Electrical.CableDefinition NXOpen.Routing.Electrical.ElectricalStockDevice.FindTopmostCableDefinition ( )
inline

Get topmost NXOpen.Routing.Electrical.CableDefinition 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.ConnectorDevice [] NXOpen.Routing.Electrical.ElectricalStockDevice.GetIntermediateComponents ( )
inline

Get intermediate components

Created in NX4.0.2

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

Returns
unsafe NXOpen.Routing.LogicalTerminal [] NXOpen.Routing.Electrical.ElectricalStockDevice.GetIntermediateTerminals ( )
inline

Get the intermediate terminals associated to this stock device.

Created in NX4.0.2

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

Returns
unsafe bool NXOpen.Routing.Electrical.ElectricalStockDevice.HasIntermediateComponents ( )
inline

Does this stock device have intermediate components?

Created in NX4.0.2

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

Returns
unsafe void NXOpen.Routing.Electrical.ElectricalStockDevice.ManuallyRoute ( NXOpen.Routing.Electrical.ElectricalStockDevice.RouteLevel  routeLevel,
NXOpen.Routing.ISegment[]  segments 
)
inline

Manually routes a NXOpen.Routing.Electrical.ElectricalStockDevice .

on given NXOpen.Routing.ISegment . The input segments should form a continuous path between two NXOpen.Routing.Electrical.ConnectorDevice objects.

Created in NX5.0.0

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

Parameters
routeLevelRouting type.
segments

Property Documentation

unsafe string NXOpen.Routing.Electrical.ElectricalStockDevice.ColorName
getset

Returns or sets the color 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 double NXOpen.Routing.Electrical.ElectricalStockDevice.CutLength
getset

Returns or sets the cut length.

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 int NXOpen.Routing.Electrical.ElectricalStockDevice.NxColorValue
getset

Returns or sets the NX color value.

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.