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

The Routing SingleDevice corresponds to an abstract instance of Routing::ItemDefinition . More...

Inheritance diagram for NXOpen::Routing::SingleDevice:
NXOpen::Routing::RouteObject NXOpen::Routing::RootObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Routing::Electrical::ConnectorDevice NXOpen::Routing::Electrical::HarnessDevice NXOpen::Routing::StockDevice NXOpen::Routing::Electrical::SystemDevice NXOpen::Routing::Electrical::ElectricalStockDevice NXOpen::Routing::OverstockDevice NXOpen::Routing::Electrical::CableDevice NXOpen::Routing::Electrical::WireDevice NXOpen::Routing::Electrical::ShieldDevice

List of all members.

Public Types

enum  DeleteObjectResult { DeleteObjectResultOk, DeleteObjectResultStillRouted, DeleteObjectResultStillAssigned, DeleteObjectResultCantDeleteUnknown }
 Deletion result. More...

Public Member Functions

std::vector
< NXOpen::Routing::LogicalConnection * > 
GetImplementedConnections ()
 Gets connections implemented on single device.
NXOpen::Routing::ItemDefinitionGetItemDefinition ()
 Get item definition.
std::vector
< NXOpen::Routing::DeviceRelationship * > 
GetReferencingDeviceRelshps ()
 Gets referencing device relationships.
std::vector
< NXOpen::Routing::SingleDevice * > 
GetRelatedSingleDevices ()
 Assuming this single device to be the relating single device in a Routing::DeviceRelationship , get associated related single devices.
NXOpen::Routing::SingleDeviceGetRelatingSingleDevice ()
 Assuming this single device to be the related single device in a Routing::DeviceRelationship , get associated relating single device.
NXOpen::Routing::SingleDevice::DeleteObjectResult ManuallyDelete ()
 Deletes the single device.
NXOpen::NXObjectNxEquivalent ()
 Returns the NX equivalent object.
NXString PartName ()
 Returns the part name
Created in NX4.0.2.
NXString PartNumber ()
 Returns the part number
Created in NX4.0.2.
void SetNxEquivalent (NXOpen::NXObject *routeNxEquivalent)
 Sets the NX equivalent object.
void SetPartName (const NXString &routePartName)
 Sets the part name
Created in NX4.0.2.
void SetPartNumber (const NXString &routePartNumber)
 Sets the part number
Created in NX4.0.2.

Detailed Description

The Routing SingleDevice corresponds to an abstract instance of Routing::ItemDefinition .


Creator not available in KF.

Created in NX4.0.2.


Member Enumeration Documentation

Deletion result.

Enumerator:
DeleteObjectResultOk 

Single Device deleted successfully.

DeleteObjectResultStillRouted 

Routed connections will not be deleted.

Unroute before deleting.

DeleteObjectResultStillAssigned 

Assigned components will not be deleted.

Unassign before deleting.

DeleteObjectResultCantDeleteUnknown 

Unknown error occurred while deleting.

Please report this as an Incident Report.


Member Function Documentation

Gets connections implemented on single device.

Returns:

Created in NX4.0.2.

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

Get item definition.

Returns:

Created in NX4.0.2.

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

Gets referencing device relationships.

Returns:

Created in NX4.0.2.

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

Assuming this single device to be the relating single device in a Routing::DeviceRelationship , get associated related single devices.

Returns:

Created in NX4.0.2.

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

Assuming this single device to be the related single device in a Routing::DeviceRelationship , get associated relating single device.

Returns:

Created in NX4.0.2.

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

Deletes the single device.

Returns:

Created in NX4.0.2.

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

Returns the NX equivalent object.


Created in NX4.0.2.

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

Returns the part name
Created in NX4.0.2.



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

Returns the part number
Created in NX4.0.2.



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

Sets the NX equivalent object.


Created in NX4.0.2.

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

Parameters:
routeNxEquivalentroute nx equivalent
void NXOpen::Routing::SingleDevice::SetPartName ( const NXString routePartName)

Sets the part name
Created in NX4.0.2.



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

Parameters:
routePartNameroute part name
void NXOpen::Routing::SingleDevice::SetPartNumber ( const NXString routePartNumber)

Sets the part number
Created in NX4.0.2.



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

Parameters:
routePartNumberroute part number

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