NX Open C++ Reference Guide
Public Types | Public Member Functions
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::Routing::Electrical::CableDevice NXOpen::Routing::Electrical::WireDevice NXOpen::Routing::Electrical::ShieldDevice

List of all members.

Public Types

enum  AutoRouteSel {
  AutoRouteSelBundleDiameter, AutoRouteSelLeastBundles, AutoRouteSelDesignRules, AutoRouteSelLeastSegments,
  AutoRouteSelShortestLength
}
 Auto-route selections. More...
enum  RouteLevel { RouteLevelPin, RouteLevelComp, RouteLevelMixed, RouteLevelPartial }
 Routing level. More...
enum  RouteTypes { RouteTypesDefaultRoute = -1, RouteTypesAutoRoute, RouteTypesManualRoute }
 Route types (manual/auto). More...

Public Member Functions

double CalculateCutLength ()
 Calculates and sets cut length on object.
void ChangeHarness (NXOpen::Routing::Electrical::HarnessDevice *harnessDevice)
 Adds this stockdevice as child of given HarnessDevice.
NXString ColorName ()
 Returns the color name.
double CutLength ()
 Returns the cut length.
NXOpen::Routing::Electrical::ConnectorDeviceFindFromConnector ()
 Find the from connector for this stock device.
NXOpen::Routing::Electrical::ConnectionFindImplementedConnection ()
 Find the Routing::Electrical::Connection implemented by this device.
NXOpen::Routing::Electrical::HarnessDefinitionFindNearestHarnessDefinition ()
 Get nearest Routing::Electrical::HarnessDefinition encountered up the parent-child hierarchy.
NXOpen::Routing::Electrical::HarnessDeviceFindNearestHarnessDevice ()
 Find the nearest Routing::Electrical::HarnessDevice encountered up the parent-child hierarchy.
NXOpen::Routing::Electrical::ConnectorDeviceFindToConnector ()
 Find the to connector for this stock device.
NXOpen::Routing::Electrical::CableDefinitionFindTopmostCableDefinition ()
 Get topmost Routing::Electrical::CableDefinition encountered up the parent-child hierarchy.
std::vector
< NXOpen::Routing::Electrical::ConnectorDevice * > 
GetIntermediateComponents ()
 Get intermediate components.
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetIntermediateTerminals ()
 Get the intermediate terminals associated to this stock device.
bool HasIntermediateComponents ()
 Does this stock device have intermediate components?
void ManuallyRoute (NXOpen::Routing::Electrical::ElectricalStockDevice::RouteLevel routeLevel, const std::vector< NXOpen::Routing::ISegment * > &segments)
 Manually routes a Routing::Electrical::ElectricalStockDevice .
int NxColorValue ()
 Returns the NX color value.
void SetColorName (const NXString &colorName)
 Sets the color name.
void SetCutLength (double cutLength)
 Sets the cut length.
void SetNxColorValue (int nxColorValue)
 Sets the NX color value.

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:
AutoRouteSelBundleDiameter 

bundle diameter

AutoRouteSelLeastBundles 

least bundles

AutoRouteSelDesignRules 

design rules

AutoRouteSelLeastSegments 

least segments

AutoRouteSelShortestLength 

shortest length

Routing level.

Enumerator:
RouteLevelPin 

pin

RouteLevelComp 

comp

RouteLevelMixed 

mixed

RouteLevelPartial 

partial

Route types (manual/auto).

Enumerator:
RouteTypesAutoRoute 

auto route

RouteTypesManualRoute 

manual route


Member Function Documentation

Calculates and sets cut length on object.

Returns:
Calculated cut length
Created in NX4.0.2.

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

Adds this stockdevice as child of given HarnessDevice.


Created in NX5.0.0.

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

Parameters:
harnessDeviceharness device

Returns the color name.


Created in NX4.0.2.

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

Returns the cut length.


Created in NX4.0.2.

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

Find the from connector for this stock device.

If there is no from connector, NULL is returned.

Returns:

Created in NX4.0.2.

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

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

Returns:

Created in NX4.0.2.

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

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

Returns:

Created in NX4.0.2.

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

Find 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")

Find the to connector for this stock device.

If there is no to connector, NULL is returned.

Returns:

Created in NX4.0.2.

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

Get topmost Routing::Electrical::CableDefinition encountered up the parent-child hierarchy.

Returns:

Created in NX4.0.2.

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

Get intermediate components.

Returns:

Created in NX4.0.2.

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

Get the intermediate terminals associated to this stock device.

Returns:

Created in NX4.0.2.

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

Does this stock device have intermediate components?

Returns:

Created in NX4.0.2.

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

Manually routes a Routing::Electrical::ElectricalStockDevice .

on given Routing::ISegment . The input segments should form a continuous path between two Routing::Electrical::ConnectorDevice objects.
Created in NX5.0.0.

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

Parameters:
routeLevelRouting type.
segmentssegments

Returns the NX color value.


Created in NX4.0.2.

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

Sets the color name.


Created in NX4.0.2.

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

Parameters:
colorNamecolor name

Sets the cut length.


Created in NX4.0.2.

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

Parameters:
cutLengthcut length

Sets the NX color value.


Created in NX4.0.2.

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

Parameters:
nxColorValuenx color value

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