Skip to content

MOD.032 : Console Application Validator class

Markus edited this page May 7, 2020 · 8 revisions

Introduction

This module is part of MOD.030 - Console Application. It contains the AML validation functionalities.

Requirements

The following requirements are covered by this module:

Prerequisites

In order to use this module the following prerequisites should be met:

  • The developer should have a working computer that can access the internet
  • The developer should use Windows 10 as their operating system
  • The developer should use the .NET Framework Version 4.7 (other versions could be used, but were not tested)

Dependencies

This module depends on the AMLEngine module and on all of its dependencies. AMLEngine 2.1 was used during development.

Communication with other modules/Interface

In this project, this module is used as the class that validates a given AML document. It only communicates with the console, the AML-Engine and other standard C# objects over its COM-Interfaces.

Technical overview

File Structure

This module only consists of the validator class file. Also an AML-File needs to exists somewhere on the users connected drives.

Important Functions and Variables

The most important function is the validate function in the Validator.cs file. These are the current methods of the validator class:

Function name Description
"Validator (Constructor)" This funktion creates a new validator object, that can validate AML-Documents.
"validate" This functions validates and corrects the given AML-Document

There are three parameters to give to this validate function:

Parameter Prameter Description
doc This parameter contains the AML Document (wrapped in the CAEXDocument class of the AML-Engine) that should be validated.
path This parameter contains a string with the path to the document that should be validated.
ref Options This parameter contains the reference to the options object, that defines, how the AML-Document should be validated