Vector.ValidationFramework

Base class for all framework-provided value parsers. Handles only the format error text aspect. Can also be used as base class for own value parsers.

Get or set the error text that appears when the value couldn't be parsed due to a wrong input format.

Value parser for Boolean values StandardValueParsers class

Base interface for all value parsers. A value parser is used by the Validation Framework to perform format validation and to convert a string to a defined data type. The Validation Framework provides a number of value parsers for standard data types. In order to provide an own value parser, the client can implement this interface in an appropriate way.

The data type to convert the string to.

Converts a string to a concrete data type.

The string to parse The converted value. true if conversion was possible, false if conversion failed (e.g. due to invalid format)

The client can get or set the error text that appears when the value couldn't be parsed due to a wrong input format. This text is passed to the

Set the textual representation for the value 'True'

Set the textual representation for the value 'False'

Value parser for 8-Bit integer StandardValueParsers class

Value parser for unsigned 8-Bit integer StandardValueParsers class

Value parser for unsigned 8-Bit integer interpreted as hexadecimal value. Supports values with or without leading 0x. StandardValueParsers class

Value parser for 16-Bit integer StandardValueParsers class

Value parser for unsigned 16-Bit integer StandardValueParsers class

Value parser for unsigned 16-Bit integer interpreted as hexadecimal value. Supports values with or without leading 0x. StandardValueParsers class

Value parser for 32-Bit integer StandardValueParsers class

Value parser for unsigned 32-Bit integer StandardValueParsers class

Value parser for unsigned 32-Bit integer interpreted as hexadecimal value. Supports values with or without leading 0x. StandardValueParsers class

Value parser for 64-Bit integer StandardValueParsers class

Value parser for unsigned 64-Bit integer StandardValueParsers class

Value parser for unsigned 64-Bit integer interpreted as hexadecimal value. Supports values with or without leading 0x. StandardValueParsers class

Value parser for 64-Bit floating point value (Double) StandardValueParsers class

Value parser for 64-Bit floating point value (Double) with range check

Construct a Value Parser object

Lower limit Upper limit Include lower limit on range check Include upper limit on range check Check lower limit violation Check upper limit violation

Dummy value parser for string values. Simply passes the string through. StandardValueParsers class

This interface is used by the application's data model validation logic to report validation errors to the Validation Framework. The GUIValidator class implements this interface. This interface is public in order to allow the client to define another data model validation sink for different validation use cases.

GUIValidator class

Remove all registered model errors. Model errors are all errors that are not format errors which always have error class 0.

Remove all registered errors of a specific error class.

Remove all registered errors of model elements associate with a specific validation group.

Remove all registered errors of model elements associate with a specific validation group and their direct and indirect childs.

Query the existence of errors of a specific class.

Register error. The object property is identified by a client-defined numeric property handle (which has to be unique per data model class)

The error class (class 0 is always the format error) The data model element the error appeared in The client-defined handle for a specific validated object property. Must be unique per class. The concrete error text

Register error. The object property is identified by a client-defined string-based property handle (which has to be unique per data model class)

Register error. The object property is identified by a client-defined numeric property handle (which has to be unique per data model class)

Register error. The object property is identified by a client-defined string-based property handle (which has to be unique per data model class)

This method is called after model validation during ActivateErrorProviders...(). Algorithm: Recursively iterate all groups. (1) validationDisplayDepth==Strong: All groups receive the validation display type "strong". After that all errors of weak and strong validation are visualized (2) validationDisplayDepth==Weak: All groups receive the validation display type "weak" AS LONG AS neither the group nor one of its direct or indirect child groups have the validity state "Strong invalid" -AND- have the validation display type "Strong" from the previous run. OTHERWISE the the validation display type remains unchanged.

- Resets all error providers - Clears all stored format and model errors if specified - Resets the model -- GUI mapping

True if all stored format errors should be cleared. True if all stored model errors should be cleared.

Query whether errors of one or more specified error classes are stored.

Dynamic parameter list of error classes to consider. If empty, all error classes are considered. true - At least one error is stored false - No error is stored

Push Model Specific! Activates error providers based on previously stored model - GUI mapping, reported errors, group relations (if used) and error class priority rules

Associate error provider for error class. Different error provider instances are only necessary to realize different icons for different error classes.

Error class (0 is always the format error; smaller error classes have higher priority when visualizing an error. The error provider to assign the error class with. The error provider provides the concrete error icon.

Remove all elements from the ignore list. Background: It is possible to set individual model elements or GUI elements to an ignore list. Errors of such elements are not longer visualized.

Check if the model elements has errors of specific error classes. The object property is identified by a client-defined numeric property handle (which has to be unique per data model class)

The data model element the error appeared in The client-defined handle for a specific validated object property. Must be unique per class. A list of error classes to be checked for the model element.

Check if the model elements has errors of specific error classes. The object property is identified by a client-defined string-based property handle (which has to be unique per data model class)

The data model element the error appeared in The client-defined handle for a specific validated object property. Must be unique per class. A list of error classes to be checked for the model element.

Get the error text and error class of specific model elements that would be visualized by the associated error provider / GUI element

Model elements associated with specific GUI element Replies the error class of the error text used

Add model element to ignore list. Background: It is possible to set individual model elements or GUI elements to an ignore list. Errors of such elements are not longer visualized.

The data model element to ignore errors for The client-defined handle for a specific validated object property. Must be unique per class. true - Ignore element. false - Do not ignore element any longer.

Add model element to ignore list. Background: It is possible to set individual model elements or GUI elements to an ignore list. Errors of such elements are not longer visualized.

GUI Validator for universal error provider data sink (e.g. property window)

Perform format validation and transfer value to the data model The object property is identified through a client-defined numeric property handle (which has to be unique per data model class). Includes the functionality of the corresponding StoreMapping method (= StoreMapping + Validation + Model Update)

The type of the particular property to transfer the new value to The new value as string coming from GUI A value parser that is responsible for format validation and value conversion. Can also be a standard value parser provided by the framework. A delegate that knows how to put the new value to the data model property (e.g. delegate(string value) { signal.Name = value; } ) The data model element to connect to the GUI element The client-defined handle for a specific validated object property. Must be unique per class. The GUI element to connect to the data model element true: format OK or GUI element ignored during validation, false: format error

The type of the particular property to transfer the new value to The new value as string coming from GUI A value parser that is responsible for format validation and value conversion. Can also be a standard value parser provided by the framework. A delegate that knows how to put the new value to the data model property (e.g. delegate(string value) { signal.Name = value; } ) A delegate that knows how to get the current value from the data model property (e.g. delegate() { return signal.Name; } ) The data model element to connect to the GUI element The client-defined handle for a specific validated object property. Must be unique per class. The GUI element to connect to the data model element Replies whether the value has changed or not true: format OK or GUI element ignored during validation, false: format error

Perform format validation and transfer value to the data model The object property is identified through a client-defined string-based property handle (which has to be unique per data model class) Includes the functionality of the corresponding StoreMapping method (= StoreMapping + Validation + Model Update)

The type of the particular property to transfer the new value to The new value as string coming from GUI A value parser that is responsible for format validation and value conversion. Can also be a standard value parser provided by the framework. A delegate that knows how to put the new value to the data model property (e.g. delegate(string value) { signal.Name = value; } ) A delegate that knows how to get the current value from the data model property (e.g. delegate() { return signal.Name; } ) The data model element to connect to the GUI element The client-defined handle for a specific validated object property. Must be unique per class. The GUI element to connect to the data model element Replies whether the value has changed or not true: format OK or GUI element ignored during validation, false: format error

Use this method to ignore a GUI element when visualizing errors. In some use cases particular controls are allowed to contain invalid values for a period that must't lead to an error indicator (e.g. "undefined value" semantics, legacy values that must be preserved, etc.)

The GUI element to ignore true: ignore, false: do not ignore

Replies whether a specific GUI element has errors of one or more specific error classes.

The GUI element to check List of error classes to check for true: GUI element has at least one error of the passed error classes false: no error

Simply store the mapping between a data model element and a GUI element without transferring a new value to the data model and without format validation. This is necessary for controls that have an own data handling (e.g. combo boxes) or for controls that can visualize an error indicator but do not carry values itself (e.g. boundary frame) The object property is identified through a client-defined numeric property handle (which has to be unique per data model class)

The GUI element to connect to the data model element The data model element to connect to the GUI element The client-defined handle for a specific validated object property. Must be unique per class.

Simply store the mapping between a data model element and a GUI element without transferring a new value to the data model and without format validation. This is necessary for controls that have an own data handling (e.g. combo boxes) or for controls that can visualize an error indicator but do not carry values itself (e.g. boundary frame) The object property is identified through a client-defined string-based property handle (which has to be unique per data model class)

The GUI element to connect to the data model element The data model element to connect to the GUI element The client-defined handle for a specific validated object property. Must be unique per class.

Interface to support home-made error providers (e.g. in property windows)

Delegate to set a concrete value to a data model element. Used by IGUIValidatorControl and IGUIValidatorUniversal

The concrete type of the property to be fed in the data model The concrete value to transfer to the data model element

Delegate to get a concrete value from a data model element. Used by IGUIValidatorControl and IGUIValidatorUniversal

The concrete type of the property to be fed in the data model The concrete value to transfer to the data model element