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

Inheritance diagram for NXOpen.Validate.ValidatorOptions:

Public Types
enum	LogModeTypes { LogPerSession, LogPerPart }
	The log mode type. More...

enum	ResultsDisplayModeTypes { AlwaysDisplay, DisplayIfNotPass, DoNotDisplay }
	The results display mode type. More...

enum	SaveModeTypes { DoNotSave, SaveIfPassed, AlwaysSave }
	The save mode type. More...

Public Member Functions
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Validate.ValidatorOptions.ResultsDisplayModeTypes	AutoDisplayResults `[get, set]`
	Returns or sets the configuration of auto display results More...

unsafe bool	ExcludeNonOwnerParts `[get, set]`
	Returns or sets the configuration of excluding parts not owned by the user. More...

unsafe bool	ExcludeReadonlyParts `[get, set]`
	Returns or sets the configuration of excluding read-only parts. More...

unsafe bool	GenerateCheckFlag `[get, set]`
	Returns or sets the configuration of generating check flag if checking results are PASS More...

unsafe bool	GenerateLogFile `[get, set]`
	Returns or sets the configuration of generating log file after checking. More...

unsafe string	LogFileDirectory `[get, set]`
	Returns or sets the configuration of log file directory where the log file will be saved. More...

unsafe NXOpen.Validate.ValidatorOptions.LogModeTypes	LogFileMode `[get, set]`
	Returns or sets the configuration of log file mode how to generate the log files. More...

unsafe bool	ResultsAutoUpdate `[get, set]`
	Returns or sets the configuration of results auto update when work part change More...

unsafe NXOpen.Validate.ValidatorOptions.SaveModeTypes	SavePartFile `[get, set]`
	Returns or sets the configuration of saving part file after checking finished. More...

unsafe bool	SaveResultInPart `[get, set]`
	Returns or sets the configuration of saving check results into part file. More...

unsafe NXOpen.Validate.ValidatorOptions.SaveModeTypes	SaveResultInTeamcenter `[get, set]`
	Returns or sets the configuration of saving check results into Teamcenter. More...

unsafe bool	SkipChecking `[get, set]`
	Returns or sets the configuration of skip checking based on result up-to-date status. More...

unsafe bool	SkipCheckingDontLoadPart `[get, set]`
	Returns or sets the configuration of skipping checking without loading parts More...

unsafe bool	SkipOverriddenResultOption `[get, set]`
	Returns or sets the configuration of skip checking based on result overriden state. More...

unsafe bool	StopOnError `[get, set]`
	Returns or sets the configuration of stopping checking process on error status. More...

unsafe bool	StopOnWarning `[get, set]`
	Returns or sets the configuration of stopping checking on warning status. More...

unsafe bool	TreatWarningAsFail `[get, set]`
	Returns or sets the configuration of treating warning status as fail status. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.Validate.ValidatorOptions.LogModeTypes

The log mode type.

Enumerator
LogPerSession	Generate log per session
LogPerPart	Generate log per part

enum NXOpen.Validate.ValidatorOptions.ResultsDisplayModeTypes

The results display mode type.

Enumerator
AlwaysDisplay	Always display results.
DisplayIfNotPass	Display results if the checking is not passed.
DoNotDisplay	Do not display results

enum NXOpen.Validate.ValidatorOptions.SaveModeTypes

The save mode type.

Enumerator
DoNotSave	Do not perform save.
SaveIfPassed	Perform save only if the checking is passed.
AlwaysSave	Always perform save

Member Function Documentation

unsafe bool NXOpen.Validate.ValidatorOptions.Validate ( )

inline

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.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Validate.ValidatorOptions.ResultsDisplayModeTypes NXOpen.Validate.ValidatorOptions.AutoDisplayResults

getset

Returns or sets the configuration of auto display results

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.ExcludeNonOwnerParts

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.ExcludeReadonlyParts

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.GenerateCheckFlag

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.GenerateLogFile

getset

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

If True, log file will be generated.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Validate.ValidatorOptions.LogFileDirectory

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.ValidatorOptions.LogModeTypes NXOpen.Validate.ValidatorOptions.LogFileMode

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.ResultsAutoUpdate

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.ValidatorOptions.SaveModeTypes NXOpen.Validate.ValidatorOptions.SavePartFile

getset

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

If True, part file will be saved.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.SaveResultInPart

getset

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

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Validate.ValidatorOptions.SaveModeTypes NXOpen.Validate.ValidatorOptions.SaveResultInTeamcenter

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.SkipChecking

getset

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.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.SkipCheckingDontLoadPart

getset

Returns or sets the configuration of skipping checking without loading parts

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.SkipOverriddenResultOption

getset

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

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

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.StopOnError

getset

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

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.StopOnWarning

getset

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

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Validate.ValidatorOptions.TreatWarningAsFail

getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

The documentation for this class was generated from the following file:

Validate_ValidatorOptions.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation