NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Routing::Electrical::ConnectorDeviceCollection Class Reference

Represents a collection of NXOpen::Routing::Electrical::ConnectorDevice (CD) objects. More...

Inheritance diagram for NXOpen::Routing::Electrical::ConnectorDeviceCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

void AutoAssignConnectors (const std::vector< NXOpen::Routing::Electrical::ConnectorDevice * > &connectors)
 Auto assignment is done using one of the three matching methods, Part Name, Component Name or Attribute. More...
 
iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::Routing::Electrical::ConnectorDeviceCreateConnectorDevice (NXOpen::Routing::Electrical::ConnectorDevice::ComponentType connectorType, const NXString &componentName)
 Creates a NXOpen::Routing::Electrical::ConnectorDevice . More...
 
NXOpen::Routing::Electrical::ConnectorDeviceCreateConnectorDevice (NXOpen::Routing::Electrical::ConnectorDevice::ComponentType connectorType, const char *componentName)
 Creates a NXOpen::Routing::Electrical::ConnectorDevice . More...
 
NXOpen::Routing::Electrical::ConnectorDeviceCreateConnectorDevice (NXOpen::Routing::Electrical::HarnessDevice *harnessDevice, const NXString &equipmentName, const NXString &connectorName, NXOpen::Routing::Electrical::ConnectorDevice::ComponentType connectorType)
 Finds or Creates a NXOpen::Routing::Electrical::ConnectorDevice for given equipmentName and or connectorName. More...
 
NXOpen::Routing::Electrical::ConnectorDeviceCreateConnectorDevice (NXOpen::Routing::Electrical::HarnessDevice *harnessDevice, const char *equipmentName, const char *connectorName, NXOpen::Routing::Electrical::ConnectorDevice::ComponentType connectorType)
 Finds or Creates a NXOpen::Routing::Electrical::ConnectorDevice for given equipmentName and or connectorName. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
std::vector
< NXOpen::Routing::Electrical::ConnectorDevice * > 
GetConnectorSingleDevices ()
 Get connectors from the work part. More...
 
std::vector
< NXOpen::Routing::Electrical::ConnectorDevice * > 
GetEquipmentSingleDevices ()
 Get equipment from the work part. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Routing::Electrical::ConnectorDevice (CD) objects.


To obtain an instance of this class, refer to NXOpen::Routing::RouteManager

Created in NX4.0.2.

Member Function Documentation

void NXOpen::Routing::Electrical::ConnectorDeviceCollection::AutoAssignConnectors ( const std::vector< NXOpen::Routing::Electrical::ConnectorDevice * > &  connectors)

Auto assignment is done using one of the three matching methods, Part Name, Component Name or Attribute.


Created in NX4.0.2.

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

Parameters
connectorsconnectors
iterator NXOpen::Routing::Electrical::ConnectorDeviceCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Routing::Electrical::ConnectorDevice* NXOpen::Routing::Electrical::ConnectorDeviceCollection::CreateConnectorDevice ( NXOpen::Routing::Electrical::ConnectorDevice::ComponentType  connectorType,
const NXString componentName 
)

Creates a NXOpen::Routing::Electrical::ConnectorDevice .

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
connectorTypeconnector type
componentNamecomponent name
NXOpen::Routing::Electrical::ConnectorDevice* NXOpen::Routing::Electrical::ConnectorDeviceCollection::CreateConnectorDevice ( NXOpen::Routing::Electrical::ConnectorDevice::ComponentType  connectorType,
const char *  componentName 
)

Creates a NXOpen::Routing::Electrical::ConnectorDevice .

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
connectorTypeconnector type
componentNamecomponent name
NXOpen::Routing::Electrical::ConnectorDevice* NXOpen::Routing::Electrical::ConnectorDeviceCollection::CreateConnectorDevice ( NXOpen::Routing::Electrical::HarnessDevice harnessDevice,
const NXString equipmentName,
const NXString connectorName,
NXOpen::Routing::Electrical::ConnectorDevice::ComponentType  connectorType 
)

Finds or Creates a NXOpen::Routing::Electrical::ConnectorDevice for given equipmentName and or connectorName.

Builds NXOpen::Routing::Electrical::ElectricalDeviceRelationship between equipment and connector, if equipmentName and connectorName are not NULL. Adds connector to harnessDevice, if connectorName and harnessDevice are not NULL.

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
harnessDevicecan be NULL
equipmentNamecan be NULL if connectorName is not NULL
connectorNamecan be NULL if equipmentName is not NULL
connectorTypeconnector type
NXOpen::Routing::Electrical::ConnectorDevice* NXOpen::Routing::Electrical::ConnectorDeviceCollection::CreateConnectorDevice ( NXOpen::Routing::Electrical::HarnessDevice harnessDevice,
const char *  equipmentName,
const char *  connectorName,
NXOpen::Routing::Electrical::ConnectorDevice::ComponentType  connectorType 
)

Finds or Creates a NXOpen::Routing::Electrical::ConnectorDevice for given equipmentName and or connectorName.

Builds NXOpen::Routing::Electrical::ElectricalDeviceRelationship between equipment and connector, if equipmentName and connectorName are not NULL. Adds connector to harnessDevice, if connectorName and harnessDevice are not NULL.

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
harnessDevicecan be NULL
equipmentNamecan be NULL if connectorName is not NULL
connectorNamecan be NULL if equipmentName is not NULL
connectorTypeconnector type
iterator NXOpen::Routing::Electrical::ConnectorDeviceCollection::end ( )

Returns an iterator addressing one past the last element.

std::vector<NXOpen::Routing::Electrical::ConnectorDevice *> NXOpen::Routing::Electrical::ConnectorDeviceCollection::GetConnectorSingleDevices ( )

Get connectors from the work part.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
std::vector<NXOpen::Routing::Electrical::ConnectorDevice *> NXOpen::Routing::Electrical::ConnectorDeviceCollection::GetEquipmentSingleDevices ( )

Get equipment from the work part.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
tag_t NXOpen::Routing::Electrical::ConnectorDeviceCollection::Tag ( ) const

Returns the tag of this object.


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