nxopen.validate

Interface ValidatorOptions

All Superinterfaces:

IComponentBuilder, Remote, TaggedObject

public interface ValidatorOptions
extends TaggedObject, IComponentBuilder

Contains information about run options of check-mate checking process.
Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValidatorOptions.LogModeTypes The log mode type.
static class	ValidatorOptions.ResultsDisplayModeTypes The results display mode type.
static class	ValidatorOptions.SaveModeTypes The save mode type.

Method Summary

Modifier and Type	Method and Description
ValidatorOptions.ResultsDisplayModeTypes	autoDisplayResults() Returns the configuration of auto display results License requirements: None.
boolean	excludeNonOwnerParts() Returns the configuration of excluding parts not owned by the user.
boolean	excludeReadonlyParts() Returns the configuration of excluding read-only parts.
boolean	generateCheckFlag() Returns the configuration of generating check flag if checking results are PASS License requirements: None.
boolean	generateLogFile() Returns the configuration of generating log file after checking.
String	logFileDirectory() Returns the configuration of log file directory where the log file will be saved.
ValidatorOptions.LogModeTypes	logFileMode() Returns the configuration of log file mode how to generate the log files.
boolean	resultsAutoUpdate() Returns the configuration of results auto update when work part change License requirements: None.
ValidatorOptions.SaveModeTypes	savePartFile() Returns the configuration of saving part file after checking finished.
boolean	saveResultInPart() Returns the configuration of saving check results into part file.
ValidatorOptions.SaveModeTypes	saveResultInTeamcenter() Returns the configuration of saving check results into Teamcenter.
void	setAutoDisplayResults(ValidatorOptions.ResultsDisplayModeTypes displayResults) License requirements: None.
void	setExcludeNonOwnerParts(boolean excludeNonOwnerParts) License requirements: None.
void	setExcludeReadonlyParts(boolean excludeReadonlyParts) License requirements: None.
void	setGenerateCheckFlag(boolean generateCheckFlag) License requirements: None.
void	setGenerateLogFile(boolean generateLogFile) License requirements: None.
void	setLogFileDirectory(String logFileDirectory) License requirements: None.
void	setLogFileMode(ValidatorOptions.LogModeTypes logFileMode) License requirements: None.
void	setResultsAutoUpdate(boolean autoUpdate) License requirements: None.
void	setSavePartFile(ValidatorOptions.SaveModeTypes savePartFile) License requirements: None.
void	setSaveResultInPart(boolean saveResultInPart) License requirements: None.
void	setSaveResultInTeamcenter(ValidatorOptions.SaveModeTypes saveResultInTeamcenter) License requirements: None.
void	setSkipChecking(boolean skipChecking) License requirements: None.
void	setSkipCheckingDontLoadPart(boolean skipCheckingDontLoadPart) License requirements: None.
void	setSkipOverriddenResultOption(boolean skipOverriddenResult) License requirements: None.
void	setStopOnError(boolean stopOnError) License requirements: None.
void	setStopOnWarning(boolean stopOnWarning) License requirements: None.
void	setTreatWarningAsFail(boolean treatWarningAsFail) License requirements: None.
boolean	skipChecking() Returns the configuration of skip checking based on result up-to-date status.
boolean	skipCheckingDontLoadPart() Returns the configuration of skipping checking without loading parts License requirements: None.
boolean	skipOverriddenResultOption() Returns the configuration of skip checking based on result overriden state.
boolean	stopOnError() Returns the configuration of stopping checking process on error status.
boolean	stopOnWarning() Returns the configuration of stopping checking on warning status.
boolean	treatWarningAsFail() Returns the configuration of treating warning status as fail status.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

stopOnError

boolean stopOnError()
             throws NXException,
                    RemoteException

Returns the configuration of stopping checking process on error status. If True, stop checking when there is checker returned error status.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setStopOnError

void setStopOnError(boolean stopOnError)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

stopOnError - checksum of parameter

Throws:

NXException

RemoteException

stopOnWarning

boolean stopOnWarning()
               throws NXException,
                      RemoteException

Returns the configuration of stopping checking on warning status. If True, stop checking when there is checker returned warning status.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setStopOnWarning

void setStopOnWarning(boolean stopOnWarning)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

stopOnWarning -

Throws:

NXException

RemoteException

generateLogFile

boolean generateLogFile()
                 throws NXException,
                        RemoteException

Returns the configuration of generating log file after checking. If True, log file will be generated.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setGenerateLogFile

void setGenerateLogFile(boolean generateLogFile)
                 throws NXException,
                        RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

generateLogFile -

Throws:

NXException

RemoteException

logFileDirectory

String logFileDirectory()
                 throws NXException,
                        RemoteException

Returns the configuration of log file directory where the log file will be saved.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setLogFileDirectory

void setLogFileDirectory(String logFileDirectory)
                  throws NXException,
                         RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

logFileDirectory -

Throws:

NXException

RemoteException

saveResultInPart

boolean saveResultInPart()
                  throws NXException,
                         RemoteException

Returns the configuration of saving check results into part file. If True, results will be saved in part file after checking finished.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setSaveResultInPart

void setSaveResultInPart(boolean saveResultInPart)
                  throws NXException,
                         RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

saveResultInPart - checksum of parameter

Throws:

NXException

RemoteException

saveResultInTeamcenter

ValidatorOptions.SaveModeTypes saveResultInTeamcenter()
                                               throws NXException,
                                                      RemoteException

Returns the configuration of saving check results into Teamcenter. If true, results will be saved into Teamcenter. This parameter is for NX Manager mode only
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setSaveResultInTeamcenter

void setSaveResultInTeamcenter(ValidatorOptions.SaveModeTypes saveResultInTeamcenter)
                        throws NXException,
                               RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

saveResultInTeamcenter -

Throws:

NXException

RemoteException

skipChecking

boolean skipChecking()
              throws NXException,
                     RemoteException

Returns 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.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setSkipChecking

void setSkipChecking(boolean skipChecking)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

skipChecking -

Throws:

NXException

RemoteException

savePartFile

ValidatorOptions.SaveModeTypes savePartFile()
                                     throws NXException,
                                            RemoteException

Returns the configuration of saving part file after checking finished. If True, part file will be saved.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setSavePartFile

void setSavePartFile(ValidatorOptions.SaveModeTypes savePartFile)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

savePartFile -

Throws:

NXException

RemoteException

logFileMode

ValidatorOptions.LogModeTypes logFileMode()
                                   throws NXException,
                                          RemoteException

Returns the configuration of log file mode how to generate the log files.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setLogFileMode

void setLogFileMode(ValidatorOptions.LogModeTypes logFileMode)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

logFileMode -

Throws:

NXException

RemoteException

excludeReadonlyParts

boolean excludeReadonlyParts()
                      throws NXException,
                             RemoteException

Returns the configuration of excluding read-only parts.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setExcludeReadonlyParts

void setExcludeReadonlyParts(boolean excludeReadonlyParts)
                      throws NXException,
                             RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

excludeReadonlyParts - checksum of parameter

Throws:

NXException

RemoteException

excludeNonOwnerParts

boolean excludeNonOwnerParts()
                      throws NXException,
                             RemoteException

Returns the configuration of excluding parts not owned by the user.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setExcludeNonOwnerParts

void setExcludeNonOwnerParts(boolean excludeNonOwnerParts)
                      throws NXException,
                             RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

excludeNonOwnerParts -

Throws:

NXException

RemoteException

generateCheckFlag

boolean generateCheckFlag()
                   throws NXException,
                          RemoteException

Returns the configuration of generating check flag if checking results are PASS
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setGenerateCheckFlag

void setGenerateCheckFlag(boolean generateCheckFlag)
                   throws NXException,
                          RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

generateCheckFlag -

Throws:

NXException

RemoteException

treatWarningAsFail

boolean treatWarningAsFail()
                    throws NXException,
                           RemoteException

Returns the configuration of treating warning status as fail status.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setTreatWarningAsFail

void setTreatWarningAsFail(boolean treatWarningAsFail)
                    throws NXException,
                           RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

treatWarningAsFail -

Throws:

NXException

RemoteException

skipCheckingDontLoadPart

boolean skipCheckingDontLoadPart()
                          throws NXException,
                                 RemoteException

Returns the configuration of skipping checking without loading parts
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setSkipCheckingDontLoadPart

void setSkipCheckingDontLoadPart(boolean skipCheckingDontLoadPart)
                          throws NXException,
                                 RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

skipCheckingDontLoadPart -

Throws:

NXException

RemoteException

autoDisplayResults

ValidatorOptions.ResultsDisplayModeTypes autoDisplayResults()
                                                     throws NXException,
                                                            RemoteException

Returns the configuration of auto display results
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setAutoDisplayResults

void setAutoDisplayResults(ValidatorOptions.ResultsDisplayModeTypes displayResults)
                    throws NXException,
                           RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

displayResults -

Throws:

NXException

RemoteException

resultsAutoUpdate

boolean resultsAutoUpdate()
                   throws NXException,
                          RemoteException

Returns the configuration of results auto update when work part change
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setResultsAutoUpdate

void setResultsAutoUpdate(boolean autoUpdate)
                   throws NXException,
                          RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

autoUpdate -

Throws:

NXException

RemoteException

skipOverriddenResultOption

boolean skipOverriddenResultOption()
                            throws NXException,
                                   RemoteException

Returns the configuration of skip checking based on result overriden state. If True, checking will be skipped if the results are overridden.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setSkipOverriddenResultOption

void setSkipOverriddenResultOption(boolean skipOverriddenResult)
                            throws NXException,
                                   RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

skipOverriddenResult -

Throws:

NXException

RemoteException