RouteLogicalAssociation Class

class NXOpen.Routing.RouteLogicalAssociation

Bases: NXOpen.NXObject

RouteLogicalAssociation object associates non-electrical components to electrical components.

Logical Associations have control objects and target objects. Meeting control object’s condition applies actions to target objects. Example: Control object is a NXOpen.Routing.ISegment and the target object is a clip or clamp which supports the harness. When the segment is routed (i.e. condition on control object is satisfied), the action is to suppress the target (clip or clamp) To obtain an instance of this class use NXOpen.Routing.RouteLogicalAssociationCollection

New in version NX4.0.0.

Properties

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
Tag	Returns the Tag for this object.

Methods

Method	Description
AddTarget	Adds target to Logical Assocition
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
EnableLogicalAssociation	Set Logical Association to enabled state or disabled state.
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetControl	Retrieves the control for LogicalAssocition
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetRoutedCondition	Get the routed condition of a logical association object.
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTargets	Get all the targets LogicalAssocition
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Perform	Performs the specified action (suppress or unsuppress) on the RouteLogicalAssociation Object
Print	Prints a representation of this object to the system log file.
Remove	Removes the RouteLogicalAssociation object
RemoveTarget	Removes the target from Logical Assocition
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetControl	Sets the control for LogicalAssocition
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetRoutedCondition	Set the routed condition of a logical association object * The routed condition evaluates the state of the control object.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.

Property Detail

IsOccurrence

RouteLogicalAssociation.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

RouteLogicalAssociation.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

RouteLogicalAssociation.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

RouteLogicalAssociation.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

RouteLogicalAssociation.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

RouteLogicalAssociation.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

AddTarget

RouteLogicalAssociation.AddTarget

Adds target to Logical Assocition

Signature AddTarget(target)

Parameters:target (NXOpen.NXObject) – Target to add

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

EnableLogicalAssociation

RouteLogicalAssociation.EnableLogicalAssociation

Set Logical Association to enabled state or disabled state.

• True sets LAO to enabled state, False sets LAO to disabled state.

Signature EnableLogicalAssociation(enable)

Parameters:enable (bool) – True or False

New in version NX5.0.0.

License requirements: routing_harness (“Routing Harness”)

FindObject

RouteLogicalAssociation.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetControl

RouteLogicalAssociation.GetControl

Retrieves the control for LogicalAssocition

Signature GetControl()

Returns:Control Return type:NXOpen.NXObject

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

GetRoutedCondition

RouteLogicalAssociation.GetRoutedCondition

Get the routed condition of a logical association object.

• The routed condition evaluates the state of the control object.
• True if condition is ROUTED, False if UNROUTED

Signature GetRoutedCondition()

Returns: Return type:bool

New in version NX5.0.0.

License requirements: routing_harness (“Routing Harness”)

GetTargets

RouteLogicalAssociation.GetTargets

Get all the targets LogicalAssocition

Signature GetTargets()

Returns:Targets of current logical association Return type:list of NXOpen.NXObject

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

Perform

RouteLogicalAssociation.Perform

Performs the specified action (suppress or unsuppress) on the RouteLogicalAssociation Object

Signature Perform()

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

Print

RouteLogicalAssociation.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

Remove

RouteLogicalAssociation.Remove

Removes the RouteLogicalAssociation object

Signature Remove()

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

RemoveTarget

RouteLogicalAssociation.RemoveTarget

Removes the target from Logical Assocition

Signature RemoveTarget(target)

Parameters:target (NXOpen.NXObject) – Target to remove

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

SetControl

RouteLogicalAssociation.SetControl

Sets the control for LogicalAssocition

Signature SetControl(control)

Parameters:control (NXOpen.NXObject) – Control

New in version NX4.0.0.

License requirements: routing_harness (“Routing Harness”)

SetName

RouteLogicalAssociation.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

SetRoutedCondition

RouteLogicalAssociation.SetRoutedCondition

Set the routed condition of a logical association object * The routed condition evaluates the state of the control object.

• True if condition is ROUTED, False if UNROUTED

Signature SetRoutedCondition(condition)

Parameters:condition (bool) –

New in version NX5.0.0.

License requirements: routing_harness (“Routing Harness”)