QualityTestValue Class¶
-
class
NXOpen.CAE.ModelCheck.
QualityTestValue
¶ Bases:
NXOpen.NXObject
,NXOpen.CAE.ModelCheck.ITestValue
Represents quality test settings of a specified test type
Not to support KF
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
DoTest | Returns or sets an option value indicating whether to do element quality check for this test |
ElementSpecificTestCount | Returns the count of NXOpen.CAE.ModelCheck.ElementSpecificTestValue in this test setting |
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 |
---|---|
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. |
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. |
GetCriteriaValue | Returns the criteria value. |
GetElementReferences | Returns the element reference definitions associated with this test @return |
GetElementSpecificTestByIndex | Returns NXOpen.CAE.ModelCheck.ElementSpecificTestValue of specified index in this test setting @return |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetIsSolverSpecificTest | To know whether this quality test is a solver specific test and a system test @return |
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. |
GetTestType | Returns the test type @return |
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. |
GetValidator | Returns the validator type @return |
HasCriteriaValue | Tells whether there is criteria value associated with this test @return |
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. |
Prints a representation of this object to the system log file. | |
ResetToCustomerDefault | Reset as customer default setting |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetCriteriaValue | Sets the criteria value. |
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¶
DoTest¶
-
QualityTestValue.
DoTest
¶ Returns or sets an option value indicating whether to do element quality check for this test
-------------------------------------
Getter Method
Signature
DoTest()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoTest(doTest)
Parameters: doTest (bool) – New in version NX8.5.0.
License requirements: None.
ElementSpecificTestCount¶
-
QualityTestValue.
ElementSpecificTestCount
¶ Returns the count of
NXOpen.CAE.ModelCheck.ElementSpecificTestValue
in this test setting-------------------------------------
Getter Method
Signature
ElementSpecificTestCount()
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
IsOccurrence¶
-
QualityTestValue.
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¶
-
QualityTestValue.
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¶
-
QualityTestValue.
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¶
-
QualityTestValue.
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¶
-
QualityTestValue.
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¶
-
QualityTestValue.
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¶
FindObject¶
-
QualityTestValue.
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.
GetCriteriaValue¶
-
QualityTestValue.
GetCriteriaValue
¶ Returns the criteria value.
An exception will be thrown if there is no criteria value associated with this test
Signature
GetCriteriaValue(criteriaType)
Parameters: criteriaType ( NXOpen.CAE.ModelCheck.TestValueTypesCriteriaType
) –Returns: a tuple Return type: A tuple consisting of (unit, criteriaValue). unit is a NXOpen.Unit
. criteriaValue is a float.New in version NX8.5.0.
License requirements: None.
GetElementReferences¶
-
QualityTestValue.
GetElementReferences
¶ Returns the element reference definitions associated with this test
Signature
GetElementReferences()
Returns: Return type: list of NXOpen.CAE.ModelCheck.TestValueTypesElementReference_Struct
New in version NX8.5.0.
License requirements: None.
GetElementSpecificTestByIndex¶
-
QualityTestValue.
GetElementSpecificTestByIndex
¶ Returns
NXOpen.CAE.ModelCheck.ElementSpecificTestValue
of specified index in this test settingSignature
GetElementSpecificTestByIndex(index)
Parameters: index (int) – Returns: Return type: NXOpen.CAE.ModelCheck.ElementSpecificTestValue
New in version NX8.5.0.
License requirements: None.
GetIsSolverSpecificTest¶
-
QualityTestValue.
GetIsSolverSpecificTest
¶ To know whether this quality test is a solver specific test and a system test
Signature
GetIsSolverSpecificTest()
Returns: a tuple Return type: A tuple consisting of (isSolverSpecificTest, isSystemTest). isSolverSpecificTest is a bool. isSystemTest is a bool. New in version NX8.5.0.
License requirements: None.
GetTestType¶
-
QualityTestValue.
GetTestType
¶ Returns the test type
Signature
GetTestType()
Returns: Return type: NXOpen.CAE.ModelCheck.TestValueTypesTestType
New in version NX8.5.0.
License requirements: None.
GetValidator¶
-
QualityTestValue.
GetValidator
¶ Returns the validator type
Signature
GetValidator()
Returns: Return type: NXOpen.CAE.ModelCheck.TestValueTypesValidator
New in version NX8.5.0.
License requirements: None.
HasCriteriaValue¶
-
QualityTestValue.
HasCriteriaValue
¶ Tells whether there is criteria value associated with this test
Signature
HasCriteriaValue()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
Print¶
-
QualityTestValue.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
ResetToCustomerDefault¶
-
QualityTestValue.
ResetToCustomerDefault
¶ Reset as customer default setting
Signature
ResetToCustomerDefault()
New in version NX8.5.0.
License requirements: None.
SetCriteriaValue¶
-
QualityTestValue.
SetCriteriaValue
¶ Overloaded method SetCriteriaValue
SetCriteriaValue(criteriaType, criteriaValue, unit)
SetCriteriaValue(criteriaType, criteriaValue, unit)
-------------------------------------
Sets the criteria value. An exception will be thrown if there is no criteria value associated with this test
Signature
SetCriteriaValue(criteriaType, criteriaValue, unit)
Parameters: - criteriaType (
NXOpen.CAE.ModelCheck.TestValueTypesCriteriaType
) – - criteriaValue (float) –
- unit (
NXOpen.Unit
) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Sets the criteria value. An exception will be thrown if there is no criteria value associated with this test
Signature
SetCriteriaValue(criteriaType, criteriaValue, unit)
Parameters: - criteriaType (
NXOpen.CAE.ModelCheck.TestValueTypesCriteriaType
) – - criteriaValue (str) – NOTE: The full Unicode character set is not supported for this parameter.
- unit (
NXOpen.Unit
) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
SetName¶
-
QualityTestValue.
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.