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

Represents a connection between mutiple From and To Routing::LogicalTerminal . More...

Inheritance diagram for 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::Connection NXOpen::Routing::Electrical::CableConnection NXOpen::Routing::Electrical::NonPathConnection NXOpen::Routing::Electrical::PathConnection NXOpen::Routing::Electrical::JumperConnection

List of all members.

Public Member Functions

bool AddFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
 Add Routing::LogicalTerminal to the From Terminals collection.
bool AddToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
 Add Routing::LogicalTerminal to end of the To Terminals collection.
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetFromTerminals ()
 Get all From Terminals from the logical connection.
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetToTerminals ()
 Get all To Terminals from the logical connection.
bool RemoveFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
 Remove a Routing::LogicalTerminal from the From Terminals collection.
bool RemoveToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
 Remove a Routing::LogicalTerminal from the To Terminals collection.
void ReplaceFromTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &fromTerminals)
 Replace the existing From Terminals for the logical connection with collection of Routing::LogicalTerminal terminals
Created in NX4.0.2.
void ReplaceToTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &toTerminals)
 Replace the existing To Terminals for the logical connection with collection of Routing::LogicalTerminal terminals
Created in NX4.0.2.

Detailed Description

Represents a connection between mutiple From and To Routing::LogicalTerminal .


Use Routing::Electrical::Connection to constrain a connection to one From and To Routing::LogicalTerminal This is an abstract class and is for future use. 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 Routing::LogicalTerminal to the From Terminals collection.

Ordering is not important within variable length array.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
fromTerminalCannot be NULL

Add Routing::LogicalTerminal to end of the To Terminals collection.

Ordering is not important within variable length array.

Returns:
Successful addition of Routing::LogicalTerminal ?.
Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
toTerminalA Routing::LogicalTerminal
Cannot be NULL

Get all From Terminals from the logical connection.

Returns:
Collection of Routing::LogicalTerminal
Created in NX4.0.2.

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

Get all To Terminals from the logical connection.

Returns:
Collection of Routing::LogicalTerminal
Created in NX4.0.2.

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

Remove a Routing::LogicalTerminal from the From Terminals collection.

Ordering is not important within the variable length array.

Returns:
Successful removal of Routing::LogicalTerminal ?
Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
fromTerminalMay be NULL

Remove a Routing::LogicalTerminal from the To Terminals collection.

Ordering is not important within the variable length array.

Returns:
Successful removal of Routing::LogicalTerminal ?
Created in NX4.0.2.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
toTerminalMay be NULL

Replace the existing From Terminals for the logical connection with collection of Routing::LogicalTerminal terminals
Created in NX4.0.2.



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

Parameters:
fromTerminalsCollection of Routing::LogicalTerminal
NULL empties From Terminal array

Replace the existing To Terminals for the logical connection with collection of Routing::LogicalTerminal terminals
Created in NX4.0.2.



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

Parameters:
toTerminalsCollection of Routing::LogicalTerminal
NULL empties To Terminal array

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