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

The electrical usage of a NXOpen.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.Utilities.NXRemotableObject IMessageSink NXOpen.Routing.Electrical.CableConnection NXOpen.Routing.Electrical.NonPathConnection NXOpen.Routing.Electrical.PathConnection NXOpen.Routing.Electrical.JumperConnection

Public Types

enum  RouteLevel { NotRouted, Pin, Component, Mixed }
 Routing level. More...
 

Public Member Functions

unsafe bool AddIntermediateTerminal (NXOpen.Routing.LogicalTerminal intermediateTerminal)
 Add an intermediate terminal to this connection More...
 
unsafe void AssignPath (NXOpen.Routing.Electrical.Connection.RouteLevel routeLevel, NXOpen.Routing.Path path)
 Assigns the given path to this connection and routes the connection on the path using the given routing level. More...
 
unsafe void AutomaticallyRoute (NXOpen.Routing.Electrical.Connection.RouteLevel routeLevel)
 Automatically routes this connection on the shortest path using the given routing level. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice 
FindFromConnector ()
 Get the From Connector for this connection. More...
 
unsafe
NXOpen.Routing.Electrical.CableDevice 
FindNearestCableDevice ()
 Query this connection to find the nearest harness. More...
 
unsafe
NXOpen.Routing.Electrical.HarnessDevice 
FindNearestHarnessDevice ()
 Query this connection to find the nearest harness. More...
 
unsafe NXOpen.Routing.SingleDevice FindNearestParentDevice ()
 Queries this connection for the nearest parent device. More...
 
unsafe NXOpen.Routing.Path[] FindPaths (NXOpen.Routing.Electrical.Connection.RouteLevel routeLevel)
 Returns all the possible paths this connection can use. More...
 
unsafe
NXOpen.Routing.Electrical.ConnectorDevice 
FindToConnector ()
 Get the To Connector for this connection. More...
 
unsafe
NXOpen.Routing.LogicalTerminal[] 
GetIntermediateTerminals ()
 Get the intermediate terminals associated with this connection. More...
 
unsafe string GetRoutedLevel ()
 Gets the level used to route this connection. More...
 
unsafe
NXOpen.Routing.Electrical.Connection.RouteLevel 
GetRoutedLevelEnum ()
 Similar to NXOpen.Routing.Electrical.Connection.GetRoutedLevel , but returns the NXOpen.Routing.Electrical.Connection.RouteLevel enumeration instead of a string. More...
 
unsafe string GetRoutingMethod ()
 Gets the method used to route this connection. More...
 
unsafe bool IsExternallyRouted ()
 Returns true if connection is routed externally, else returns false. More...
 
unsafe bool IsRouted ()
 Is this connection routed? More...
 
unsafe bool RemoveIntermediateTerminal (NXOpen.Routing.LogicalTerminal intermediateTerminal)
 Remove an intermediate terminal from this connection More...
 
unsafe void ReplaceIntermediateTerminals (NXOpen.Routing.LogicalTerminal[] intermediateTerminals)
 Replaces the intermediate terminals associated with this connection. More...
 
unsafe void Unroute ()
 Unroutes this connection. More...
 
- Public Member Functions inherited from NXOpen.Routing.LogicalConnection
unsafe bool AddFromTerminal (NXOpen.Routing.LogicalTerminal fromTerminal)
 Add Routing.LogicalTerminal to the From Terminals collection. More...
 
unsafe bool AddToTerminal (NXOpen.Routing.LogicalTerminal toTerminal)
 Add Routing.LogicalTerminal to end of the To Terminals collection. More...
 
unsafe
NXOpen.Routing.LogicalTerminal[] 
GetFromTerminals ()
 Get all From Terminals from the logical connection More...
 
unsafe
NXOpen.Routing.LogicalTerminal[] 
GetToTerminals ()
 Get all To Terminals from the logical connection More...
 
unsafe bool RemoveFromTerminal (NXOpen.Routing.LogicalTerminal fromTerminal)
 Remove a Routing.LogicalTerminal from the From Terminals collection. More...
 
unsafe bool RemoveToTerminal (NXOpen.Routing.LogicalTerminal toTerminal)
 Remove a Routing.LogicalTerminal from the To Terminals collection. More...
 
unsafe void ReplaceFromTerminals (NXOpen.Routing.LogicalTerminal[] fromTerminals)
 Replace the existing From Terminals for the logical connection with collection of Routing.LogicalTerminal terminals More...
 
unsafe void ReplaceToTerminals (NXOpen.Routing.LogicalTerminal[] toTerminals)
 Replace the existing To Terminals for the logical connection with collection of Routing.LogicalTerminal terminals More...
 

Properties

unsafe
NXOpen.Routing.LogicalTerminal 
FromTerminal [get, set]
 Returns or sets the From terminal. More...
 
unsafe double MaximumPathLength [get, set]
 Returns or sets the maximum path length for this connection. More...
 
unsafe double MinimumPathLength [get, set]
 Returns or sets the minimum path length for this connection. More...
 
unsafe string PathLengthMultiplier [get, set]
 Returns or sets the path length multiplier. More...
 
unsafe string PathLengthOffset [get, set]
 Returns or sets the path length offset. More...
 
unsafe
NXOpen.Routing.LogicalTerminal 
ToTerminal [get, set]
 Returns or sets the To terminal. More...
 

Additional Inherited Members

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

Detailed Description

The electrical usage of a NXOpen.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 Enumeration Documentation

Routing level.

Enumerator
NotRouted 
Pin 

Route to the pin on the connector component.

Component 

Route to the connector component directly without regard for the pins.

Mixed 

Route to the pin, if possible, otherwise route to the component.

Member Function Documentation

unsafe bool NXOpen.Routing.Electrical.Connection.AddIntermediateTerminal ( NXOpen.Routing.LogicalTerminal  intermediateTerminal)
inline

Add an intermediate terminal to this connection

Created in NX4.0.2

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

Parameters
intermediateTerminalCan not be a null reference (Nothing in Visual Basic)
Returns
Was the NXOpen.Routing.LogicalTerminal added successfully?
unsafe void NXOpen.Routing.Electrical.Connection.AssignPath ( NXOpen.Routing.Electrical.Connection.RouteLevel  routeLevel,
NXOpen.Routing.Path  path 
)
inline

Assigns the given path to this connection and routes the connection on the path using the given routing level.

Use NXOpen.Routing.Electrical.Connection.FindPaths to find all available paths for this connection.

Created in NX8.0.3

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

Parameters
routeLevel
pathThe path on which to route this connection.
unsafe void NXOpen.Routing.Electrical.Connection.AutomaticallyRoute ( NXOpen.Routing.Electrical.Connection.RouteLevel  routeLevel)
inline

Automatically routes this connection on the shortest path using the given routing level.

Created in NX8.0.3

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

Parameters
routeLevel
unsafe NXOpen.Routing.Electrical.ConnectorDevice NXOpen.Routing.Electrical.Connection.FindFromConnector ( )
inline

Get the From Connector for this connection.

From does not imply an ordering.

Created in NX4.0.2

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

Returns
May be a null reference (Nothing in Visual Basic)
unsafe NXOpen.Routing.Electrical.CableDevice NXOpen.Routing.Electrical.Connection.FindNearestCableDevice ( )
inline

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.

Created in NX4.0.2

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

Returns
Will be a null reference (Nothing in Visual Basic) if connection is not in a cable
unsafe NXOpen.Routing.Electrical.HarnessDevice NXOpen.Routing.Electrical.Connection.FindNearestHarnessDevice ( )
inline

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.

Created in NX4.0.2

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

Returns
May be a null reference (Nothing in Visual Basic) if connection is not in a harness
unsafe NXOpen.Routing.SingleDevice NXOpen.Routing.Electrical.Connection.FindNearestParentDevice ( )
inline

Queries this connection for the nearest parent device.

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

Created in NX4.0.2

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

Returns
Will be a null reference (Nothing in Visual Basic) if connection is not in a harness, cable, or shield.
unsafe NXOpen.Routing.Path [] NXOpen.Routing.Electrical.Connection.FindPaths ( NXOpen.Routing.Electrical.Connection.RouteLevel  routeLevel)
inline

Returns all the possible paths this connection can use.

Created in NX8.0.3

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

Parameters
routeLevel
Returns
Possible paths this connection can use.
unsafe NXOpen.Routing.Electrical.ConnectorDevice NXOpen.Routing.Electrical.Connection.FindToConnector ( )
inline

Get the To Connector for this connection.

To does not imply an ordering

Created in NX4.0.2

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

Returns
May be a null reference (Nothing in Visual Basic)
unsafe NXOpen.Routing.LogicalTerminal [] NXOpen.Routing.Electrical.Connection.GetIntermediateTerminals ( )
inline

Get the intermediate terminals associated with this connection.

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

Created in NX4.0.2

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

Returns
Collection of intermediate NXOpen.Routing.LogicalTerminal - May be a null reference (Nothing in Visual Basic)
unsafe string NXOpen.Routing.Electrical.Connection.GetRoutedLevel ( )
inline

Gets the level used to route this connection.

Created in NX4.0.2

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

Returns
  • "C" Connection routed at component level
  • "P" Connection routed at pin level
  • "M" Connection routed at mixed level
unsafe NXOpen.Routing.Electrical.Connection.RouteLevel NXOpen.Routing.Electrical.Connection.GetRoutedLevelEnum ( )
inline

Similar to NXOpen.Routing.Electrical.Connection.GetRoutedLevel , but returns the NXOpen.Routing.Electrical.Connection.RouteLevel enumeration instead of a string.

Created in NX8.0.3

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

Returns
Route level.
unsafe string NXOpen.Routing.Electrical.Connection.GetRoutingMethod ( )
inline

Gets the method used to route this connection.

Created in NX4.0.2

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

Returns
  • "A" Connection is auto routed
  • "M" Connection is manual routed
  • "N" Connection is not routed
unsafe bool NXOpen.Routing.Electrical.Connection.IsExternallyRouted ( )
inline

Returns true if connection is routed externally, else returns false.

Created in NX1872.0.0

License requirements: routing_advanced ("Routing Advanced")

Returns
unsafe bool NXOpen.Routing.Electrical.Connection.IsRouted ( )
inline

Is this connection routed?

Created in NX4.0.2

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

Returns
Is this connection routed?
unsafe bool NXOpen.Routing.Electrical.Connection.RemoveIntermediateTerminal ( NXOpen.Routing.LogicalTerminal  intermediateTerminal)
inline

Remove an intermediate terminal from this connection

Created in NX4.0.2

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

Parameters
intermediateTerminalmay be a null reference (Nothing in Visual Basic)
Returns
Was the NXOpen.Routing.LogicalTerminal removed successfully?
unsafe void NXOpen.Routing.Electrical.Connection.ReplaceIntermediateTerminals ( NXOpen.Routing.LogicalTerminal[]  intermediateTerminals)
inline

Replaces the intermediate terminals associated with this connection.

Created in NX4.0.2

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

Parameters
intermediateTerminalsCollection of intermediate NXOpen.Routing.LogicalTerminal - Use a null reference (Nothing in Visual Basic) to remove all intermdiate terminals
unsafe void NXOpen.Routing.Electrical.Connection.Unroute ( )
inline

Unroutes this connection.

Created in NX8.0.3

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

Property Documentation

unsafe NXOpen.Routing.LogicalTerminal NXOpen.Routing.Electrical.Connection.FromTerminal
getset

Returns or 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 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.Connection.MaximumPathLength
getset

Returns or 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 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.Connection.MinimumPathLength
getset

Returns or 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 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 string NXOpen.Routing.Electrical.Connection.PathLengthMultiplier
getset

Returns or sets the path length multiplier.

Used to calculate cut length. Cut length = length * multiplier + offset

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 string NXOpen.Routing.Electrical.Connection.PathLengthOffset
getset

Returns or sets the path length offset.

Used to calculate cut length. Cut length = length * multiplier + offset

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.LogicalTerminal NXOpen.Routing.Electrical.Connection.ToTerminal
getset

Returns or 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 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.