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

Represents a relationship between NXOpen::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

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

Detailed Description

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


ObjectRelationship is the abstract base class for NXOpen::Routing::InterfaceTerminalRelationshipBase and NXOpen::Routing::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

void NXOpen::Routing::DeviceRelationship::AddRelatedSingleDevice ( NXOpen::Routing::SingleDevice relatedDevice)

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


Created in NX4.0.2.

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

Parameters
relatedDeviceThe NXOpen::Routing::SingleDevice to add to the set of related objects
std::vector<NXOpen::Routing::SingleDevice *> NXOpen::Routing::DeviceRelationship::GetRelatedSingleDevices ( )

Returns the list of related NXOpen::Routing::SingleDevice objects.

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

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

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::SingleDevice* NXOpen::Routing::DeviceRelationship::GetRelatingSingleDevice ( )

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

Returns

Created in NX4.0.2.

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

Returns the type of the relationship.


Created in NX4.0.2.

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

void NXOpen::Routing::DeviceRelationship::RemoveRelatedSingleDevice ( NXOpen::Routing::SingleDevice relatedDevice)

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


Created in NX4.0.2.

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

Parameters
relatedDeviceThe NXOpen::Routing::SingleDevice that is removed from the set of related objects
void NXOpen::Routing::DeviceRelationship::ReplaceRelatedSingleDevices ( const std::vector< NXOpen::Routing::SingleDevice * > &  relatedDevices)

Replaces the collection of related NXOpen::Routing::SingleDevice objects.


Created in NX4.0.2.

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

Parameters
relatedDevicesA set of NXOpen::Routing::SingleDevice objects that replaces the current set of related objects
void NXOpen::Routing::DeviceRelationship::SetRelatingSingleDevice ( NXOpen::Routing::SingleDevice relatingDevice)

Sets the one Relating NXOpen::Routing::SingleDevice .


Created in NX4.0.2.

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

Parameters
relatingDeviceThe new Relating device
void NXOpen::Routing::DeviceRelationship::SetRelationshipType ( NXOpen::Routing::DeviceRelationship::RelationType  relationshipType)

Sets the type of the relationship.


Created in NX4.0.2.

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

Parameters
relationshipTypeThe new type of the relationship

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