ElementQualitySetting Class

class NXOpen.CAE.ModelCheck.ElementQualitySetting

Bases: NXOpen.NXObject

Represents element quality check settings of a specified solver language. Each solve language has a NXOpen.CAE.ModelCheck.ElementQualitySetting.

To get a quality check criteria value of a specfied quality test for one element, you can call NXOpen.CAE.ModelCheck.ElementQualitySetting.LocateTestDescriptorName() to get the test criteria value name, then call NXOpen.CAE.ModelCheck.ElementQualitySetting.GetQualityValue() to get the criteria value object.

Not to support KF

New in version NX8.5.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.
LimitValueOption Returns or sets the limit value option
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.
TestValueCount Returns the count of NXOpen.CAE.ModelCheck.QualityTestValue in the setting
UseElementSpecificValue Returns or sets an option indicating whether to use element specific quality value for testing

Methods

Method Description
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.
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.
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.
GetQualityValue Returns the test quality value with the specified descriptor name
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.
GetTestValueByIndex Returns the NXOpen.CAE.ModelCheck.QualityTestValue at the specified index in the setting
GetTestValueByType Returns the NXOpen.CAE.ModelCheck.QualityTestValue of a specified NXOpen.CAE.ModelCheck.TestValueTypesTestType
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
LocateTestDescriptorName Returns the name of a quality test value, which is associated with an element for a specified test type
Print Prints a representation of this object to the system log file.
ResetToCustomerDefault Reset the quality check setting as customer default
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.

Enumerations

ElementQualitySettingLimitValue Enumeration indicates how criteria value is defined

Property Detail

IsOccurrence

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

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

LimitValueOption

ElementQualitySetting.LimitValueOption

Returns or sets the limit value option

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

Getter Method

Signature LimitValueOption

Returns:
Return type:NXOpen.CAE.ModelCheck.ElementQualitySettingLimitValue

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature LimitValueOption

Parameters:limitValueOption (NXOpen.CAE.ModelCheck.ElementQualitySettingLimitValue) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Name

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

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

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

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

TestValueCount

ElementQualitySetting.TestValueCount

Returns the count of NXOpen.CAE.ModelCheck.QualityTestValue in the setting

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

Getter Method

Signature TestValueCount

Returns:
Return type:int

New in version NX8.5.0.

License requirements: None.

UseElementSpecificValue

ElementQualitySetting.UseElementSpecificValue

Returns or sets an option indicating whether to use element specific quality value for testing

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

Getter Method

Signature UseElementSpecificValue

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature UseElementSpecificValue

Parameters:useElementSpecificValue (bool) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Method Detail

FindObject

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

GetQualityValue

ElementQualitySetting.GetQualityValue

Returns the test quality value with the specified descriptor name

Signature GetQualityValue(descriptorName)

Parameters:descriptorName (str) –
Returns:
Return type:NXOpen.CAE.ModelCheck.ITestValue

New in version NX8.5.0.

License requirements: None.

GetTestValueByIndex

ElementQualitySetting.GetTestValueByIndex

Returns the NXOpen.CAE.ModelCheck.QualityTestValue at the specified index in the setting

Signature GetTestValueByIndex(index)

Parameters:index (int) –
Returns:
Return type:NXOpen.CAE.ModelCheck.QualityTestValue

New in version NX8.5.0.

License requirements: None.

GetTestValueByType

ElementQualitySetting.GetTestValueByType

Returns the NXOpen.CAE.ModelCheck.QualityTestValue of a specified NXOpen.CAE.ModelCheck.TestValueTypesTestType

Signature GetTestValueByType(testType)

Parameters:testType (NXOpen.CAE.ModelCheck.TestValueTypesTestType) –
Returns:
Return type:NXOpen.CAE.ModelCheck.QualityTestValue

New in version NX8.5.0.

License requirements: None.

LocateTestDescriptorName

ElementQualitySetting.LocateTestDescriptorName

Returns the name of a quality test value, which is associated with an element for a specified test type

Signature LocateTestDescriptorName(element, testType, useElemSpecific)

Parameters:
Returns:
Return type:

str

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Print

ElementQualitySetting.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

ResetToCustomerDefault

ElementQualitySetting.ResetToCustomerDefault

Reset the quality check setting as customer default

Signature ResetToCustomerDefault()

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

SetName

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