NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::Electrical::Connection Class Reference

The electrical usage of a Routing::LogicalConnection , restricted to one From and one To terminal. More...

Inheritance diagram for NXOpen::Routing::Electrical::Connection:
NXOpen::Routing::LogicalConnection NXOpen::Routing::ConnectivityDefinition NXOpen::Routing::RouteObject NXOpen::Routing::RootObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Routing::Electrical::CableConnection NXOpen::Routing::Electrical::NonPathConnection NXOpen::Routing::Electrical::PathConnection NXOpen::Routing::Electrical::JumperConnection

List of all members.

Public Member Functions

bool AddIntermediateTerminal (NXOpen::Routing::LogicalTerminal *intermediateTerminal)
 Add an intermediate terminal to this connection.
NXOpen::Routing::Electrical::ConnectorDeviceFindFromConnector ()
 Get the From Connector for this connection.
NXOpen::Routing::Electrical::CableDeviceFindNearestCableDevice ()
 Query this connection to find the nearest harness.
NXOpen::Routing::Electrical::HarnessDeviceFindNearestHarnessDevice ()
 Query this connection to find the nearest harness.
NXOpen::Routing::SingleDeviceFindNearestParentDevice ()
 Queries this connection for the nearest parent device.
NXOpen::Routing::Electrical::ConnectorDeviceFindToConnector ()
 Get the To Connector for this connection.
NXOpen::Routing::LogicalTerminalFromTerminal ()
 Returns the From terminal.
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetIntermediateTerminals ()
 Get the intermediate terminals associated with this connection.
NXString GetRoutedLevel ()
 Gets the level used to route this connection.
NXString GetRoutingMethod ()
 Gets the method used to route this connection.
bool IsRouted ()
 Is this connection routed?
double MaximumPathLength ()
 Returns the maximum path length for this connection.
double MinimumPathLength ()
 Returns the minimum path length for this connection.
NXString PathLengthMultiplier ()
 Returns the path length multiplier.
NXString PathLengthOffset ()
 Returns the path length offset.
bool RemoveIntermediateTerminal (NXOpen::Routing::LogicalTerminal *intermediateTerminal)
 Remove an intermediate terminal from this connection.
void ReplaceIntermediateTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &intermediateTerminals)
 Replaces the intermediate terminals associated with this connection.
void SetFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
 Sets the From terminal.
void SetMaximumPathLength (double pathLength)
 Sets the maximum path length for this connection.
void SetMinimumPathLength (double pathLength)
 Sets the minimum path length for this connection.
void SetPathLengthMultiplier (const NXString &pathLengthMultiplier)
 Sets the path length multiplier.
void SetPathLengthOffset (const NXString &pathLengthOffset)
 Sets the path length offset.
void SetToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
 Sets the To terminal.
NXOpen::Routing::LogicalTerminalToTerminal ()
 Returns the To terminal.

Detailed Description

The electrical usage of a Routing::LogicalConnection , restricted to one From and one To terminal.


See NX Open Routing help for detailed information on the Connection data model.

Creator not available in KF.

Created in NX4.0.2.


Member Function Documentation

Add an intermediate terminal to this connection.

Returns:
Routing::LogicalTerminal added?
Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
intermediateTerminalmay be NULL

Get the From Connector for this connection.

From does not imply an ordering.

Returns:
May be NULL
Created in NX4.0.2.

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

Query this connection to find the nearest harness.

Only finds a cable that is a parent to this connection at some level up the connection heirarchy.

Returns:
May be NULL if connection is not in a cable
Created in NX4.0.2.

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

Query this connection to find the nearest harness.

Only finds a harness that is a parent to this connection at some level up the connection heirarchy.

Returns:
May be NULL if connection is not in a harness
Created in NX4.0.2.

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

Queries this connection for the nearest parent device.

The nearest parent device is either a cable, shield, or harness

Returns:
May be NULL if connection is not in a harness, cable, or shield
Created in NX4.0.2.

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

Get the To Connector for this connection.

To does not imply an ordering

Returns:
May be NULL
Created in NX4.0.2.

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

Returns the From terminal.

The From terminal is one end of an electrical connection. From does not imply an ordering.
Created in NX4.0.2.

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

Get the intermediate terminals associated with this connection.

Intermediate Terminals are optional and need not exist for a Routing::Electrical::Connection to be valid in NX.

Returns:
Collection of intermediate Routing::LogicalTerminal - May be NULL
Created in NX4.0.2.

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

Gets the level used to route this connection.

Returns:

Created in NX4.0.2.

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

Gets the method used to route this connection.

Returns:

Created in NX4.0.2.

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

Is this connection routed?

Returns:
Is connection routed?
Created in NX4.0.2.

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

Returns the maximum path length for this connection.

Maximum path length is the longest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

Returns the minimum path length for this connection.

Minimum path length is the shortest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

Returns the path length multiplier.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Returns the path length offset.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Remove an intermediate terminal from this connection.

Returns:
Routing::LogicalTerminal removed?
Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")
Parameters:
intermediateTerminalmay be NULL

Replaces the intermediate terminals associated with this connection.


Created in NX4.0.2.

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

Parameters:
intermediateTerminalsCollection of intermediate Routing::LogicalTerminal - Use NULL to remove all intermdiate terminals

Sets the From terminal.

The From terminal is one end of an electrical connection. From does not imply an ordering.
Created in NX4.0.2.

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

Parameters:
fromTerminalMay not be NULL

Sets the maximum path length for this connection.

Maximum path length is the longest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

Parameters:
pathLengthMay be zero

Sets the minimum path length for this connection.

Minimum path length is the shortest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

Parameters:
pathLengthMay be zero

Sets the path length multiplier.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Parameters:
pathLengthMultiplierMay be zero (cut length will be zero)

Sets the path length offset.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Parameters:
pathLengthOffsetMay be zero

Sets the To terminal.

The To terminal is one end of an electrical connection. To does not imply an ordering
Created in NX4.0.2.

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

Parameters:
toTerminalMay not be NULL

Returns the To terminal.

The To terminal is one end of an electrical connection. To does not imply an ordering
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.