DesignElementRevision Class

class NXOpen.PDM.DesignElementRevision

Bases: NXOpen.PDM.ModelElementRevision

Represents the design element revision in the database.

An instance of this class can be obtained from the NXOpen.Assemblies.Component.

Instance of this class can not be created

New in version NX8.5.0.

Properties

Property	Description
Category	Returns the category for design element.
DesignPart	Returns the part of the underlying design element.
EffectivityFormula	Returns the formula string that represents the effectivity of this object in database.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Modified	Returns whether the selected NXOpen.PDM.DesignElementRevision is modified in the session.
Name	Returns the custom name of the object.
OwningCollaborativeDesign	Returns the owning NXOpen.CollaborativeDesign.
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
Create	Creates an attribute group for a NXOpen.PDM.IAttributeGroupOwner, based on an attribute group type.
CreateAttributeGroupReviseBuilder	Creates a NXOpen.PDM.AttributeGroupReviseBuilder object.
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.
GetAttributeGroupDescriptions	Returns the NXOpen.PDM.AttributeGroupDescription objects representing the attribute group types supported by this object.
GetAttributeGroups	Returns the NXOpen.PDM.AttributeGroup objects owned by this object.
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.
GetDesignSubordinateRevisions	Get the immediate child NXOpen.PDM.DesignSubordinateRevision objects.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetMemberPartitions	Get all the partitions of this model element revision.
GetOverridePart	Get the override part of this model element revision if it has any.
GetPositionStatus	Gets positioning status of design element.
GetPositioningGroups	Gets all positioning group which are associated with this design element.
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.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetTransform	Get the transform.
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.
IsAbsolutelyPositioned	Determine whether this design element is absolutely positioned or not.
IsExcludedFromSpatialSearch	Determines whether this model element revision is excluded from spatial search.
IsMemberOfPositioningGroup	Determine whether this design element is part of positioning group or not.
Print	Prints a representation of this object to the system log file.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetExcludeFromSpatialSearch	Set or unset this model element revision from exclusion from spatial search.
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.

Enumerations

DesignElementRevisionDesignElementCategory Enumeration

Represents the category for this design element revision.

Property Detail

Category

DesignElementRevision.Category

Returns the category for design element.

Category can be unknown if the design element is new and does not yet exist in database.

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

Getter Method

Signature Category()

Returns: Return type:NXOpen.PDM.DesignElementRevisionDesignElementCategory

New in version NX8.5.0.

License requirements: None.

DesignPart

DesignElementRevision.DesignPart

Returns the part of the underlying design element.

This can be None for a promissory design element.

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

Getter Method

Signature DesignPart()

Returns: Return type:NXOpen.Part

New in version NX8.5.0.

License requirements: None.

IsOccurrence

DesignElementRevision.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

DesignElementRevision.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.

Modified

DesignElementRevision.Modified

Returns whether the selected NXOpen.PDM.DesignElementRevision is modified in the session.

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

Getter Method

Signature Modified()

Returns:Whether the selected NXOpen.PDM.DesignElementRevision is modified

in the session. :rtype: bool

New in version NX8.5.3.

License requirements: None.

Name

DesignElementRevision.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

DesignElementRevision.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

DesignElementRevision.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

DesignElementRevision.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

Create

DesignElementRevision.Create

Creates an attribute group for a NXOpen.PDM.IAttributeGroupOwner, based on an attribute group type.

An attribute group type is represented by an NXOpen.PDM.AttributeGroupDescription.

Signature Create(attributeGroupDescription)

Parameters:attributeGroupDescription (NXOpen.PDM.AttributeGroupDescription) – Returns:The new attribute group. Return type:NXOpen.PDM.AttributeGroup

New in version NX9.0.0.

License requirements: None.

CreateAttributeGroupReviseBuilder

DesignElementRevision.CreateAttributeGroupReviseBuilder

Creates a NXOpen.PDM.AttributeGroupReviseBuilder object.

The builder creates a revision for each attribute group in the input list of existing attribute groups.

Signature CreateAttributeGroupReviseBuilder(attributeGroups)

Parameters:attributeGroups (list of NXOpen.PDM.AttributeGroup) – Returns: Return type:NXOpen.PDM.AttributeGroupReviseBuilder

New in version NX9.0.0.

License requirements: None.

FindObject

DesignElementRevision.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.

GetAttributeGroupDescriptions

DesignElementRevision.GetAttributeGroupDescriptions

Returns the NXOpen.PDM.AttributeGroupDescription objects representing the attribute group types supported by this object.

Signature GetAttributeGroupDescriptions()

Returns: Return type:list of NXOpen.PDM.AttributeGroupDescription

New in version NX9.0.0.

License requirements: None.

GetAttributeGroups

DesignElementRevision.GetAttributeGroups

Returns the NXOpen.PDM.AttributeGroup objects owned by this object.

Signature GetAttributeGroups()

Returns: Return type:list of NXOpen.PDM.AttributeGroup

New in version NX9.0.0.

License requirements: None.

GetDesignSubordinateRevisions

DesignElementRevision.GetDesignSubordinateRevisions

Get the immediate child NXOpen.PDM.DesignSubordinateRevision objects.

This will return None.for non subordinate design element.

Signature GetDesignSubordinateRevisions()

Returns: Return type:list of NXOpen.PDM.DesignSubordinateRevision

New in version NX8.5.0.

License requirements: None.

GetTransform

DesignElementRevision.GetTransform

Get the transform.

Note: The translation component is in meters.

Signature GetTransform()

Returns:a tuple Return type:A tuple consisting of (orientation, positionInMeters). orientation is a NXOpen.Matrix3x3. positionInMeters is a NXOpen.Point3d.

New in version NX8.5.0.

License requirements: None.

Print

DesignElementRevision.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

DesignElementRevision.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.