Click or drag to resize

ValidatorService Class

This service is defined for the validation of an AML document. Additionally the service can also be used to repair specific invalid properties in a document.
Inheritance Hierarchy
SystemObject
  Aml.Engine.ServicesValidatorService

Namespace: Aml.Engine.Services
Assembly: Aml.Engine.Services (in Aml.Engine.Services.dll) Version: 3.2
Syntax
Copy
public class ValidatorService : IValidator<ValidationElement>, 
	IValidator, IAMLService

The ValidatorService type exposes the following members.

Methods
 NameDescription
Public methodIDValidation Validates the ID of a CAEX object. IDs of CAEX objects shall be unique.
Public methodNameValidation Validates a name of a CAEX object. Names of CAEX classes or types (RoleClasses, InterfaceClasses, SystemUnitClasses and AttributeTypes), Attributes, Libraries and CAEX InstanceHierarchies shall be unique across its siblings or across all child elements of the same CAEX parent element over its life time. This shall assure that referencing a library, a class, a type or an attribute by its path delivers a unique result.
Public methodStatic memberRegister Registers a new validator service.
Public methodRepair Repairs the specified validated element.
Public methodStatic memberUnRegister Unregisters the validator service.
Public methodValidateAliasReferences Validates the alias references and returns the validation result describing possible repair options. The ValidationElement provides detailed information about available Repair Options and an additional Information Text.
Public methodValidateAll(CAEXDocument, Boolean) Get Validation Information for all elements in the specified document, which have validation issues. The ValidationElement provides detailed information about available Repair Options and an additional Information Text.
Public methodValidateAll(CAEXDocument, AutomationMLContainer, Boolean) Get Validation Information for all elements in the specified document, which have validation issues. The IValidationResult provides detailed information about available Repair Options and an additional Information Text. This method should be used, if the Document is loaded from an AutomationML container. The Validation service will check validity of external references which are packed parts of the container.
Public methodValidateAllWithoutStrictID Get Validation Information for all elements in the specified document, which have validation issues. The ValidationElement provides detailed information about available Repair Options and an additional Information Text.
Top
See Also