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

The Electrical ConnectorDevice corresponds to a connector instance of NXOpen::Routing::SingleDevice . More...

Inheritance diagram for NXOpen::Routing::Electrical::ConnectorDevice:
NXOpen::Routing::SingleDevice NXOpen::Routing::RouteObject NXOpen::Routing::RootObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject

Public Types

enum  Assign { AssignNone, AssignAuto, AssignManual }
 Assignment method. More...
 
enum  ComponentType {
  ComponentTypeNone, ComponentTypeConnector, ComponentTypeSplice, ComponentTypeDevice,
  ComponentTypeOther
}
 Component type. More...
 
- Public Types inherited from NXOpen::Routing::SingleDevice
enum  DeleteObjectResult { DeleteObjectResultOk, DeleteObjectResultStillRouted, DeleteObjectResultStillAssigned, DeleteObjectResultCantDeleteUnknown }
 Deletion result. More...
 

Public Member Functions

NXString ComponentName ()
 Returns the component name. More...
 
NXOpen::Routing::Electrical::ConnectorDevice::ComponentType ConnectorType ()
 Returns the connector type. More...
 
std::vector
< NXOpen::Routing::Electrical::Connection * > 
FindConnections ()
 Find connections. More...
 
std::vector
< NXOpen::Routing::CharacteristicList * > 
FindMatchingParts ()
 Find parts matching the connector device. More...
 
NXOpen::Routing::Electrical::CableDeviceFindNearestCableDevice ()
 Get the nearest NXOpen::Routing::Electrical::CableDevice encountered up the parent-child hierarchy. More...
 
NXOpen::Routing::Electrical::HarnessDeviceFindNearestHarnessDevice ()
 Get the nearest NXOpen::Routing::Electrical::HarnessDevice encountered up the parent-child hierarchy. More...
 
NXOpen::Routing::PortFindPlacer (double *placerPos)
 Searches for a placement port for the connector device. More...
 
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
FindRoutedStockDevices ()
 Find routed stock devices. More...
 
std::vector
< NXOpen::Routing::Electrical::ElectricalStockDevice * > 
FindStockDevices ()
 Find stock devices. More...
 
NXOpen::Routing::Electrical::ConnectorDevice::Assign GetAssignMethod ()
 Get assign method. More...
 
NXOpen::Routing::Electrical::ElectricalPartDefinitionShadowGetPartDefinition ()
 Get part definition. More...
 
NXOpen::Routing::LogicalTerminalGetTerminal (const NXString &terminalName, bool createTerminal)
 Get NXOpen::Routing::LogicalTerminal given the name of the terminal. More...
 
NXOpen::Routing::LogicalTerminalGetTerminal (const char *terminalName, bool createTerminal)
 Get NXOpen::Routing::LogicalTerminal given the name of the terminal. More...
 
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetTerminals ()
 Get terminals. More...
 
bool IsAssigned ()
 Get status of a connector device (assigned or not). More...
 
bool IsNxConnector (NXOpen::Routing::Electrical::HarnessDevice *elecHarnessDevice)
 Is the device a connector? More...
 
bool IsNxDevice (NXOpen::Routing::Electrical::HarnessDevice *elecHarnessDevice)
 Is the device a NX device? More...
 
bool IsUsedInRoutedConnection (NXOpen::Routing::Electrical::HarnessDevice *elecHarnessDevice)
 Is the device used in a routed connection? More...
 
void ManuallyAssignConnector (NXOpen::Assemblies::Component *elecConnectorPartOccurrence)
 Assign a connector manually. More...
 
NXOpen::Assemblies::ComponentPlaceConnectorOnPort (NXOpen::Routing::CharacteristicList *match, NXOpen::Routing::Port *placer)
 Loads the parts based on the NXOpen::Routing::CharacteristicList adds the instance of the part to the current work part and places the instance on the placer. More...
 
void ProxyAssignConnector (NXOpen::Routing::Port *proxy)
 Assign a connector to a proxy port. More...
 
bool RemoveTerminal (NXOpen::Routing::LogicalTerminal *routeTerminalToRemove)
 Remove a terminal. More...
 
void SetComponentName (const NXString &componentName)
 Sets the component name. More...
 
void SetComponentName (const char *componentName)
 Sets the component name. More...
 
void SetConnectorType (NXOpen::Routing::Electrical::ConnectorDevice::ComponentType elecRlistComponent)
 Sets the connector type. More...
 
void SetPartDefinition (NXOpen::Routing::Electrical::ElectricalPartDefinitionShadow *elecPartDefinitionShadow)
 Sets part definition. More...
 
void UnassignConnector ()
 Unassign connector. More...
 
- Public Member Functions inherited from NXOpen::Routing::SingleDevice
std::vector
< NXOpen::Routing::LogicalConnection * > 
GetImplementedConnections ()
 Gets connections implemented on single device. More...
 
NXOpen::Routing::ItemDefinitionGetItemDefinition ()
 Get item definition. More...
 
std::vector
< NXOpen::Routing::DeviceRelationship * > 
GetReferencingDeviceRelshps ()
 Gets referencing device relationships. More...
 
std::vector
< NXOpen::Routing::SingleDevice * > 
GetRelatedSingleDevices ()
 Assuming this single device to be the relating single device in a NXOpen::Routing::DeviceRelationship , get associated related single devices. More...
 
NXOpen::Routing::SingleDeviceGetRelatingSingleDevice ()
 Assuming this single device to be the related single device in a NXOpen::Routing::DeviceRelationship , get associated relating single device. More...
 
NXOpen::Routing::SingleDevice::DeleteObjectResult ManuallyDelete ()
 Deletes the single device. More...
 
NXOpen::NXObjectNxEquivalent ()
 Returns the NX equivalent object. More...
 
NXString PartName ()
 Returns the part name
Created in NX4.0.2. More...
 
NXString PartNumber ()
 Returns the part number
Created in NX4.0.2. More...
 
void SetNxEquivalent (NXOpen::NXObject *routeNxEquivalent)
 Sets the NX equivalent object. More...
 
void SetPartName (const NXString &routePartName)
 Sets the part name
Created in NX4.0.2. More...
 
void SetPartName (const char *routePartName)
 Sets the part name
Created in NX4.0.2. More...
 
void SetPartNumber (const NXString &routePartNumber)
 Sets the part number
Created in NX4.0.2. More...
 
void SetPartNumber (const char *routePartNumber)
 Sets the part number
Created in NX4.0.2. More...
 
- Public Member Functions inherited from NXOpen::Routing::RouteObject
virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
 Removes the input list of characteristics from this object. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object. More...
 
virtual int GetIntegerCharacteristic (const NXString &name)
 Get the value of an integer characteristic associated with the input name. More...
 
virtual int GetIntegerCharacteristic (const char *name)
 Get the value of an integer characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const char *name)
 Get the value of a real characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const char *name)
 Get the value of a string characteristic associated with the input name. More...
 
virtual void SetCharacteristic (const NXString &name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const char *name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const NXString &name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const char *name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const NXString &name, const NXString &value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic (const char *name, const char *value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...
 
virtual void SetCharacteristic2 (const NXString &title, int value)
 Sets or creates an integer type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, int value)
 Sets or creates an integer type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const NXString &title, double value)
 Sets or creates a double type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, double value)
 Sets or creates a double type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const NXString &title, const NXString &value)
 Sets or creates a string type type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, const char *value)
 Sets or creates a string type type attribute associated with the input title. More...
 
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
 Set all of the characteristics values on this object. More...
 
virtual void SetCharacteristics2 (NXOpen::Routing::CharacteristicList *values)
 Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...
 
- Public Member Functions inherited from NXOpen::Routing::RootObject
NXString Guid ()
 Returns the object's Global Unique Identifier (GUID). More...
 
void SetGuid (const NXString &guid)
 Sets the object's Global Unique Identifier (GUID). More...
 
void SetGuid (const char *guid)
 Sets the object's Global Unique Identifier (GUID). More...
 
- Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIteratorCreateAttributeIterator ()
 Create an attribute iterator. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator
Created in NX8.0.0. More...
 
void DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
bool GetNextUserAttribute (NXOpen::AttributeIterator *iterator, NXOpen::NXObject::AttributeInformation *info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
NXString GetPdmReferenceAttributeValue (const NXString &attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
NXString GetPdmReferenceAttributeValue (const char *attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
NXString GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
NXString GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (NXOpen::AttributeIterator *iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
int GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (NXOpen::AttributeIterator *iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator. More...
 
bool HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
bool HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetPdmReferenceAttribute (const char *attributeTitle, const char *attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

The Electrical ConnectorDevice corresponds to a connector instance of NXOpen::Routing::SingleDevice .


To create a new instance of this class, use NXOpen::Routing::Electrical::ConnectorDeviceCollection::CreateConnectorDevice

Created in NX4.0.2.

Member Enumeration Documentation

Assignment method.

Enumerator
AssignNone 

none

AssignAuto 

auto

AssignManual 

manual

Component type.

Enumerator
ComponentTypeNone 

none

ComponentTypeConnector 

connector

ComponentTypeSplice 

splice

ComponentTypeDevice 

device

ComponentTypeOther 

other

Member Function Documentation

NXString NXOpen::Routing::Electrical::ConnectorDevice::ComponentName ( )

Returns the component name.


Created in NX4.0.2.

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

NXOpen::Routing::Electrical::ConnectorDevice::ComponentType NXOpen::Routing::Electrical::ConnectorDevice::ConnectorType ( )

Returns the connector type.


Created in NX4.0.2.

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

std::vector<NXOpen::Routing::Electrical::Connection *> NXOpen::Routing::Electrical::ConnectorDevice::FindConnections ( )

Find connections.

Returns

Created in NX4.0.2.

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

Find parts matching the connector device.

Searches for "PART_NAME" property on connector device to search for matches in the part tables Returns all matching rows from the part tables.

Returns

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Electrical::CableDevice* NXOpen::Routing::Electrical::ConnectorDevice::FindNearestCableDevice ( )

Get the nearest NXOpen::Routing::Electrical::CableDevice encountered up the parent-child hierarchy.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Electrical::HarnessDevice* NXOpen::Routing::Electrical::ConnectorDevice::FindNearestHarnessDevice ( )

Get the nearest NXOpen::Routing::Electrical::HarnessDevice encountered up the parent-child hierarchy.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Port* NXOpen::Routing::Electrical::ConnectorDevice::FindPlacer ( double *  placerPos)

Searches for a placement port for the connector device.

The placement port is defined in the component list by attribute "DEVICE_PIN" or "EQUIPMENT_PIN". If the attribute is not defined, searches for the first available port on the relating device.

Returns

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
placerPosplacer pos
std::vector<NXOpen::Routing::Electrical::ElectricalStockDevice *> NXOpen::Routing::Electrical::ConnectorDevice::FindRoutedStockDevices ( )

Find routed stock devices.

Returns

Created in NX4.0.2.

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

Find stock devices.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Electrical::ConnectorDevice::Assign NXOpen::Routing::Electrical::ConnectorDevice::GetAssignMethod ( )

Get assign method.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Electrical::ElectricalPartDefinitionShadow* NXOpen::Routing::Electrical::ConnectorDevice::GetPartDefinition ( )

Get part definition.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::LogicalTerminal* NXOpen::Routing::Electrical::ConnectorDevice::GetTerminal ( const NXString terminalName,
bool  createTerminal 
)

Get NXOpen::Routing::LogicalTerminal given the name of the terminal.

If a terminal does not exists creates a terminal

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
terminalNameterminal name
createTerminalTRUE - creates a new terminal if one does not exist with given name
NXOpen::Routing::LogicalTerminal* NXOpen::Routing::Electrical::ConnectorDevice::GetTerminal ( const char *  terminalName,
bool  createTerminal 
)

Get NXOpen::Routing::LogicalTerminal given the name of the terminal.

If a terminal does not exists creates a terminal

Returns

Created in NX5.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
terminalNameterminal name
createTerminalTRUE - creates a new terminal if one does not exist with given name
std::vector<NXOpen::Routing::LogicalTerminal *> NXOpen::Routing::Electrical::ConnectorDevice::GetTerminals ( )

Get terminals.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
bool NXOpen::Routing::Electrical::ConnectorDevice::IsAssigned ( )

Get status of a connector device (assigned or not).

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
bool NXOpen::Routing::Electrical::ConnectorDevice::IsNxConnector ( NXOpen::Routing::Electrical::HarnessDevice elecHarnessDevice)

Is the device a connector?

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
elecHarnessDeviceelec harness device
bool NXOpen::Routing::Electrical::ConnectorDevice::IsNxDevice ( NXOpen::Routing::Electrical::HarnessDevice elecHarnessDevice)

Is the device a NX device?

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
elecHarnessDeviceelec harness device
bool NXOpen::Routing::Electrical::ConnectorDevice::IsUsedInRoutedConnection ( NXOpen::Routing::Electrical::HarnessDevice elecHarnessDevice)

Is the device used in a routed connection?

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
elecHarnessDeviceelec harness device
void NXOpen::Routing::Electrical::ConnectorDevice::ManuallyAssignConnector ( NXOpen::Assemblies::Component elecConnectorPartOccurrence)

Assign a connector manually.


Created in NX4.0.2.

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

Parameters
elecConnectorPartOccurrenceComponent to assign.
NXOpen::Assemblies::Component* NXOpen::Routing::Electrical::ConnectorDevice::PlaceConnectorOnPort ( NXOpen::Routing::CharacteristicList match,
NXOpen::Routing::Port placer 
)

Loads the parts based on the NXOpen::Routing::CharacteristicList adds the instance of the part to the current work part and places the instance on the placer.

Returns

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
matchmatch
placerplacer
void NXOpen::Routing::Electrical::ConnectorDevice::ProxyAssignConnector ( NXOpen::Routing::Port proxy)

Assign a connector to a proxy port.


Created in NX8.0.0.

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

Parameters
proxyAssigned port.
bool NXOpen::Routing::Electrical::ConnectorDevice::RemoveTerminal ( NXOpen::Routing::LogicalTerminal routeTerminalToRemove)

Remove a terminal.

Returns

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
routeTerminalToRemoveroute terminal to remove
void NXOpen::Routing::Electrical::ConnectorDevice::SetComponentName ( const NXString componentName)

Sets the component name.


Created in NX4.0.2.

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

Parameters
componentNamecomponent name
void NXOpen::Routing::Electrical::ConnectorDevice::SetComponentName ( const char *  componentName)

Sets the component name.


Created in NX4.0.2.

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

Parameters
componentNamecomponent name
void NXOpen::Routing::Electrical::ConnectorDevice::SetConnectorType ( NXOpen::Routing::Electrical::ConnectorDevice::ComponentType  elecRlistComponent)

Sets the connector type.


Created in NX4.0.2.

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

Parameters
elecRlistComponentelec rlist component
void NXOpen::Routing::Electrical::ConnectorDevice::SetPartDefinition ( NXOpen::Routing::Electrical::ElectricalPartDefinitionShadow elecPartDefinitionShadow)

Sets part definition.


Created in NX4.0.2.

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

Parameters
elecPartDefinitionShadowelec part definition shadow
void NXOpen::Routing::Electrical::ConnectorDevice::UnassignConnector ( )

Unassign connector.


Created in NX4.0.2.

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


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