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

Represents a relationship between Routing::SingleDevice objects. More...

Inheritance diagram for NXOpen::Routing::DeviceRelationship:
NXOpen::Routing::ObjectRelationship NXOpen::Routing::RootObject NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Routing::Electrical::ElectricalDeviceRelationship

List of all members.

Public Types

enum  RelationType { RelationTypeAssociatedEquipment }
 Specifies the nature of the relationship between the related and relating objects. More...

Public Member Functions

void AddRelatedSingleDevice (NXOpen::Routing::SingleDevice *relatedDevice)
 Adds a Routing::SingleDevice to the collection of related Routing::SingleDevice objects.
std::vector
< NXOpen::Routing::SingleDevice * > 
GetRelatedSingleDevices ()
 Returns the list of related Routing::SingleDevice objects.
NXOpen::Routing::SingleDeviceGetRelatingSingleDevice ()
 Returns the one Routing::SingleDevice to which the other Routing::SingleDevice objects are related.
NXOpen::Routing::DeviceRelationship::RelationType RelationshipType ()
 Returns the type of the relationship.
void RemoveRelatedSingleDevice (NXOpen::Routing::SingleDevice *relatedDevice)
 Removes a Routing::SingleDevice from the collection of related Routing::SingleDevice objects.
void ReplaceRelatedSingleDevices (const std::vector< NXOpen::Routing::SingleDevice * > &relatedDevices)
 Replaces the collection of related Routing::SingleDevice objects.
void SetRelatingSingleDevice (NXOpen::Routing::SingleDevice *relatingDevice)
 Sets the one Relating Routing::SingleDevice .
void SetRelationshipType (NXOpen::Routing::DeviceRelationship::RelationType relationshipType)
 Sets the type of the relationship.

Detailed Description

Represents a relationship between Routing::SingleDevice objects.


ObjectRelationship is the abstract base class for InterfaceTerminalRelationshipBase and DeviceRelationship .

No creator is available in KF because this is an abstract class.

Created in NX4.0.2.


Member Enumeration Documentation

Specifies the nature of the relationship between the related and relating objects.


Created in NX4.0.2.

Enumerator:
RelationTypeAssociatedEquipment 

the related single devices are attached to the relating single device


Member Function Documentation

Adds a Routing::SingleDevice to the collection of related Routing::SingleDevice objects.


Created in NX4.0.2.

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

Parameters:
relatedDeviceThe Routing::SingleDevice to add to the set of related objects

Returns the list of related Routing::SingleDevice objects.

The objects in the list are related to the relating Routing::SingleDevice object.

Returns:
Set of Routing::SingleDevice objects that are related to the Relating SingleDevice
Created in NX4.0.2.

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

Returns the one Routing::SingleDevice to which the other Routing::SingleDevice objects are related.

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 relationship.


Created in NX4.0.2.

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

Removes a Routing::SingleDevice from the collection of related Routing::SingleDevice objects.


Created in NX4.0.2.

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

Parameters:
relatedDeviceThe Routing::SingleDevice that is removed from the set of related objects

Replaces the collection of related Routing::SingleDevice objects.


Created in NX4.0.2.

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

Parameters:
relatedDevicesA set of Routing::SingleDevice objects that replaces the current set of related objects

Sets the one Relating Routing::SingleDevice .


Created in NX4.0.2.

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

Parameters:
relatingDeviceThe new Relating device

Sets the type of the relationship.


Created in NX4.0.2.

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

Parameters:
relationshipTypeThe new type of the relationship

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