Click or drag to resize

Aml.Engine.Services Namespace

The Aml.Engine.Services namespace contains classes that define and implement specific Services that provide additional features for the processing of AMLDocuments. Registered services are located by the AMLEngine and can enhance API methods to provide faster queries or automated name assignment to added elements.
Classes
 ClassDescription
Public classCAEXFileStatisticService This service calculates statistics for a CAEX document.
Public classCAEXReference This class is used in queries to provide information about objects, which contain references to other objects.
Public classCAEXSchemaTransformer This class defines a service for a schema transformation. The service supports transformation of CAEX documents from CAEX Version 2.15 to version 3.0 and back. Backwards transformation can result in a loss of information.
Public classEmptyLookupTKey, TElement Extension class which provides an empty lookup table
Public classExternalReferenceResolver This class implements the IExternalReferenceResolverAsync service interface. With this service it is possible to access CAEX objects which are outsourced into external documents and referenced using alias names. Normally the service is located by other services like query services. They can call this service to resolve an external reference if an alias is part of a CAEX path in any query.
Public classLookupService This class is a query service based on dictionaries.
Public classMergeService This class implements a merge service which is able to merge CAEX documents from different sources into one common document. The merge service adds the libraries from the external referenced file into the target document and updates all references, which use an alias and can be resolved after the merge. If a library, which is used in the external source, also exists in the target document, this library is replaced, if the library version in the external source is newer. If not the existing library is kept. If an InstanceHierarchy in the external source can be identified as an outsourced Master InternalElement, it is tried to add the Master InternalElement back to its original position.
Public classQueryResult This class supports the interpretation of the queryResult table which is the result of some queries, defined in IQuery
Public classQueryService This class defines the default query service for a CAEXDocument. The query methods of this service are based on System.Xml.Linq and System.Xml.XPath.
Public classReferenceElement ReferenceElement is a Tuple of an XElement and the Name of an Attributes, which is used to reference another Element. The reference may be used as a key to find the referenced Element.
Public classRepairTypeEnumConverter Extensions for RepairTypeEnum
Public classServiceLocator This class provides methods to register and locate services which can support the processing of AML documents. There can always exist only one service of the same type at one time. The available service types are recognized to be assignable to the IAMLService interface.
Public classSignatureServiceBase Abstract base class usable for implementation of signing services
Public classSplitService This class is an implementation of a split service. This service is able to split one CAEXDocument into multiple files using split points.
Public classUndoRedoService This class implements an Undo and Redo service. When this service is registered, changes in an AutomationML document can be reversed. A sequence of actions can be grouped into transactions which than can be reversed within a single undo operation. The AMLEngine will locate a registered UndoRedoService and will notify the service of any changes, made to a document. The service manages individual stacks for each loaded CAEX document.
Public classUniqueNameService This class defines methods for a unique name service. The names of CAEX-Objects in a Sequence of Elements should all be unique. If a unique name service is registered, the AMLEngine will automatically call this service for a unique name generation whenever a new element is added to a sequence which requires a unique name for its members. This services uses a generation pattern which consists of the specified default name followed by a generated ordinal number of the elements in a sequence.
Public classValidationElement Class ValidationElement is a Tuple of an XElement and associated detailed Information about any inconsistencies, assigned with that Element.
Public classValidationKey Class ValidationKey.
Public classValidationResults This class defines methods to assist the interpretation of validation results.
Public classValidatorService 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.
Enumerations
 EnumerationDescription
Public enumerationRepairTypeEnum Enumeration RepairTypeEnum
Public enumerationValidationTypeEnum Enumeration ValidationTypeEnum