ValidatorOptions Class

class NXOpen.Validate.ValidatorOptions

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Contains information about run options of check-mate checking process.

New in version NX7.5.0.

Properties

Property Description
AutoDisplayResults Returns or sets the configuration of auto display results
ExcludeNonOwnerParts Returns or sets the configuration of excluding parts not owned by the user.
ExcludeReadonlyParts Returns or sets the configuration of excluding read-only parts.
GenerateCheckFlag Returns or sets the configuration of generating check flag if checking results are PASS
GenerateLogFile Returns or sets the configuration of generating log file after checking.
LogFileDirectory Returns or sets the configuration of log file directory where the log file will be saved.
LogFileMode Returns or sets the configuration of log file mode how to generate the log files.
ResultsAutoUpdate Returns or sets the configuration of results auto update when work part change
SavePartFile Returns or sets the configuration of saving part file after checking finished.
SaveResultInPart Returns or sets the configuration of saving check results into part file.
SaveResultInTeamcenter Returns or sets the configuration of saving check results into Teamcenter.
SkipChecking Returns or sets the configuration of skip checking based on result up-to-date status.
SkipCheckingDontLoadPart Returns or sets the configuration of skipping checking without loading parts
SkipOverriddenResultOption Returns or sets the configuration of skip checking based on result overriden state.
StopOnError Returns or sets the configuration of stopping checking process on error status.
StopOnWarning Returns or sets the configuration of stopping checking on warning status.
Tag Returns the Tag for this object.
TreatWarningAsFail Returns or sets the configuration of treating warning status as fail status.

Methods

Method Description
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AutoDisplayResults

ValidatorOptions.AutoDisplayResults

Returns or sets the configuration of auto display results

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

Getter Method

Signature AutoDisplayResults

Returns:
Return type:NXOpen.Validate.ValidatorOptionsResultsDisplayModeTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature AutoDisplayResults

Parameters:displayResults (NXOpen.Validate.ValidatorOptionsResultsDisplayModeTypes) –

New in version NX7.5.0.

License requirements: None.

ExcludeNonOwnerParts

ValidatorOptions.ExcludeNonOwnerParts

Returns or sets the configuration of excluding parts not owned by the user.

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

Getter Method

Signature ExcludeNonOwnerParts

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ExcludeNonOwnerParts

Parameters:excludeNonOwnerParts (bool) –

New in version NX7.5.0.

License requirements: None.

ExcludeReadonlyParts

ValidatorOptions.ExcludeReadonlyParts

Returns or sets the configuration of excluding read-only parts.

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

Getter Method

Signature ExcludeReadonlyParts

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ExcludeReadonlyParts

Parameters:excludeReadonlyParts (bool) – checksum of parameter

New in version NX7.5.0.

License requirements: None.

GenerateCheckFlag

ValidatorOptions.GenerateCheckFlag

Returns or sets the configuration of generating check flag if checking results are PASS

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

Getter Method

Signature GenerateCheckFlag

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature GenerateCheckFlag

Parameters:generateCheckFlag (bool) –

New in version NX7.5.0.

License requirements: None.

GenerateLogFile

ValidatorOptions.GenerateLogFile

Returns or sets the configuration of generating log file after checking.

If True, log file will be generated.

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

Getter Method

Signature GenerateLogFile

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature GenerateLogFile

Parameters:generateLogFile (bool) –

New in version NX7.5.0.

License requirements: None.

LogFileDirectory

ValidatorOptions.LogFileDirectory

Returns or sets the configuration of log file directory where the log file will be saved.

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

Getter Method

Signature LogFileDirectory

Returns:
Return type:str

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LogFileDirectory

Parameters:logFileDirectory (str) –

New in version NX7.5.0.

License requirements: None.

LogFileMode

ValidatorOptions.LogFileMode

Returns or sets the configuration of log file mode how to generate the log files.

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

Getter Method

Signature LogFileMode

Returns:
Return type:NXOpen.Validate.ValidatorOptionsLogModeTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LogFileMode

Parameters:logFileMode (NXOpen.Validate.ValidatorOptionsLogModeTypes) –

New in version NX7.5.0.

License requirements: None.

ResultsAutoUpdate

ValidatorOptions.ResultsAutoUpdate

Returns or sets the configuration of results auto update when work part change

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

Getter Method

Signature ResultsAutoUpdate

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ResultsAutoUpdate

Parameters:autoUpdate (bool) –

New in version NX7.5.0.

License requirements: None.

SavePartFile

ValidatorOptions.SavePartFile

Returns or sets the configuration of saving part file after checking finished.

If True, part file will be saved.

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

Getter Method

Signature SavePartFile

Returns:
Return type:NXOpen.Validate.ValidatorOptionsSaveModeTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SavePartFile

Parameters:savePartFile (NXOpen.Validate.ValidatorOptionsSaveModeTypes) –

New in version NX7.5.0.

License requirements: None.

SaveResultInPart

ValidatorOptions.SaveResultInPart

Returns or sets the configuration of saving check results into part file.

If True, results will be saved in part file after checking finished.

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

Getter Method

Signature SaveResultInPart

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SaveResultInPart

Parameters:saveResultInPart (bool) – checksum of parameter

New in version NX7.5.0.

License requirements: None.

SaveResultInTeamcenter

ValidatorOptions.SaveResultInTeamcenter

Returns or sets the configuration of saving check results into Teamcenter.

If true, results will be saved into Teamcenter. This parameter is for NX Manager mode only

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

Getter Method

Signature SaveResultInTeamcenter

Returns:
Return type:NXOpen.Validate.ValidatorOptionsSaveModeTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SaveResultInTeamcenter

Parameters:saveResultInTeamcenter (NXOpen.Validate.ValidatorOptionsSaveModeTypes) –

New in version NX7.5.0.

License requirements: None.

SkipChecking

ValidatorOptions.SkipChecking

Returns or sets the configuration of skip checking based on result up-to-date status.

If True, checking will be skipped if the results are PASS and up-to-date.

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

Getter Method

Signature SkipChecking

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SkipChecking

Parameters:skipChecking (bool) –

New in version NX7.5.0.

License requirements: None.

SkipCheckingDontLoadPart

ValidatorOptions.SkipCheckingDontLoadPart

Returns or sets the configuration of skipping checking without loading parts

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

Getter Method

Signature SkipCheckingDontLoadPart

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature SkipCheckingDontLoadPart

Parameters:skipCheckingDontLoadPart (bool) –

New in version NX7.5.0.

License requirements: None.

SkipOverriddenResultOption

ValidatorOptions.SkipOverriddenResultOption

Returns or sets the configuration of skip checking based on result overriden state.

If True, checking will be skipped if the results are overridden.

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

Getter Method

Signature SkipOverriddenResultOption

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature SkipOverriddenResultOption

Parameters:skipOverriddenResult (bool) –

New in version NX8.5.0.

License requirements: None.

StopOnError

ValidatorOptions.StopOnError

Returns or sets the configuration of stopping checking process on error status.

If True, stop checking when there is checker returned error status.

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

Getter Method

Signature StopOnError

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature StopOnError

Parameters:stopOnError (bool) – checksum of parameter

New in version NX7.5.0.

License requirements: None.

StopOnWarning

ValidatorOptions.StopOnWarning

Returns or sets the configuration of stopping checking on warning status.

If True, stop checking when there is checker returned warning status.

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

Getter Method

Signature StopOnWarning

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature StopOnWarning

Parameters:stopOnWarning (bool) –

New in version NX7.5.0.

License requirements: None.

TreatWarningAsFail

ValidatorOptions.TreatWarningAsFail

Returns or sets the configuration of treating warning status as fail status.

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

Getter Method

Signature TreatWarningAsFail

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature TreatWarningAsFail

Parameters:treatWarningAsFail (bool) –

New in version NX7.5.0.

License requirements: None.

Method Detail

Validate

ValidatorOptions.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.