NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::InterfaceTerminalRelationshipBase Class Reference

The abstract class Routing::InterfaceTerminalRelationshipBase relates many Routing::Port s to one Routing::Port . More...

Inheritance diagram for NXOpen::Routing::InterfaceTerminalRelationshipBase:
NXOpen::Routing::ObjectRelationship NXOpen::Routing::RootObject NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Routing::InterfaceTerminalRelationshipShadow

List of all members.

Public Types

enum  RelationType { RelationTypeDecomposition }
 Type of interface terminal relationships as per STEP 212 Standards. More...

Public Member Functions

void AddRelatedInterfaceTerminal (NXOpen::Routing::InterfaceTerminalShadow *relatedInterfaceTerminal)
 Adds a Routing::Port to the Routing::InterfaceTerminalRelationshipBase object with a relationship of related.
std::vector
< NXOpen::Routing::InterfaceTerminalShadow * > 
GetRelatedInterfaceTerminals ()
 Gets the list of Routing::Port s in the Routing::InterfaceTerminalRelationshipBase object with a relationship of related.
NXOpen::Routing::InterfaceTerminalShadowGetRelatingInterfaceTerminal ()
 Gets the Routing::Port in the Routing::InterfaceTerminalRelationshipBase with a relationship of relating.
NXOpen::Routing::InterfaceTerminalRelationshipBase::RelationType RelationshipType ()
 Returns the type of the Routing::InterfaceTerminalRelationshipBase object.
void RemoveRelatedInterfaceTerminal (NXOpen::Routing::InterfaceTerminalShadow *relatedInterfaceTerminal)
 Removes a related Routing::Port from the list of related terminals in the Routing::InterfaceTerminalRelationshipBase object.
void ReplaceRelatedInterfaceTerminals (const std::vector< NXOpen::Routing::InterfaceTerminalShadow * > &relatedInterfaceTerminals)
 Replaces the existing related Routing::Port s in the Routing::InterfaceTerminalRelationshipBase object with input ones.
void SetRelatingInterfaceTerminal (NXOpen::Routing::InterfaceTerminalShadow *relatingInterfaceTerminal)
 
Created in NX4.0.2.
void SetRelationshipType (NXOpen::Routing::InterfaceTerminalRelationshipBase::RelationType relationshipType)
 Sets the type of the Routing::InterfaceTerminalRelationshipBase object.

Detailed Description

The abstract class Routing::InterfaceTerminalRelationshipBase relates many Routing::Port s to one Routing::Port .


See NX Routing help for the Connectivity data model documentation.

Creator not available in KF.

Created in NX4.0.2.


Member Enumeration Documentation

Type of interface terminal relationships as per STEP 212 Standards.

Currently, only decomposition is implemented, other types will be added in future releases as required.


Created in NX4.0.2.

Enumerator:
RelationTypeDecomposition 

decomposition


Member Function Documentation

Adds a Routing::Port to the Routing::InterfaceTerminalRelationshipBase object with a relationship of related.


Created in NX4.0.2.

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

Parameters:
relatedInterfaceTerminalrelated interface terminal

Gets the list of Routing::Port s in the Routing::InterfaceTerminalRelationshipBase object with a relationship of related.


A Routing::InterfaceTerminalRelationshipBase object can have one or more related Routing::Port s associated with a single relating Routing::Port .

Returns:

Created in NX4.0.2.

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

Gets the Routing::Port in the Routing::InterfaceTerminalRelationshipBase with a relationship of relating.


A Routing::InterfaceTerminalRelationshipBase object can have only one relating Routing::Port associated with one or more related Routing::Port s.

Returns:

Created in NX4.0.2.

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

Returns the type of the Routing::InterfaceTerminalRelationshipBase object.


Interface Terminal Relationship can be of following types: Routing::InterfaceTerminalRelationshipBase::RelationTypeDecomposition


Created in NX4.0.2.

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

Removes a related Routing::Port from the list of related terminals in the Routing::InterfaceTerminalRelationshipBase object.


Created in NX4.0.2.

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

Parameters:
relatedInterfaceTerminalrelated interface terminal

Replaces the existing related Routing::Port s in the Routing::InterfaceTerminalRelationshipBase object with input ones.


Removes all the related Routing::Port s in a relationship and replaces them with the set of input Routing::Port s.


Created in NX4.0.2.

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

Parameters:
relatedInterfaceTerminalsrelated interface terminals


Created in NX4.0.2.



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

Parameters:
relatingInterfaceTerminalrelating interface terminal

Sets the type of the Routing::InterfaceTerminalRelationshipBase object.


Interface Terminal Relationship can be of following types: Routing::InterfaceTerminalRelationshipBase::RelationTypeDecomposition


Created in NX4.0.2.

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

Parameters:
relationshipTyperelationship type

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