Click or drag to resize

Aml.Engine.Services.Interfaces Namespace

The Aml.Engine.Services.Interfaces Namespace defines interfaces implemented by services. A Service provides advanced processing methods for AutomationML documents.
Classes
 ClassDescription
Public classSchemaTransformationEventArgs Event arguments for schema transformation events
Public classUpdateEventArgs Event arguments used to inform about update events in the IAutoUpdate service.
Interfaces
 InterfaceDescription
Public interfaceIAMLEditionTransform This interface class defines a service interface for an AutomationML edition transformation service
Public interfaceIAMLLibraryService Service interface, defining methods to get informations about public available AutomationML files from an external source. The supported file types and file contents are specified in AMLFileModel.
Public interfaceIAMLService This is the basic interface for an AML service. This interface has to be implemented by any AML service
Public interfaceIAutoUpdate Interface defined for services, which support automatic updates of cross references between AutomationML objects. Updates are executed, when a referenced object changes its identification (its Name or its ID).
Public interfaceICAEXReference This interface is used to query references to CAEXObjects like references using the ID of objects or references using the CAEXPath of objects like RoleClass or InterfaceClass objects.
Public interfaceIDatabaseService This service interface defines methods to access and update XML data saved in an XML database. The methods offered correspond to methods that are also defined in the System.Linq.Xml namespace.
Public interfaceIExternalReferenceResolver This service interface defines methods to resolve external references of an AutomationML document. If references are resolved, queries will be able to find referenced objects. Be aware, that the resolved documents will not be merged and the references, containing an alias will not be changed.
Public interfaceIExternalReferenceResolverAsync This service interface adds async methods to the IExternalReferenceResolver
Public interfaceILookUpTable This interface defines a service which manages key based lookup tables for CAEX Objects using the CAEXPath and the ID of a CAEX Object as table keys. Please note that the service only provides methods to load and unload the lookup tables for a document. It will not update the tables when the document is modified.
Public interfaceIMerge This interface defines methods for a merge service. A merge service can merge ExternalReferences into an AML document.
Public interfaceIQuery The Query service provides methods to query relations modelled in an AutomationML document. The AMLEngine provides a default query service based on Linq (System.Xml.Linq). To get a better performance for queries, users can register a Lookup service which also implements this query interface but uses dictionary based queries. If ExternalReferences should be queried too, a IExternalReferenceResolver service should be registered.
Public interfaceISchemaTransform This interface class defines a service interface for a schema transformation service
Public interfaceISigning The Signing service provides methods to digitally sign CAEX objects.
Public interfaceISplit This interface defines the service interface for a split service. A split service is able to split one CAEXDocument into multiple files using split points.
Public interfaceISplitPoint This interface is defined for all CAEXObjects to which a split point can be assigned. SplitPoints are allowed on InternalElementType and CAEXLibraryTLibItem.
Public interfaceIStatistic This service interface is used to get statistic data from a CAEX document.
Public interfaceIUndoRedo The UndoRedo service supports undo and redo of all changes made to a CAEXDocument.
Public interfaceIUniqueName This interface 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 AML Engine will automatically call this service for a unique name generation whenever a new element is added to the sequence which requires a unique name for its members.
Public interfaceIValidationResult This interface defines properties for a validation result, generated for a single XML element. The validation results for XML elements of a CAEX document are generated by the IValidatorRESULTTYPE service.
Public interfaceIValidator This service interface is defined for the validation of an AML document. Additionally the service can also be used to repair specific invalid properties in a document and to automatically updated references to objects if the source changes.
Public interfaceIValidatorRESULTTYPE This service interface is defined for the validation of an AML document. The type parameter of this generic interface defined the validation result type.
Public interfaceIXMLDocumentRegistry This is a special interface for an AML service, which uses a registry to store data about an XML Document.
Public interfaceIXMLExternalUnload Interface extension for the IExternalReferenceResolver. A new class is used, to be downward compatible.