NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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

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 .

    <br> 
   See NX Routing help for the Connectivity data model documentation.
    <br> 
<br> Creator not available in KF.  <br> 


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 Routing::Port to the 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 Routing::Port s in the Routing::InterfaceTerminalRelationshipBase object with a relationship of related.

        <br> 
       A @link Routing::InterfaceTerminalRelationshipBase Routing::InterfaceTerminalRelationshipBase@endlink  object can have one or more related @link Routing::Port Routing::Port@endlink s
       associated with a single relating @link Routing::Port Routing::Port@endlink .
        <br> 
    @return  


Created in NX4.0.2.

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

NXOpen::Routing::InterfaceTerminalShadow* NXOpen::Routing::InterfaceTerminalRelationshipBase::GetRelatingInterfaceTerminal ( )

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

        <br> 
       A @link Routing::InterfaceTerminalRelationshipBase Routing::InterfaceTerminalRelationshipBase@endlink  object can have only one relating @link Routing::Port Routing::Port@endlink 
       associated with one or more related @link Routing::Port Routing::Port@endlink s.
        <br> 
    @return  


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 Routing::InterfaceTerminalRelationshipBase object.

        <br> 
       Interface Terminal Relationship can be of following types:
       @link Routing::InterfaceTerminalRelationshipBase::RelationTypeDecomposition Routing::InterfaceTerminalRelationshipBase::RelationTypeDecomposition@endlink 
        <br> 


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 Routing::Port from the list of related terminals in the 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 Routing::Port s in the Routing::InterfaceTerminalRelationshipBase object with input ones.

        <br> 
       Removes all the related @link Routing::Port Routing::Port@endlink s in a relationship and replaces them with the set
       of input @link Routing::Port Routing::Port@endlink s.
        <br> 


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 Routing::InterfaceTerminalRelationshipBase object.

        <br> 
       Interface Terminal Relationship can be of following types:
       @link Routing::InterfaceTerminalRelationshipBase::RelationTypeDecomposition Routing::InterfaceTerminalRelationshipBase::RelationTypeDecomposition@endlink 
        <br> 


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 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.