Click or drag to resize

Aml.Engine.AmlObjects Namespace

The Aml.Engine.AmlObjects Namespace contains classes that support the generation and analysis of AutomationML features which are specified in the AutomationML standard, white-papers, best practice recommendation or application recommendations. These features are not covered with the classes in the Aml.Engine.CAEX namespace, which only supports the CAEX standard. Classes in the Aml.Engine.AmlObjects namespace may be derived from the CAEX classes.
Classes
 ClassDescription
Public classAMLFacet A Facet is an AML object providing a sub-view on attributes or interfaces of the parent AML object. This concept serves for the storage of different configuration settings such as HMI or PLC related data and allows the automation of several control engineering steps. For this, this part of IEC 62714 defines the AML RoleClass “Facet” (see6.4.4).“ [IEC 62714-1:2014 8.3 (p.43)]
Public classAMLFile An AMLFile is a CAEXFile, containing information about the AutomationML version and the WriterHeader (if CAEX 2.15 is used) or the SourceDocumentInformation (CAEX 3.0 and later versions).
Public classAMLGroup The AML Group concept allows separating structure information from instance information. An informative overview about the Group concept including examples is provided in A.2.4.” [IEC 62714-1:2014 8.4 (p.43)]. An AML Group object shall be described by a CAEX InternalElement with an association to the RoleClass “Group” which is defined in 6.4.3. [IEC 62714-1:2014 8.4 (p.43)]
Public classAMLGroupInternalElementSequence This class is used to support the AMLGroup concept. An AMLGroup object shall only contain InternalElements which are AMLMirrorObjects and/or further AMLGroup objects.
Public classAMLInternalElementType An AMLInternalElementType is a SystemUnitClass which can contain AMLPort AML objects.
Public classAMLLibraryTypeT This class is a generic type definition for CAEX libraries, which are defined by AutomationML and contain standardized classes.
Public classAMLPort An AML Port is an AML object that groups a number of interfaces. An informative overview about the Port concept including examples is provided in A.2.2. [IEC 62714-1:2014 8.2 (p.42)
Public classAMLSystemUnitClass An AMLSystemUnitClass is a SystemUnitClass which can contain AMLPort AML objects.
Public classAMLSystemUnitFamilyType An AMLSystemUnitFamilyType is a SystemUnitClass which can contain AMLPort AML objects.
Public classAutomationMLBaseAttributeTypeLib Contains definitions and access methods of standard base AttributeType objects.
Public classAutomationMLBaseAttributeTypeLibType This Class is a wrapper for the AutomationML standard 'AutomationMLBaseAttributeTypeLib' which is the container for a hierarchy of standard AttributeType definitions.
Public classAutomationMLBaseRoleClassLib Contains definitions and access methods of standard base RoleClass objects.
Public classAutomationMLBaseRoleClassLibType This Class is a wrapper for the AutomationML standard 'AutomationMLBaseRoleClassLib' which is the container for a hierarchy of standard RoleClass definitions.
Public classAutomationMLContainer Class AutomationMLContainer provides methods to save an AutomationML document and related documents which are needed for the interpretation or representation of AutomationML data into a single packed and zipped file. The various parts are assembled into this AutomationMLContainer. The Class provides methods to retrieve parts from a loaded container or for the assembly of parts into one single container. A Utility, to build a self containing container from a loaded CAEXDocument and the external referenced files, retrieved from the external references and ExternalInterface classes is defined in a special service.
Public classAutomationMLContainerRelationshipType Class RelationshipType describes the distinguished package part relationship types. This class cannot be inherited.
Public classAutomationMLInterfaceClassLib Contains definitions and access methods of standard base InterfaceClass objects.
Public classAutomationMLInterfaceClassLibType This Class is a wrapper for the AutomationML standard 'AutomationMLInterfaceClassLib' which is the container for a hierarchy of standard InterfaceClass definitions.
Public classAutomationMLLogicInterfaceClassLib Contains definitions and access methods of standard base InterfaceClass objects for the logic model.
Public classAutomationMLLogicInterfaceClassLibType This Class is a wrapper for the AutomationML standard 'AutomationMLLogicInterfaceClassLib' which is the container for a hierarchy of standard InterfaceClass definitions for logic models.
Public classAutomationMLLogicRoleClassLib Contains definitions and access methods of standard base RoleClass objects to model logic behavior.
Public classAutomationMLLogicRoleClassLibType This Class is a wrapper for the AutomationML standard 'AutomationMLLogicRoleClassLib' which is the container for a hierarchy of standard RoleClass definitions.
Public classAutomationMLPLCopenXMLInterfaceClassLib Contains definitions and access methods of standard base AutomationMLPLCopenXMLInterfaceClassLib interface.
Public classAutomationMLPLCopenXMLInterfaceClassLibType This Class is a wrapper for the AutomationML standard 'AutomationMLLogicInterfaceClassLib' which is the container for a hierarchy of standard InterfaceClass definitions for logic models.
Public classCAEXSignatureHeader The Class CAEXSignatureHeader defines extension methods for a CAEXObject to add or remove a signature header to an CAEXObject.
Public classDocumentVersionInformation This Class is defined for the modelling of document version information as defined in the AutomationML BPR 06 "Naming of related documents and their versions". DocumentVersions are stored as AdditionalInformation attached to the CAEXFile Node of the AMLDocument.
Public classDocumentVersions The Class DocumentVersions defines extension methods for the CAEXFileType to retrieve and manipulate document versions attached to a CAEXFile. The DocumentVersion feature is described in the AutomationML BPR 06 "Naming of related documents and their versions" .
Public classExternalDataReference This class provides methods to create and retrieve external data references as it is defined in the BPR document "ExternalDataReference" Version 1.0.0 from July 2016.
Public classFacetAttributeSequence This class defines a sequence of Attributes which belong to an AMLFacet. A Facet attribute shall be related to an existing attribute of the parent AML object, the identifier is the same name. Facet attributes which are not part of the parent object are not permitted. [IEC 62714-1:2014 8.3 (p.43)]
Public classFacetExternalInterfaceSequence This class defines a sequence of ExternalInterfaces which belong to an AMLFacet. A Facet interface shall be related to an existing interface of the parent object, the identifier is the same name. Facet interfaces which are not part of the parent object are not permitted. [IEC 62714-1:2014 8.3 (p.43)]
Public classFrameAttributeType This class is a wrapper for the AutomationML Attribute 'Frame'. To get access to instances of this type, use the ObjectWithAMLAttributes implicit type conversion operator, defined for all CAEX objects which are allowed to contain Attribute objects.
Public classFrameValues A frame holds position information of an object. The object position is defined by values for x, y and z axis as well as rotation values rx,ry and rz in degree, for the x, y and z axis.
Public classListAttribute Class ListAttribute supports List Attributes as it is defined in the BPR 'Modelling of List Attributes in AutomationML' from January 2016 Version 1.0.0
Public classMetaInformation Class for modelling meta information as defined in the AutomationML standard. This class was originally designed for AML Versions based on CAEX 2.15. For later versions you can switch to the SourceDocumentInformationType. It is possible to set SourceDocumentInformation in a CAEX 3.0 document using this class. If this is applied, the MetaInformation is automatically transformed to SourceDocumentInformation. The transformation works in both directions.
Public classObjectWithAMLAttributes This class defines specific AutomationML defined attributes to be associated to any AutomationML object, which is allowed to contain attributes. Instances of this class can be constructed with an implicit type conversion operator, defined in the wrapper classes, which implement the IObjectWithAttributes interface.
Public classRefTypeAttributeType RefType attribute is an Attribute of a ColladaInterface with the standardized name REF_TYPE_ATTRIBUTE
Public classRefURIAttributeType This class is a wrapper for the AutomationML defined Attribute with the standardized name 'RefURI'. To get access to instances of this type, use the ObjectWithAMLAttributes implicit type conversion operator, defined for all CAEX objects which are allowed to contain Attribute objects.
Interfaces
 InterfaceDescription
Public interfaceIAMLFile This interface class is implemented by CAEXDocument and AutomationMLContainer.