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

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

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

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

Detailed Description

The abstract class NXOpen::Routing::InterfaceTerminalRelationshipBase relates many NXOpen::Routing::Port s to one NXOpen::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

void NXOpen::Routing::InterfaceTerminalRelationshipBase::AddRelatedInterfaceTerminal ( NXOpen::Routing::InterfaceTerminalShadow relatedInterfaceTerminal)

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


Created in NX4.0.2.

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

Parameters
relatedInterfaceTerminalrelated interface terminal
std::vector<NXOpen::Routing::InterfaceTerminalShadow *> NXOpen::Routing::InterfaceTerminalRelationshipBase::GetRelatedInterfaceTerminals ( )

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


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

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::InterfaceTerminalShadow* NXOpen::Routing::InterfaceTerminalRelationshipBase::GetRelatingInterfaceTerminal ( )

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


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

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::InterfaceTerminalRelationshipBase::RelationType NXOpen::Routing::InterfaceTerminalRelationshipBase::RelationshipType ( )

Returns the type of the NXOpen::Routing::InterfaceTerminalRelationshipBase object.


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


Created in NX4.0.2.

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

void NXOpen::Routing::InterfaceTerminalRelationshipBase::RemoveRelatedInterfaceTerminal ( NXOpen::Routing::InterfaceTerminalShadow relatedInterfaceTerminal)

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


Created in NX4.0.2.

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

Parameters
relatedInterfaceTerminalrelated interface terminal
void NXOpen::Routing::InterfaceTerminalRelationshipBase::ReplaceRelatedInterfaceTerminals ( const std::vector< NXOpen::Routing::InterfaceTerminalShadow * > &  relatedInterfaceTerminals)

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


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


Created in NX4.0.2.

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

Parameters
relatedInterfaceTerminalsrelated interface terminals
void NXOpen::Routing::InterfaceTerminalRelationshipBase::SetRelatingInterfaceTerminal ( NXOpen::Routing::InterfaceTerminalShadow relatingInterfaceTerminal)


Created in NX4.0.2.



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

Parameters
relatingInterfaceTerminalrelating interface terminal
void NXOpen::Routing::InterfaceTerminalRelationshipBase::SetRelationshipType ( NXOpen::Routing::InterfaceTerminalRelationshipBase::RelationType  relationshipType)

Sets the type of the NXOpen::Routing::InterfaceTerminalRelationshipBase object.


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


Created in NX4.0.2.

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

Parameters
relationshipTyperelationship type

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