Run Class

class NXOpen.PLAS.Run

Bases: NXOpen.PDM.ElementGroup

Represents the Run class.

To create or edit an instance of this class, use NXOpen.PLAS.RunBuilder

New in version NX11.0.1.

Properties

Property Description
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.
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.
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
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.
GetBranches Get the branches in the run.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
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.
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.
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.
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
Print Prints a representation of this object to the system log file.
ReparentBranch Moves branch from one run to another.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
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.
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

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

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

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

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

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

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

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

Run.CreateAttributeGroupReviseBuilder

Overloaded method CreateAttributeGroupReviseBuilder

  • CreateAttributeGroupReviseBuilder(attributeGroups)
  • CreateAttributeGroupReviseBuilder(attributeGroups, keepOriginal, saveAsActionType)

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

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.

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

The builder will do a revise or save-as operation for each attribute group in the input list of existing attribute groups depending on input operation type.

Signature CreateAttributeGroupReviseBuilder(attributeGroups, keepOriginal, saveAsActionType)

Parameters:
Returns:
Return type:

NXOpen.PDM.AttributeGroupReviseBuilder

New in version NX11.0.0.

License requirements: None.

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

FindObject

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

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

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

GetBranches

Run.GetBranches

Get the branches in the run.

Signature GetBranches()

Returns:the collection of branches in the run
Return type:list of NXOpen.PDM.OrderedElementGroup

New in version NX12.0.0.

License requirements: None.

Print

Run.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

ReparentBranch

Run.ReparentBranch

Moves branch from one run to another.

the original branch will be destroyed

Signature ReparentBranch(destinationRun, oldbranch)

Parameters:
Returns:
Return type:

NXOpen.PDM.OrderedElementGroup

New in version NX11.0.1.

License requirements: None.

SetName

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