Settings class containing user-configurable platform options. More...

Inheritance diagram for OpenTap.EngineSettings:

Public Types
enum	AbortTestPlanType { Step_Fail = 1 , Step_Error = 2 , Step_Inconclusive = 4 , Step_Pass = 8 }
	Enum to represent choices for AbortTestPlan setting. More...

Public Member Functions
	EngineSettings ()
	Sets up some default values for the various settings. User code should use EngineSettings.Current to access the singleton instead of constructing a new object.

Public Member Functions inherited from OpenTap.ComponentSettings< EngineSettings >
void	Save ()
	Saves the settings held by this class to an XML file in the ComponentSettings.SetSettingsProfile(string, string).

void	Invalidate ()
	Invalidates the cache of this type of component setting.

void	Reload ()
	Forces the reload of this type of component setting from the XML file the next time the setting is used.

virtual void	Initialize ()
	Called if a new ComponentSettings is instantiated and there are no corresponding settings XML.

Public Member Functions inherited from OpenTap.ValidatingObject
void	OnPropertyChanged (string propertyName)
	Triggers the PropertyChanged event. More...

Static Public Member Functions
static void	LoadWorkingDirectory (string newWorkingDirectory)
	Loads a new working directory and sets up environment variables important to OpenTAP. More...

Static Public Member Functions inherited from OpenTap.ComponentSettings< EngineSettings >
static ComponentSettings	GetCurrent (Type settingsType)
	Gets current settings for a specified component. This is either an instance of the settings class previously loaded, or a new instance loaded from the associated file. More...

static ComponentSettings	GetCurrent (ITypeData settingsType)
	Gets current settings for a specified component. This is either an instance of the settings class previously loaded, or a new instance loaded from the associated file. More...

static string	GetSettingsDirectory (string groupName, bool isProfile=true)
	The directory where the settings are loaded from / saved to. More...

static void	EnsureSettingsDirectoryExists (string groupName, bool isProfile=true)
	Ensures that the Settings directory exists and that the specified groupName sub directory exists. This might throw an exception if the settings directory was configured to something invalid. Like 'AUX', 'NUL', .... More...

static void	SetSettingsProfile (string groupName, string profileName)
	Sets the directory in which settings groups are loaded from / saved to. More...

static void	SaveAllCurrentSettings ()
	Saves all ComponentSettings objects that have been loaded.

static string	GetSaveFilePath (Type type)
	Gets the current file location where a ComponentSettings type is saved. More...

static void	SetCurrent (Stream xmlFileStream)
	Sets current settings for a component setting based on a stream of the file contents of a ComponentSettings XML file. More...

static void	SetCurrent (Stream xmlFileStream, out IEnumerable< XmlError > errors)
	Sets current settings for a component setting based on a stream of the file contents of a ComponentSettings XML file. More...

static ComponentSettings	GetCurrentFromCache (Type settingsType)
	Gets current settings for a specified component from cache. More...

Properties
MacroString	SessionLogPath `[getset]`
	Where the session logs are saved. Must be a valid path.

bool	PromptForMetaData `[getset]`
	Controls whether the engine should propagate a request for metadata.

AbortTestPlanType	AbortTestPlan `[getset]`
	Configures the engine to stop the test plan run if a step fails or causes an error.

string	OperatorName `[getset]`
	Name of the operator. This name will be saved along with the results.

string	StationName `[getset]`
	Name of the test station. This name will be saved along with the results.

double	ResultLatencyLimit `[getset]`
	Gets or sets the maximum allowed latency for result propagation. When the limit is reached, the test plan run pauses while the results are propagated to the Result Listeners. Result processing time is an estimated value based on previous processing delays.

bool	HasMultipleTimestampers `[get]`
	True, if there is more than one log timestamping type.

Diagnostic.ILogTimestampProvider	LogTimestamper `[getset]`
	Sets the log timestamp mechanism.

static string	StartupDir `[getset]`
	Where the test executive was started from.

IResourceManager	ResourceManagerType `[getset]`

Properties inherited from OpenTap.ComponentSettings< EngineSettings >
static T	Current `[get]`
	Get the currently loaded ComponentSettings instance for this class.

string?	GroupName `[get]`
	Settings group of this settings class.

static string	SettingsDirectoryRoot `[getset]`
	Where settings files are located. Usually this is at "[Executable location]\Settings", but it can be set to different locations. Setting this will invalidate loaded settings.

Properties inherited from OpenTap.ValidatingObject
ValidationRuleCollection	Rules `[get]`
	All the validation rules. Add new rules to this in order to get runtime value validation.

string	Error `[get]`
	Gets the error messages for each invalid rule and joins them with a newline.

Properties inherited from OpenTap.IValidatingObject
ValidationRuleCollection	Rules `[get]`
	A collection of all the currently defined validation rules. Add new rules here in order to get runtime value validation.

Additional Inherited Members
Static Public Attributes inherited from OpenTap.ComponentSettings< EngineSettings >
static bool	PersistSettingGroups
	Gets or sets if settings groups should be persisted between processes.

Protected Member Functions inherited from OpenTap.ValidatingObject
virtual string	GetError (string propertyName=null)
	Return the error for a given property

void	ThrowOnValidationError (bool ignoreDisabledProperties)
	Checks all validation rules on this object (Rules) and throws an AggregateException on errors. More...

Events inherited from OpenTap.ComponentSettings< EngineSettings >
EventHandler	CacheInvalidated
	Invokes when the cache for this settings item is invalidated for this item. The way to handle it is usually to fetch the new instance using ComponentSettings.GetCurrent(sender.GetType()).

Events inherited from OpenTap.ValidatingObject
PropertyChangedEventHandler	PropertyChanged
	Standard PropertyChanged event object.

Detailed Description

Settings class containing user-configurable platform options.

Member Enumeration Documentation

◆ AbortTestPlanType

enum OpenTap.EngineSettings.AbortTestPlanType

Enum to represent choices for AbortTestPlan setting.

Enumerator
Step_Fail	If a step completes with verdict 'Fail', the test plan execution should be aborted.
Step_Error	If a step completes with verdict 'Error', the test plan execution should be aborted.
Step_Inconclusive	If a step completes with verdict 'Inconclusive', the test plan execution should be aborted.
Step_Pass	If a step completes with verdict 'Pass', the test plan execution should be aborted.

Member Function Documentation

◆ LoadWorkingDirectory()

static void OpenTap.EngineSettings.LoadWorkingDirectory ( string newWorkingDirectory )

inlinestatic

Loads a new working directory and sets up environment variables important to OpenTAP.

Parameters

newWorkingDirectory

Property Documentation

◆ ResourceManagerType

IResourceManager OpenTap.EngineSettings.ResourceManagerType

getset

Public Types

Public Member Functions

Static Public Member Functions

Properties