ResultObject Class¶
-
class
NXOpen.Validate.
ResultObject
¶ Bases:
NXOpen.NXObject
Represents a check-mate result object.
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
CategoryName | Returns the category name of check result. |
ClassName | Returns the class name of check result. |
Disabled | Returns the disabled status of check result. |
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 or sets the name of check result |
OutOfDate | Returns the out of date status of check result. |
Override | Returns the override request object of check result |
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. |
Status | Returns or sets the error status of check result |
Tag | Returns the Tag for this object. |
TotalObjectsCount | Returns the total objects count of check result. |
Type | Returns or sets the type of check result |
Methods¶
Method | Description |
---|---|
CreateOverrideBuilder | Creates a NXOpen.Validate.OverrideBuilder @return |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteOverride | Deletes user override request NXOpen.Validate.Override . |
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. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
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, 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. |
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. |
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¶
ResultObjectResultTypes Enumeration | The type of check result |
Property Detail¶
CategoryName¶
-
ResultObject.
CategoryName
¶ Returns the category name of check result.
Return empty if the ResultObject has no this property.
-------------------------------------
Getter Method
Signature
CategoryName()
Returns: the category name of check result Return type: str New in version NX8.5.0.
License requirements: None.
ClassName¶
-
ResultObject.
ClassName
¶ Returns the class name of check result.
Return empty if the ResultObject has no this property.
-------------------------------------
Getter Method
Signature
ClassName()
Returns: the class name of check result Return type: str New in version NX8.5.0.
License requirements: None.
Disabled¶
-
ResultObject.
Disabled
¶ Returns the disabled status of check result.
-------------------------------------
Getter Method
Signature
Disabled()
Returns: the disabled of check result Return type: bool New in version NX8.5.0.
License requirements: None.
IsOccurrence¶
-
ResultObject.
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¶
-
ResultObject.
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¶
-
ResultObject.
Name
¶ Returns or sets the name of check result
-------------------------------------
Getter Method
Signature
Name()
Returns: The name of check result Return type: str New in version NX7.5.0.
Deprecated since version NX9.0.0: Use
NXOpen.NXObject.Name`
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – The name of check result New in version NX7.5.0.
Deprecated since version NX9.0.0: Use
NXOpen.NXObject.Name`
instead.License requirements: None.
OutOfDate¶
-
ResultObject.
OutOfDate
¶ Returns the out of date status of check result.
Returns error code if part is unloaded. Result of unloaded part is assumed up to date. The program may not be able to detect the modifications in the part.
-------------------------------------
Getter Method
Signature
OutOfDate()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
Override¶
-
ResultObject.
Override
¶ Returns the override request object of check result
-------------------------------------
Getter Method
Signature
Override()
Returns: the Override request object of check result Return type: NXOpen.Validate.Override
New in version NX8.5.0.
License requirements: None.
OwningComponent¶
-
ResultObject.
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¶
-
ResultObject.
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¶
-
ResultObject.
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.
Status¶
-
ResultObject.
Status
¶ Returns or sets the error status of check result
-------------------------------------
Getter Method
Signature
Status()
Returns: The error level Return type: NXOpen.ValidationResult
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Status(status)
Parameters: status ( NXOpen.ValidationResult
) – The error levelNew in version NX7.5.0.
License requirements: None.
TotalObjectsCount¶
-
ResultObject.
TotalObjectsCount
¶ Returns the total objects count of check result.
Return zero if the ResultObject has no this property.
-------------------------------------
Getter Method
Signature
TotalObjectsCount()
Returns: the total objects count of check result Return type: int New in version NX8.5.0.
License requirements: None.
Type¶
-
ResultObject.
Type
¶ Returns or sets the type of check result
-------------------------------------
Getter Method
Signature
Type()
Returns: The result type Return type: NXOpen.Validate.ResultObjectResultTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Validate.ResultObjectResultTypes
) – The result typeNew in version NX7.5.0.
License requirements: None.
Method Detail¶
CreateOverrideBuilder¶
-
ResultObject.
CreateOverrideBuilder
¶ Creates a
NXOpen.Validate.OverrideBuilder
Signature
CreateOverrideBuilder(overrideRequest)
Parameters: overrideRequest ( NXOpen.Validate.Override
) –Returns: Return type: NXOpen.Validate.OverrideBuilder
New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
DeleteOverride¶
-
ResultObject.
DeleteOverride
¶ Deletes user override request
NXOpen.Validate.Override
.Signature
DeleteOverride()
New in version NX8.5.0.
License requirements: ug_checkmate (“UG Check Mate”)
FindObject¶
-
ResultObject.
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.