UserDefinedObject Class¶
-
class
NXOpen.UserDefinedObjects.
UserDefinedObject
¶ Bases:
NXOpen.DisplayableObject
JA interface for the UserDefinedObject object
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
ClassName | Returns the class name of this UDO |
Color | Returns or sets the color of the object. |
IsBlanked | Returns the blank status of this object. |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Layer | Returns or sets the layer that the object is in. |
LineFont | Returns or sets the line font of the object. |
LineWidth | Returns or sets the line width of the object. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
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. |
UserDefinedClass | Returns or sets the NXOpen.UserDefinedObjects.UserDefinedClass for this UDO |
Methods¶
Method | Description |
---|---|
Blank | Blanks the object. |
ClearUserDefinedObjectStatus | Clears the out of data indicator (status) of this UDO |
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 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. |
GetAreas | Gets all of the areas stored with this UDO @return Array of areas stored with this UDO |
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. |
GetDoubles | Gets all of the doubles stored with this UDO @return Array of doubles stored with this UDO |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetIntegers | Gets all of the integers stored with this UDO @return Array of integers stored with this UDO |
GetLengths | Gets all of the lengths stored with this UDO @return Array of lengths stored with this UDO |
GetLinks | Gets all links with the given link type that are stored with this UDO @return Array of links (with the given link type) stored with this UDO |
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. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetStrings | Gets all of the strings stored with this UDO @return Array of strings stored with this UDO |
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. |
GetUserDefinedObjectFeature | Gets the NXOpen.Features.UserDefinedObjectFeature associated with this UDO, if there isn’t an associated feature, None is returned @return The UserDefinedObjectFeature associated this UDO |
GetUserDefinedObjectStatus | Gets the out of date indicator (status) of this UDO @return The status of this UDO 0 - The UDO is up to date 1 - Out of date due to addition or deletion of links to the UDO 2 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method 3 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method 4 - Out of date due to deletion of associated (linked) objects in the absence of a UDO method 5 - Out of date due to addition or deletion of links to the UDO AND deletion of associated (linked) objects in the absence of a UDO method 6 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method 7 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method |
GetVolumes | Gets all of the volumes stored with this UDO @return Array of volumes stored with this UDO |
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. |
Highlight | Highlights the object. |
PopAreas | Removes the areas stored at the end of the area array for this UDO, and returns them in an array @return Array of areas that have been removed from this UDO |
PopDoubles | Removes the doubles stored at the end of the double array for this UDO, and returns them in an array @return Array of doubles that have been removed from this UDO |
PopIntegers | Removes the integers stored at the end of the integer array for this UDO, and returns them in an array @return Array of integers that have been removed from this UDO |
PopLengths | Removes the lengths stored at the end of the length array for this UDO, and returns them in an array @return Array of lengths that have been removed from this UDO |
PopLinks | Removes the links stored at the end of the given link type’s link array for this UDO, and returns them in an array @return Array of links (with the given link type) that have been removed from this UDO |
PopStrings | Removes the strings stored at the end of the string array for this UDO, and returns them in an array @return Array of strings that have been removed from this UDO |
PopVolumes | Removes the volumes stored at the end of the volume array for this UDO, and returns them in an array @return Array of volumes that have been removed from this UDO |
Prints a representation of this object to the system log file. | |
PushAreas | Add the specified areas to the end of the area array for this UDO |
PushDoubles | Add the specified doubles to the end of the double array for this UDO |
PushIntegers | Add the specified integers to the end of the integer array for this UDO |
PushLengths | Add the specified lengths to the end of the length array for this UDO |
PushLinks | Add the specified links to the end of the given link type’s link array for this UDO |
PushStrings | Add the specified strings to the end of the string array for this UDO |
PushVolumes | Add the specified volumes to the end of the volume array for this UDO |
RedisplayObject | Redisplays the object in all views. |
RemoveViewDependency | Remove dependency on all views from an object. |
SetAreas | Sets all of the areas stored with this UDO |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetDoubles | Sets all of the doubles stored with this UDO |
SetIntegers | Sets all of the integers stored with this UDO |
SetLengths | Sets all of the lengths stored with this UDO |
SetLinks | Sets all of the links with the given link type stored with this UDO. |
SetName | Sets the custom name of the object. |
SetNameLocation | Sets the location of the object’s name. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetStrings | Sets all of the strings stored with this UDO |
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. |
SetVolumes | Sets all of the volumes stored with this UDO |
Unblank | Unblanks the object. |
Unhighlight | Unhighlights the object. |
Enumerations¶
UserDefinedObjectLinkStatus Enumeration | Status of the object linked to a NXOpen.Features.UserDefinedObjectFeature |
UserDefinedObjectLinkType Enumeration | Available link types for a NXOpen.Features.UserDefinedObjectFeature . |
Structs¶
UserDefinedObjectLinkDefinition_Struct Struct | Contains the linked object and it’s status along with the type of link. |
Property Detail¶
ClassName¶
-
UserDefinedObject.
ClassName
¶ Returns the class name of this UDO
-------------------------------------
Getter Method
Signature
ClassName()
Returns: The name of the class for this UDO Return type: str New in version NX5.0.0.
License requirements: None.
IsOccurrence¶
-
UserDefinedObject.
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¶
-
UserDefinedObject.
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¶
-
UserDefinedObject.
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¶
-
UserDefinedObject.
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¶
-
UserDefinedObject.
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¶
-
UserDefinedObject.
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.
UserDefinedClass¶
-
UserDefinedObject.
UserDefinedClass
¶ Returns or sets the
NXOpen.UserDefinedObjects.UserDefinedClass
for this UDO-------------------------------------
Getter Method
Signature
UserDefinedClass()
Returns: The class of this UDO Return type: NXOpen.UserDefinedObjects.UserDefinedClass
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UserDefinedClass(userDefinedClass)
Parameters: userDefinedClass ( NXOpen.UserDefinedObjects.UserDefinedClass
) – The new class for this UDONew in version NX5.0.0.
License requirements: None.
Method Detail¶
ClearUserDefinedObjectStatus¶
-
UserDefinedObject.
ClearUserDefinedObjectStatus
¶ Clears the out of data indicator (status) of this UDO
Signature
ClearUserDefinedObjectStatus()
New in version NX5.0.0.
License requirements: None.
FindObject¶
-
UserDefinedObject.
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.
GetAreas¶
-
UserDefinedObject.
GetAreas
¶ Overloaded method GetAreas
GetAreas()
GetAreas(offset, length)
-------------------------------------
Gets all of the areas stored with this UDO
Signature
GetAreas()
Returns: Array of areas stored with this UDO Return type: list of float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the areas stored in the specified range with this UDO
Signature
GetAreas(offset, length)
Parameters: - offset (int) – Index into the array of areas at the start of the returned range. Valid values are 0 through (number of areas in the udo - 1) and -(number of areas in the udo) through -1. If the offset is negative, it is used to count back from the end of the area array. Therefore using -1 or (number of areas in the udo -1) for the offset will give the same result.
- length (int) – The number of areas you wish to get
Returns: Array of areas stored within the specified
range of the area array for this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
-------------------------------------
GetDoubles¶
-
UserDefinedObject.
GetDoubles
¶ Overloaded method GetDoubles
GetDoubles()
GetDoubles(offset, length)
-------------------------------------
Gets all of the doubles stored with this UDO
Signature
GetDoubles()
Returns: Array of doubles stored with this UDO Return type: list of float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the doubles stored in the specified range with this UDO
Signature
GetDoubles(offset, length)
Parameters: - offset (int) – Index into the array of doubles at the start of the returned range. Valid values are 0 through (number of doubles in the udo - 1) and -(number of doubles in the udo) through -1. If the offset is negative, it is used to count back from the end of the double array. Therefore using -1 or (number of doubles in the udo -1) for the offset will give the same result.
- length (int) – The number of doubles you wish to get
Returns: Array of doubles stored within the specified
range of the double array for this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
-------------------------------------
GetIntegers¶
-
UserDefinedObject.
GetIntegers
¶ Overloaded method GetIntegers
GetIntegers()
GetIntegers(offset, length)
-------------------------------------
Gets all of the integers stored with this UDO
Signature
GetIntegers()
Returns: Array of integers stored with this UDO Return type: list of int New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the integers stored in the specified range with this UDO
Signature
GetIntegers(offset, length)
Parameters: - offset (int) – Index into the array of integers at the start of the returned range. Valid values are 0 through (number of integers in the udo - 1) and -(number of integers in the udo) through -1. If the offset is negative, it is used to count back from the end of the integer array. Therefore using -1 or (number of integers in the udo -1) for the offset will give the same result.
- length (int) – The number of integers you wish to get
Returns: Array of integers stored within the specified
range of the integer array for this UDO :rtype: list of int
New in version NX5.0.0.
License requirements: None.
-------------------------------------
GetLengths¶
-
UserDefinedObject.
GetLengths
¶ Overloaded method GetLengths
GetLengths()
GetLengths(offset, length)
-------------------------------------
Gets all of the lengths stored with this UDO
Signature
GetLengths()
Returns: Array of lengths stored with this UDO Return type: list of float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the lengths stored in the specified range with this UDO
Signature
GetLengths(offset, length)
Parameters: - offset (int) – Index into the array of lengths at the start of the returned range. Valid values are 0 through (number of lengths in the udo - 1) and -(number of lengths in the udo) through -1. If the offset is negative, it is used to count back from the end of the length array. Therefore using -1 or (number of lengths in the udo -1) for the offset will give the same result.
- length (int) – The number of lengths you wish to get
Returns: Array of lengths stored within the specified
range of the length array for this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
-------------------------------------
GetLinks¶
-
UserDefinedObject.
GetLinks
¶ Overloaded method GetLinks
GetLinks(linkType)
GetLinks(linkType, offset, length)
-------------------------------------
Gets all links with the given link type that are stored with this UDO
Signature
GetLinks(linkType)
Parameters: linkType ( NXOpen.UserDefinedObjects.UserDefinedObjectLinkType
) – The type of links you wish to getReturns: Array of links (with the given link type) stored with this UDO Return type: list of NXOpen.UserDefinedObjects.UserDefinedObjectLinkDefinition_Struct
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the links with the given link type that are stored in the specified range with this UDO
Signature
GetLinks(linkType, offset, length)
Parameters: - linkType (
NXOpen.UserDefinedObjects.UserDefinedObjectLinkType
) – The type of links you wish to get - offset (int) – Index into the array of links (with the given link type) at the start of the returned range. Valid values are 0 through (number of links of the given type in the udo - 1) and -(number of links of the given type in the udo) through -1. If the offset is negative, it is used to count back from the end of the link array. Therefore using -1 or (number of links of the given link type in the udo -1) for the offset will give the same result.
- length (int) – The number of links (with the given link type) you wish to get
Returns: Array of links stored within the specified
range of the link type’s link array for this UDO :rtype: list of
NXOpen.UserDefinedObjects.UserDefinedObjectLinkDefinition_Struct
New in version NX5.0.0.
License requirements: None.
-------------------------------------
GetStrings¶
-
UserDefinedObject.
GetStrings
¶ Overloaded method GetStrings
GetStrings()
GetStrings(offset, length)
-------------------------------------
Gets all of the strings stored with this UDO
Signature
GetStrings()
Returns: Array of strings stored with this UDO Return type: list of str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the strings stored in the specified range with this UDO
Signature
GetStrings(offset, length)
Parameters: - offset (int) – Index into the array of strings at the start of the returned range. Valid values are 0 through (number of strings in the udo - 1) and -(number of strings in the udo) through -1. If the offset is negative, it is used to count back from the end of the string array. Therefore using -1 or (number of strings in the udo -1) for the offset will give the same result.
- length (int) – The number of strings you wish to get
Returns: Array of strings stored within the specified
range of the string array for this UDO :rtype: list of str
New in version NX5.0.0.
License requirements: None.
-------------------------------------
GetUserDefinedObjectFeature¶
-
UserDefinedObject.
GetUserDefinedObjectFeature
¶ Gets the
NXOpen.Features.UserDefinedObjectFeature
associated with this UDO, if there isn’t an associated feature, None is returnedSignature
GetUserDefinedObjectFeature()
Returns: The UserDefinedObjectFeature associated this UDO Return type: NXOpen.Features.UserDefinedObjectFeature
New in version NX5.0.0.
License requirements: None.
GetUserDefinedObjectStatus¶
-
UserDefinedObject.
GetUserDefinedObjectStatus
¶ Gets the out of date indicator (status) of this UDO
Signature
GetUserDefinedObjectStatus()
Returns: The status of this UDO 0 - The UDO is up to date 1 - Out of date due to addition or deletion of links to the UDO 2 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method 3 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method 4 - Out of date due to deletion of associated (linked) objects in the absence of a UDO method 5 - Out of date due to addition or deletion of links to the UDO AND deletion of associated (linked) objects in the absence of a UDO method 6 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method 7 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method :rtype: int
New in version NX5.0.0.
License requirements: None.
GetVolumes¶
-
UserDefinedObject.
GetVolumes
¶ Overloaded method GetVolumes
GetVolumes()
GetVolumes(offset, length)
-------------------------------------
Gets all of the volumes stored with this UDO
Signature
GetVolumes()
Returns: Array of volumes stored with this UDO Return type: list of float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Gets the volumes stored in the specified range with this UDO
Signature
GetVolumes(offset, length)
Parameters: - offset (int) – Index into the array of volumes at the start of the returned range. Valid values are 0 through (number of volumes in the udo - 1) and -(number of volumes in the udo) through -1. If the offset is negative, it is used to count back from the end of the volume array. Therefore using -1 or (number of volumes in the udo -1) for the offset will give the same result.
- length (int) – The number of volumes you wish to get
Returns: Array of volumes stored within the specified
range of the volume array for this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
-------------------------------------
PopAreas¶
-
UserDefinedObject.
PopAreas
¶ Removes the areas stored at the end of the area array for this UDO, and returns them in an array
Signature
PopAreas(numAreas)
Parameters: numAreas (int) – Returns: Array of areas that have been removed from this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
PopDoubles¶
-
UserDefinedObject.
PopDoubles
¶ Removes the doubles stored at the end of the double array for this UDO, and returns them in an array
Signature
PopDoubles(numDoubles)
Parameters: numDoubles (int) – Returns: Array of doubles that have been removed from this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
PopIntegers¶
-
UserDefinedObject.
PopIntegers
¶ Removes the integers stored at the end of the integer array for this UDO, and returns them in an array
Signature
PopIntegers(numIntegers)
Parameters: numIntegers (int) – Returns: Array of integers that have been removed from this UDO :rtype: list of int
New in version NX5.0.0.
License requirements: None.
PopLengths¶
-
UserDefinedObject.
PopLengths
¶ Removes the lengths stored at the end of the length array for this UDO, and returns them in an array
Signature
PopLengths(numLengths)
Parameters: numLengths (int) – Returns: Array of lengths that have been removed from this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
PopLinks¶
-
UserDefinedObject.
PopLinks
¶ Removes the links stored at the end of the given link type’s link array for this UDO, and returns them in an array
Signature
PopLinks(linkType, numLinks)
Parameters: - linkType (
NXOpen.UserDefinedObjects.UserDefinedObjectLinkType
) – The type of links you wish to remove - numLinks (int) –
Returns: Array of links (with the given link type) that have been
removed from this UDO :rtype: list of
NXOpen.UserDefinedObjects.UserDefinedObjectLinkDefinition_Struct
New in version NX5.0.0.
License requirements: None.
- linkType (
PopStrings¶
-
UserDefinedObject.
PopStrings
¶ Removes the strings stored at the end of the string array for this UDO, and returns them in an array
Signature
PopStrings(numStrings)
Parameters: numStrings (int) – Returns: Array of strings that have been removed from this UDO :rtype: list of str
New in version NX5.0.0.
License requirements: None.
PopVolumes¶
-
UserDefinedObject.
PopVolumes
¶ Removes the volumes stored at the end of the volume array for this UDO, and returns them in an array
Signature
PopVolumes(numVolumes)
Parameters: numVolumes (int) – Returns: Array of volumes that have been removed from this UDO :rtype: list of float
New in version NX5.0.0.
License requirements: None.
Print¶
-
UserDefinedObject.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
PushDoubles¶
-
UserDefinedObject.
PushDoubles
¶ Add the specified doubles to the end of the double array for this UDO
Signature
PushDoubles(doubles)
Parameters: doubles (list of float) – Array of new doubles to add to this UDO. This routine is cumulutive, and will not remove any doubles already stored with the UDO. It simply adds these new doubles to the end of the existing double array and increases the total number of doubles stored with the UDO New in version NX5.0.0.
License requirements: None.
PushIntegers¶
-
UserDefinedObject.
PushIntegers
¶ Add the specified integers to the end of the integer array for this UDO
Signature
PushIntegers(integers)
Parameters: integers (list of int) – Array of new integers to add to this UDO. This routine is cumulutive, and will not remove any integers already stored with the UDO. It simply adds these new integers to the end of the existing integer array and increases the total number of integers stored with the UDO New in version NX5.0.0.
License requirements: None.
PushLengths¶
-
UserDefinedObject.
PushLengths
¶ Add the specified lengths to the end of the length array for this UDO
Signature
PushLengths(lengths)
Parameters: lengths (list of float) – Array of new lengths to add to this UDO. This routine is cumulutive, and will not remove any lengths already stored with the UDO. It simply adds these new lengths to the end of the existing length array and increases the total number of lengths stored with the UDO New in version NX5.0.0.
License requirements: None.
PushLinks¶
-
UserDefinedObject.
PushLinks
¶ Add the specified links to the end of the given link type’s link array for this UDO
Signature
PushLinks(linkType, links)
Parameters: - linkType (
NXOpen.UserDefinedObjects.UserDefinedObjectLinkType
) – The type of links you wish to add - links (list of
NXOpen.UserDefinedObjects.UserDefinedObjectLinkDefinition_Struct
) – Array of new links (with the given link type) to add to this UDO. This routine is cumulutive, and will not remove any links already stored with the UDO. It simply adds these new links to the end of the existing link array for the given link type and increases the total number of links of the given type stored with the UDO
New in version NX5.0.0.
License requirements: None.
- linkType (
PushStrings¶
-
UserDefinedObject.
PushStrings
¶ Add the specified strings to the end of the string array for this UDO
Signature
PushStrings(strings)
Parameters: strings (list of str) – Array of new strings to add to this UDO. This routine is cumulutive, and will not remove any strings already stored with the UDO. It simply adds these new strings to the end of the existing string array and increases the total number of strings stored with the UDO NOTE: The full Unicode character set is not supported for this parameter. New in version NX5.0.0.
License requirements: None.
PushVolumes¶
-
UserDefinedObject.
PushVolumes
¶ Add the specified volumes to the end of the volume array for this UDO
Signature
PushVolumes(volumes)
Parameters: volumes (list of float) – Array of new volumes to add to this UDO. This routine is cumulutive, and will not remove any volumes already stored with the UDO. It simply adds these new volumes to the end of the existing volume array and increases the total number of volumes stored with the UDO New in version NX5.0.0.
License requirements: None.
SetAreas¶
-
UserDefinedObject.
SetAreas
¶ Overloaded method SetAreas
SetAreas(areas)
SetAreas(offset, length, areas)
-------------------------------------
Sets all of the areas stored with this UDO
Signature
SetAreas(areas)
Parameters: areas (list of float) – New Array of areas stored with this UDO New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the areas stored with this UDO in the specified range with a new array of areas
Signature
SetAreas(offset, length, areas)
Parameters: - offset (int) – Index into the array of areas at the start of the range you wish to cut and replace. Valid values are 0 through (number of areas in the udo - 1) and -(number of areas in the udo) through -1. If the offset is negative, it is used to count back from the end of the area array. Therefore using -1 or (number of areas in the udo -1) for the offset will give the same result.
- length (int) – The number of areas in the range you wish to cut
- areas (list of float) – Array of areas to paste in place of the specified range.
New in version NX5.0.0.
License requirements: None.
-------------------------------------
SetDoubles¶
-
UserDefinedObject.
SetDoubles
¶ Overloaded method SetDoubles
SetDoubles(doubles)
SetDoubles(offset, length, doubles)
-------------------------------------
Sets all of the doubles stored with this UDO
Signature
SetDoubles(doubles)
Parameters: doubles (list of float) – New Array of doubles stored with this UDO New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the doubles stored with this UDO in the specified range with a new array of doubles
Signature
SetDoubles(offset, length, doubles)
Parameters: - offset (int) – Index into the array of doubles at the start of the range you wish to cut and replace. Valid values are 0 through (number of doubles in the udo - 1) and -(number of doubles in the udo) through -1. If the offset is negative, it is used to count back from the end of the double array. Therefore using -1 or (number of doubles in the udo -1) for the offset will give the same result.
- length (int) – The number of doubles in the range you wish to cut
- doubles (list of float) – Array of doubles to paste in place of the specified range.
New in version NX5.0.0.
License requirements: None.
-------------------------------------
SetIntegers¶
-
UserDefinedObject.
SetIntegers
¶ Overloaded method SetIntegers
SetIntegers(integers)
SetIntegers(offset, length, integers)
-------------------------------------
Sets all of the integers stored with this UDO
Signature
SetIntegers(integers)
Parameters: integers (list of int) – New Array of integers stored with this UDO New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the integers stored with this UDO in the specified range with a new array of integers
Signature
SetIntegers(offset, length, integers)
Parameters: - offset (int) – Index into the array of integers at the start of the range you wish to cut and replace. Valid values are 0 through (number of integers in the udo - 1) and -(number of integers in the udo) through -1. If the offset is negative, it is used to count back from the end of the integer array. Therefore using -1 or (number of integers in the udo -1) for the offset will give the same result.
- length (int) – The number of integers in the range you wish to cut
- integers (list of int) – Array of integers to paste in place of the specified range.
New in version NX5.0.0.
License requirements: None.
-------------------------------------
SetLengths¶
-
UserDefinedObject.
SetLengths
¶ Overloaded method SetLengths
SetLengths(lengths)
SetLengths(offset, length, lengths)
-------------------------------------
Sets all of the lengths stored with this UDO
Signature
SetLengths(lengths)
Parameters: lengths (list of float) – New Array of lengths stored with this UDO New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the lengths stored with this UDO in the specified range with a new array of lengths
Signature
SetLengths(offset, length, lengths)
Parameters: - offset (int) – Index into the array of lengths at the start of the range you wish to cut and replace. Valid values are 0 through (number of lengths in the udo - 1) and -(number of lengths in the udo) through -1. If the offset is negative, it is used to count back from the end of the length array. Therefore using -1 or (number of lengths in the udo -1) for the offset will give the same result.
- length (int) – The number of lengths in the range you wish to cut
- lengths (list of float) – Array of lengths to paste in place of the specified range.
New in version NX5.0.0.
License requirements: None.
-------------------------------------
SetLinks¶
-
UserDefinedObject.
SetLinks
¶ Overloaded method SetLinks
SetLinks(linkType, links)
SetLinks(linkType, offset, length, links)
-------------------------------------
Sets all of the links with the given link type stored with this UDO. If you already had objects linked to the UDO via the specified link type, this operation will over-write them with the newly specified links.
Signature
SetLinks(linkType, links)
Parameters: - linkType (
NXOpen.UserDefinedObjects.UserDefinedObjectLinkType
) – The type of links you wish to set - links (list of
NXOpen.UserDefinedObjects.UserDefinedObjectLinkDefinition_Struct
) – New Array of links (with the given link type) stored with this UDO
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the links of the given link type stored with this UDO in the specified range with a new array of links
Signature
SetLinks(linkType, offset, length, links)
Parameters: - linkType (
NXOpen.UserDefinedObjects.UserDefinedObjectLinkType
) – The type of links you wish to set - offset (int) – Index into the array of links (with the given link type) at the start of the range you wish to cut and replace. Valid values are 0 through (number of links with the given link type in the udo - 1) and -(number of links with the given link type in the udo) through -1. If the offset is negative, it is used to count back from the end of the link array. Therefore using -1 or (number of links with the given link type in the udo -1) for the offset will give the same result.
- length (int) – The number of links (with the given link type) in the range you wish to cut
- links (list of
NXOpen.UserDefinedObjects.UserDefinedObjectLinkDefinition_Struct
) – Array of links (with the given link type) to paste in place of the specified range.
New in version NX5.0.0.
License requirements: None.
-------------------------------------
SetName¶
-
UserDefinedObject.
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.
SetStrings¶
-
UserDefinedObject.
SetStrings
¶ Overloaded method SetStrings
SetStrings(strings)
SetStrings(offset, length, strings)
-------------------------------------
Sets all of the strings stored with this UDO
Signature
SetStrings(strings)
Parameters: strings (list of str) – New Array of strings stored with this UDO NOTE: The full Unicode character set is not supported for this parameter. New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the strings stored with this UDO in the specified range with a new array of strings
Signature
SetStrings(offset, length, strings)
Parameters: - offset (int) – Index into the array of strings at the start of the range you wish to cut and replace. Valid values are 0 through (number of strings in the udo - 1) and -(number of strings in the udo) through -1. If the offset is negative, it is used to count back from the end of the string array. Therefore using -1 or (number of strings in the udo -1) for the offset will give the same result.
- length (int) – The number of strings in the range you wish to cut
- strings (list of str) – Array of strings to paste in place of the specified range. NOTE: The full Unicode character set is not supported for this parameter.
New in version NX5.0.0.
License requirements: None.
-------------------------------------
SetVolumes¶
-
UserDefinedObject.
SetVolumes
¶ Overloaded method SetVolumes
SetVolumes(volumes)
SetVolumes(offset, length, volumes)
-------------------------------------
Sets all of the volumes stored with this UDO
Signature
SetVolumes(volumes)
Parameters: volumes (list of float) – New Array of volumes stored with this UDO New in version NX5.0.0.
License requirements: None.
-------------------------------------
Replaces the volumes stored with this UDO in the specified range with a new array of volumes
Signature
SetVolumes(offset, length, volumes)
Parameters: - offset (int) – Index into the array of volumes at the start of the range you wish to cut and replace. Valid values are 0 through (number of volumes in the udo - 1) and -(number of volumes in the udo) through -1. If the offset is negative, it is used to count back from the end of the volume array. Therefore using -1 or (number of volumes in the udo -1) for the offset will give the same result.
- length (int) – The number of volumes in the range you wish to cut
- volumes (list of float) – Array of volumes to paste in place of the specified range.
New in version NX5.0.0.
License requirements: None.
-------------------------------------