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

The electrical usage of a NXOpen::Routing::LogicalConnection , restricted to one From and one To terminal. More...

Inheritance diagram for NXOpen::Routing::Electrical::Connection:
NXOpen::Routing::LogicalConnection NXOpen::Routing::ConnectivityDefinition NXOpen::Routing::RouteObject NXOpen::Routing::RootObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::Routing::Electrical::CableConnection NXOpen::Routing::Electrical::NonPathConnection NXOpen::Routing::Electrical::PathConnection NXOpen::Routing::Electrical::JumperConnection

Public Types

enum  RouteLevel { RouteLevelNotRouted, RouteLevelPin, RouteLevelComponent, RouteLevelMixed }
 Routing level. More...
 

Public Member Functions

bool AddIntermediateTerminal (NXOpen::Routing::LogicalTerminal *intermediateTerminal)
 Add an intermediate terminal to this connection. More...
 
void AssignPath (NXOpen::Routing::Electrical::Connection::RouteLevel routeLevel, NXOpen::Routing::Path *path)
 Assigns the given path to this connection and routes the connection on the path using the given routing level. More...
 
void AutomaticallyRoute (NXOpen::Routing::Electrical::Connection::RouteLevel routeLevel)
 Automatically routes this connection on the shortest path using the given routing level. More...
 
NXOpen::Routing::Electrical::ConnectorDeviceFindFromConnector ()
 Get the From Connector for this connection. More...
 
NXOpen::Routing::Electrical::CableDeviceFindNearestCableDevice ()
 Query this connection to find the nearest harness. More...
 
NXOpen::Routing::Electrical::HarnessDeviceFindNearestHarnessDevice ()
 Query this connection to find the nearest harness. More...
 
NXOpen::Routing::SingleDeviceFindNearestParentDevice ()
 Queries this connection for the nearest parent device. More...
 
std::vector
< NXOpen::Routing::Path * > 
FindPaths (NXOpen::Routing::Electrical::Connection::RouteLevel routeLevel)
 Returns all the possible paths this connection can use. More...
 
NXOpen::Routing::Electrical::ConnectorDeviceFindToConnector ()
 Get the To Connector for this connection. More...
 
NXOpen::Routing::LogicalTerminalFromTerminal ()
 Returns the From terminal. More...
 
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetIntermediateTerminals ()
 Get the intermediate terminals associated with this connection. More...
 
NXString GetRoutedLevel ()
 Gets the level used to route this connection. More...
 
NXOpen::Routing::Electrical::Connection::RouteLevel GetRoutedLevelEnum ()
 Similar to NXOpen::Routing::Electrical::Connection::GetRoutedLevel , but returns the NXOpen::Routing::Electrical::Connection::RouteLevel enumeration instead of a string. More...
 
NXString GetRoutingMethod ()
 Gets the method used to route this connection. More...
 
bool IsRouted ()
 Is this connection routed? More...
 
double MaximumPathLength ()
 Returns the maximum path length for this connection. More...
 
double MinimumPathLength ()
 Returns the minimum path length for this connection. More...
 
NXString PathLengthMultiplier ()
 Returns the path length multiplier. More...
 
NXString PathLengthOffset ()
 Returns the path length offset. More...
 
bool RemoveIntermediateTerminal (NXOpen::Routing::LogicalTerminal *intermediateTerminal)
 Remove an intermediate terminal from this connection. More...
 
void ReplaceIntermediateTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &intermediateTerminals)
 Replaces the intermediate terminals associated with this connection. More...
 
void SetFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
 Sets the From terminal. More...
 
void SetMaximumPathLength (double pathLength)
 Sets the maximum path length for this connection. More...
 
void SetMinimumPathLength (double pathLength)
 Sets the minimum path length for this connection. More...
 
void SetPathLengthMultiplier (const NXString &pathLengthMultiplier)
 Sets the path length multiplier. More...
 
void SetPathLengthMultiplier (const char *pathLengthMultiplier)
 Sets the path length multiplier. More...
 
void SetPathLengthOffset (const NXString &pathLengthOffset)
 Sets the path length offset. More...
 
void SetPathLengthOffset (const char *pathLengthOffset)
 Sets the path length offset. More...
 
void SetToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
 Sets the To terminal. More...
 
NXOpen::Routing::LogicalTerminalToTerminal ()
 Returns the To terminal. More...
 
void Unroute ()
 Unroutes this connection. More...
 
- Public Member Functions inherited from NXOpen::Routing::LogicalConnection
bool AddFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
 Add Routing::LogicalTerminal to the From Terminals collection. More...
 
bool AddToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
 Add Routing::LogicalTerminal to end of the To Terminals collection. More...
 
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetFromTerminals ()
 Get all From Terminals from the logical connection. More...
 
std::vector
< NXOpen::Routing::LogicalTerminal * > 
GetToTerminals ()
 Get all To Terminals from the logical connection. More...
 
bool RemoveFromTerminal (NXOpen::Routing::LogicalTerminal *fromTerminal)
 Remove a Routing::LogicalTerminal from the From Terminals collection. More...
 
bool RemoveToTerminal (NXOpen::Routing::LogicalTerminal *toTerminal)
 Remove a Routing::LogicalTerminal from the To Terminals collection. More...
 
void ReplaceFromTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &fromTerminals)
 Replace the existing From Terminals for the logical connection with collection of Routing::LogicalTerminal terminals
Created in NX4.0.2. More...
 
void ReplaceToTerminals (const std::vector< NXOpen::Routing::LogicalTerminal * > &toTerminals)
 Replace the existing To Terminals for the logical connection with collection of Routing::LogicalTerminal terminals
Created in NX4.0.2. More...
 
- Public Member Functions inherited from NXOpen::Routing::ConnectivityDefinition
NXOpen::Routing::RouteObjectImplementedBy ()
 Returns the NXOpen::Routing::RouteObject implementing a connection. 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 usage of a NXOpen::Routing::LogicalConnection , restricted to one From and one To terminal.


See NX Open Routing help for detailed information on the Connection data model.

Creator not available in KF.

Created in NX4.0.2.

Member Enumeration Documentation

Routing level.

Enumerator
RouteLevelNotRouted 

not routed

RouteLevelPin 

Route to the pin on the connector component.

RouteLevelComponent 

Route to the connector component directly without regard for the pins.

RouteLevelMixed 

Route to the pin, if possible, otherwise route to the component.

Member Function Documentation

bool NXOpen::Routing::Electrical::Connection::AddIntermediateTerminal ( NXOpen::Routing::LogicalTerminal intermediateTerminal)

Add an intermediate terminal to this connection.

Returns
Was the NXOpen::Routing::LogicalTerminal added successfully?
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
intermediateTerminalCan not be NULL
void NXOpen::Routing::Electrical::Connection::AssignPath ( NXOpen::Routing::Electrical::Connection::RouteLevel  routeLevel,
NXOpen::Routing::Path path 
)

Assigns the given path to this connection and routes the connection on the path using the given routing level.

Use NXOpen::Routing::Electrical::Connection::FindPaths to find all available paths for this connection.


Created in NX8.0.3.

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

Parameters
routeLevelroutelevel
pathThe path on which to route this connection.
void NXOpen::Routing::Electrical::Connection::AutomaticallyRoute ( NXOpen::Routing::Electrical::Connection::RouteLevel  routeLevel)

Automatically routes this connection on the shortest path using the given routing level.


Created in NX8.0.3.

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

Parameters
routeLevelroutelevel
NXOpen::Routing::Electrical::ConnectorDevice* NXOpen::Routing::Electrical::Connection::FindFromConnector ( )

Get the From Connector for this connection.

From does not imply an ordering.

Returns
May be NULL
Created in NX4.0.2.

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

Query this connection to find the nearest harness.

Only finds a cable that is a parent to this connection at some level up the connection heirarchy.

Returns
Will be NULL if connection is not in a cable
Created in NX4.0.2.

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

Query this connection to find the nearest harness.

Only finds a harness that is a parent to this connection at some level up the connection heirarchy.

Returns
May be NULL if connection is not in a harness
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::SingleDevice* NXOpen::Routing::Electrical::Connection::FindNearestParentDevice ( )

Queries this connection for the nearest parent device.

The nearest parent device is either a cable, shield, or harness

Returns
Will be NULL if connection is not in a harness, cable, or shield.
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
std::vector<NXOpen::Routing::Path *> NXOpen::Routing::Electrical::Connection::FindPaths ( NXOpen::Routing::Electrical::Connection::RouteLevel  routeLevel)

Returns all the possible paths this connection can use.

Returns
Possible paths this connection can use.
Created in NX8.0.3.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
routeLevelroutelevel
NXOpen::Routing::Electrical::ConnectorDevice* NXOpen::Routing::Electrical::Connection::FindToConnector ( )

Get the To Connector for this connection.

To does not imply an ordering

Returns
May be NULL
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::LogicalTerminal* NXOpen::Routing::Electrical::Connection::FromTerminal ( )

Returns the From terminal.

The From terminal is one end of an electrical connection. From does not imply an ordering.
Created in NX4.0.2.

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

std::vector<NXOpen::Routing::LogicalTerminal *> NXOpen::Routing::Electrical::Connection::GetIntermediateTerminals ( )

Get the intermediate terminals associated with this connection.

Intermediate Terminals are optional and need not exist for a NXOpen::Routing::Electrical::Connection to be valid in NX.

Returns
Collection of intermediate NXOpen::Routing::LogicalTerminal - May be NULL
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXString NXOpen::Routing::Electrical::Connection::GetRoutedLevel ( )

Gets the level used to route this connection.

Returns
  • "C" Connection routed at component level
  • "P" Connection routed at pin level
  • "M" Connection routed at mixed level

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Electrical::Connection::RouteLevel NXOpen::Routing::Electrical::Connection::GetRoutedLevelEnum ( )

Similar to NXOpen::Routing::Electrical::Connection::GetRoutedLevel , but returns the NXOpen::Routing::Electrical::Connection::RouteLevel enumeration instead of a string.

Returns
Route level.
Created in NX8.0.3.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXString NXOpen::Routing::Electrical::Connection::GetRoutingMethod ( )

Gets the method used to route this connection.

Returns
  • "A" Connection is auto routed
  • "M" Connection is manual routed
  • "N" Connection is not routed

Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
bool NXOpen::Routing::Electrical::Connection::IsRouted ( )

Is this connection routed?

Returns
Is this connection routed?
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
double NXOpen::Routing::Electrical::Connection::MaximumPathLength ( )

Returns the maximum path length for this connection.

Maximum path length is the longest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

double NXOpen::Routing::Electrical::Connection::MinimumPathLength ( )

Returns the minimum path length for this connection.

Minimum path length is the shortest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

NXString NXOpen::Routing::Electrical::Connection::PathLengthMultiplier ( )

Returns the path length multiplier.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

NXString NXOpen::Routing::Electrical::Connection::PathLengthOffset ( )

Returns the path length offset.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

bool NXOpen::Routing::Electrical::Connection::RemoveIntermediateTerminal ( NXOpen::Routing::LogicalTerminal intermediateTerminal)

Remove an intermediate terminal from this connection.

Returns
Was the NXOpen::Routing::LogicalTerminal removed successfully?
Created in NX4.0.2.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
intermediateTerminalmay be NULL
void NXOpen::Routing::Electrical::Connection::ReplaceIntermediateTerminals ( const std::vector< NXOpen::Routing::LogicalTerminal * > &  intermediateTerminals)

Replaces the intermediate terminals associated with this connection.


Created in NX4.0.2.

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

Parameters
intermediateTerminalsCollection of intermediate NXOpen::Routing::LogicalTerminal - Use NULL to remove all intermdiate terminals
void NXOpen::Routing::Electrical::Connection::SetFromTerminal ( NXOpen::Routing::LogicalTerminal fromTerminal)

Sets the From terminal.

The From terminal is one end of an electrical connection. From does not imply an ordering.
Created in NX4.0.2.

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

Parameters
fromTerminalMay not be NULL
void NXOpen::Routing::Electrical::Connection::SetMaximumPathLength ( double  pathLength)

Sets the maximum path length for this connection.

Maximum path length is the longest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

Parameters
pathLengthMay be zero
void NXOpen::Routing::Electrical::Connection::SetMinimumPathLength ( double  pathLength)

Sets the minimum path length for this connection.

Minimum path length is the shortest allowable length of all segments referred to by this connection.
Created in NX4.0.2.

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

Parameters
pathLengthMay be zero
void NXOpen::Routing::Electrical::Connection::SetPathLengthMultiplier ( const NXString pathLengthMultiplier)

Sets the path length multiplier.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Parameters
pathLengthMultiplierMay be zero (cut length will be zero)
void NXOpen::Routing::Electrical::Connection::SetPathLengthMultiplier ( const char *  pathLengthMultiplier)

Sets the path length multiplier.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Parameters
pathLengthMultiplierMay be zero (cut length will be zero)
void NXOpen::Routing::Electrical::Connection::SetPathLengthOffset ( const NXString pathLengthOffset)

Sets the path length offset.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Parameters
pathLengthOffsetMay be zero
void NXOpen::Routing::Electrical::Connection::SetPathLengthOffset ( const char *  pathLengthOffset)

Sets the path length offset.

Used to calculate cut length. Cut length = length * multiplier + offset
Created in NX4.0.2.

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

Parameters
pathLengthOffsetMay be zero
void NXOpen::Routing::Electrical::Connection::SetToTerminal ( NXOpen::Routing::LogicalTerminal toTerminal)

Sets the To terminal.

The To terminal is one end of an electrical connection. To does not imply an ordering
Created in NX4.0.2.

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

Parameters
toTerminalMay not be NULL
NXOpen::Routing::LogicalTerminal* NXOpen::Routing::Electrical::Connection::ToTerminal ( )

Returns the To terminal.

The To terminal is one end of an electrical connection. To does not imply an ordering
Created in NX4.0.2.

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

void NXOpen::Routing::Electrical::Connection::Unroute ( )

Unroutes this connection.


Created in NX8.0.3.

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.