CableDefinition Class¶
-
class
NXOpen.Routing.Electrical.
CableDefinition
¶ Bases:
NXOpen.Routing.AssemblyDefinition
Holds the collection of wires in a
NXOpen.Routing.Electrical.CableDevice
.A cable consists of both a
NXOpen.Routing.Electrical.CableDevice
and aNXOpen.Routing.Electrical.CableDefinition
. ANXOpen.Routing.Electrical.CableDevice
object uses aNXOpen.Routing.Electrical.CableDefinition
to hold a collection ofNXOpen.Routing.Electrical.WireDevice
objects and/orNXOpen.Routing.Electrical.CableDevice
objects contained by the cable. This definition corresponds to AP212 Assembly_definition.See the NX Routing help for detailed information on the Connection data model.
Creator not available in KF.
New in version NX4.0.2.
Properties¶
Property | Description |
---|---|
DefiningNxObject | Returns the NX object associated with the item definition object. |
Guid | Returns or sets the object’s Global Unique Identifier (GUID). |
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 |
---|---|
AddSingleDeviceChild | Adds a NXOpen.Routing.SingleDevice object to the list of objects contained in the assembly. |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteCharacterstics | Removes the input list of characteristics from this object. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
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. |
GetCharacteristics | Get all of the characteristics values on the this object. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetDestinationCharacteristics | Returns the destination characteristics from the input object. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerCharacteristic | Get the value of an integer characteristic associated with the input name. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetRealAttribute | Gets a real attribute by title. |
GetRealCharacteristic | Get the value of a real characteristic associated with the input name. |
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. |
GetReferencingDevice | Gets the NXOpen.Routing.SingleDevice object that has this AssemblyDefinition object as its definition. |
GetSingleDeviceChildren | Gets the list of NXOpen.Routing.SingleDevice objects contained in the assembly. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringCharacteristic | Get the value of a string characteristic associated with the input name. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
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, of the given type. |
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. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | 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. |
IsSingleDeviceChild | Determines if a NXOpen.Routing.SingleDevice object is contained in the assembly @return TRUE if the object is in the AssemblyDefinition |
Prints a representation of this object to the system log file. | |
RemoveSingleDeviceChild | Removes a NXOpen.Routing.SingleDevice from the list of objects contained in the assembly. |
ReplaceSingleDeviceChildren | Replaces the list of NXOpen.Routing.SingleDevice objects contained in the assembly. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetCharacteristic | 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. |
SetCharacteristics | Set all of the characteristics values on this object. |
SetName | Sets the custom name of the object. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
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¶
-
CableDefinition.
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¶
-
CableDefinition.
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¶
-
CableDefinition.
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¶
-
CableDefinition.
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¶
-
CableDefinition.
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¶
-
CableDefinition.
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¶
DeleteCharacterstics¶
-
CableDefinition.
DeleteCharacterstics
¶ Removes the input list of characteristics from this object.
Signature
DeleteCharacterstics(values)
Parameters: values ( NXOpen.Routing.CharacteristicList
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
FindObject¶
-
CableDefinition.
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.
GetCharacteristics¶
-
CableDefinition.
GetCharacteristics
¶ Get all of the characteristics values on the this object.
Signature
GetCharacteristics()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetDestinationCharacteristics¶
-
CableDefinition.
GetDestinationCharacteristics
¶ Returns the destination characteristics from the input object.
Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object
- Ports: Reads characteristics from the port.
- RCPs: Attempts to find a port at the RCP, reads characteristics from
the port if it exists, otherwise reads from the stock associated with the rcp.
- Segments: Reads characteristics from the stock associated with the segment.
- Components: Reads characteristics directly from the component.
- Stock: Reads characteristics from the stock or from the stock’s data.
Signature
GetDestinationCharacteristics()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetIntegerCharacteristic¶
-
CableDefinition.
GetIntegerCharacteristic
¶ Get the value of an integer characteristic associated with the input name.
Signature
GetIntegerCharacteristic(name)
Parameters: name (str) – NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: int New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetRealCharacteristic¶
-
CableDefinition.
GetRealCharacteristic
¶ Get the value of a real characteristic associated with the input name.
Signature
GetRealCharacteristic(name)
Parameters: name (str) – NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: float New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
GetStringCharacteristic¶
-
CableDefinition.
GetStringCharacteristic
¶ Get the value of a string characteristic associated with the input name.
Signature
GetStringCharacteristic(name)
Parameters: name (str) – NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type: str New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
Print¶
-
CableDefinition.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetCharacteristic¶
-
CableDefinition.
SetCharacteristic
¶ Overloaded method SetCharacteristic
SetCharacteristic(name, value)
SetCharacteristic(name, value)
SetCharacteristic(name, 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. Converts the type of an existing characteristic with the same name to integer if it’s type is not integer.
Signature
SetCharacteristic(name, value)
Parameters: - name (str) – NOTE: The full Unicode character set is not supported for this parameter.
- value (int) –
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
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. Converts the type of an existing characteristic with the same name to real if it’s type is not real.
Signature
SetCharacteristic(name, value)
Parameters: - name (str) – NOTE: The full Unicode character set is not supported for this parameter.
- value (float) –
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
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. Converts the type of an existing characteristic with the same name to string if it’s type is not string.
Signature
SetCharacteristic(name, value)
Parameters: - name (str) – NOTE: The full Unicode character set is not supported for this parameter.
- value (str) – NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
SetCharacteristics¶
-
CableDefinition.
SetCharacteristics
¶ Set all of the characteristics values on this object.
Signature
SetCharacteristics(values)
Parameters: values ( NXOpen.Routing.CharacteristicList
) –New in version NX4.0.0.
License requirements: routing_base (“Routing Basic”)
SetName¶
-
CableDefinition.
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.