RequirementCheck Class¶
-
class
NXOpen.Validate.
RequirementCheck
¶ Bases:
NXOpen.Validation
Represents an NX
NXOpen.Validate.RequirementCheck
object.To create a new instance of this class, use
NXOpen.Validate.RequirementCheckCollection.CreateRequirementCheck()
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
CheckName | Returns or sets the name of requirement check shown in Requirements Validation dialog |
Formula | Returns the formula of requirement check |
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 |
ParentRequirement | Returns or sets the parent NXOpen.Validate.Requirement |
Prototype | Returns the prototype of this object if it is an occurrence. |
Requirement | Returns or sets the requirement path. |
SaveResultsToTeamcenterOption | Returns or sets the Save Results to Teamcenter option |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Add | Add a objects to the validation map |
CreateAttributeIterator | Create an attribute iterator |
Delete | Delete Validation 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 on the object, if any, that satisfy the given iterator |
Evaluate | Manually validate |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAssociatedObjects | Gets associated objects for the check. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetCheckResult | The validation result. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetInitialResult | The initial result. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetKeyType | Get key type |
GetKeys | Get keys |
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. |
GetSuppressed | The suppress state of the validation |
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 |
Information | Information display on a Validation Object |
Lookup | Lookup a objects to the validation map |
LookupInteger | Lookup a integer to the validation map |
LookupNumber | Lookup a real to the validation map |
LookupText | Lookup a text to the validation map |
LookupTime | Lookup a time to the validation map |
Prints a representation of this object to the system log file. | |
Remove | Remove a key from the map |
Replace | Replace objects of a key in the validation map |
SetAssociatedObjects | Specifies or removes associated objects for the check. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetCheckResult | Set the result of validation. |
SetFormula | Sets the formula of requirement check. |
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. |
SetSuppressed | |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUpdateControl | Define the update behavior of the validation object |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
SetUserClassName | Set user class name |
Enumerations¶
RequirementCheckSaveResultsToTeamcenterOptions Enumeration | This enum represents the Save Results to Teamcenter option |
Property Detail¶
CheckName¶
-
RequirementCheck.
CheckName
¶ Returns or sets the name of requirement check shown in Requirements Validation dialog
-------------------------------------
Getter Method
Signature
CheckName
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckName
Parameters: checkName (str) – New in version NX8.5.0.
License requirements: None.
Formula¶
-
RequirementCheck.
Formula
¶ Returns the formula of requirement check
-------------------------------------
Getter Method
Signature
Formula
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
IsOccurrence¶
-
RequirementCheck.
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¶
-
RequirementCheck.
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¶
-
RequirementCheck.
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¶
-
RequirementCheck.
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¶
-
RequirementCheck.
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.
ParentRequirement¶
-
RequirementCheck.
ParentRequirement
¶ Returns or sets the parent
NXOpen.Validate.Requirement
-------------------------------------
Getter Method
Signature
ParentRequirement
Returns: Return type: NXOpen.Validate.Requirement
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParentRequirement
Parameters: parentRequirement ( NXOpen.Validate.Requirement
) –New in version NX8.5.0.
License requirements: None.
Prototype¶
-
RequirementCheck.
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.
SaveResultsToTeamcenterOption¶
-
RequirementCheck.
SaveResultsToTeamcenterOption
¶ Returns or sets the Save Results to Teamcenter option
-------------------------------------
Getter Method
Signature
SaveResultsToTeamcenterOption
Returns: Return type: NXOpen.Validate.RequirementCheckSaveResultsToTeamcenterOptions
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SaveResultsToTeamcenterOption
Parameters: option ( NXOpen.Validate.RequirementCheckSaveResultsToTeamcenterOptions
) –New in version NX8.5.0.
License requirements: None.
Method Detail¶
FindObject¶
-
RequirementCheck.
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.
Print¶
-
RequirementCheck.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetFormula¶
-
RequirementCheck.
SetFormula
¶ Sets the formula of requirement check.
The requirement check will be re-evaluated.
Signature
SetFormula(formula)
Parameters: formula (str) – New in version NX8.5.0.
License requirements: None.
SetName¶
-
RequirementCheck.
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.