Click or drag to resize

CAEXFileType Class

This class is a wrapper for the CAEX element 'CAEXFile' which is the root-element of any CAEX document.
Inheritance Hierarchy
SystemObject
  Aml.Engine.CAEXCAEXWrapper
    Aml.Engine.CAEXCAEXBasicObject
      Aml.Engine.CAEXCAEXFileType
        Aml.Engine.AmlObjectsAMLFile

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
public class CAEXFileType : CAEXBasicObject, 
	IEnumerable<CAEXObject>, IEnumerable

The CAEXFileType type exposes the following members.

Constructors
 NameDescription
Public methodCAEXFileType This class is a wrapper for the CAEX element 'CAEXFile' which is the root-element of any CAEX document.
Top
Properties
 NameDescription
Public propertyAdditionalInformation Gets the collection of AdditionalInformation values contained in this instance.
(Inherited from CAEXBasicObject)
Public propertyAttributeTypeLib Gets the collection of AttributeTypeLib objects contained in the CAEXFile.
Public propertyCAEXDocument Gets the CAEX document of this CAEX object. If the CAEX object has not been inserted into a document or has been removed from the document, the value is null.
(Inherited from CAEXWrapper)
Public propertyCAEXParent Gets the CAEXParent of this instance if it exists.
(Inherited from CAEXWrapper)
Public propertyCAEXSequenceOfCAEXObject Gets the CAEXSequence containing this CAEX object
(Inherited from CAEXWrapper)
Public propertyChangeMode Gets and sets the change mode for a CAEX element (Optional in CAEX).
(Inherited from CAEXBasicObject)
Public propertyCopyright Gets and sets the Copyright for this object.
(Inherited from CAEXBasicObject)
Public propertyCopyrightElement Gets the wrapper for the Copyright element.
(Inherited from CAEXBasicObject)
Public propertyDescription Gets and sets the Description for this object.
(Inherited from CAEXBasicObject)
Public propertyDescriptionElement Gets the wrapper for the Description element.
(Inherited from CAEXBasicObject)
Public propertyDocument Gets the XDocument of the wrapped XML-Element
(Inherited from CAEXWrapper)
Public propertyExists Determines if this is a wrapper around an existing XML-Element
(Inherited from CAEXWrapper)
Public propertyExternalReference Gets the collection of ExternalReference objects contained in the CAEXFile.
Public propertyFileName Gets and sets the FileName attribute of the CAEXFile.
Public propertyInstanceHierarchy Gets the collection of InstanceHierarchy objects contained in the CAEXFile.
Public propertyInterfaceClassLib Gets the collection of InterfaceClassLib objects contained in the CAEXFile.
Public propertyIsDeleted Determines if this XML element is part of an existing XML document.
(Overrides CAEXWrapperIsDeleted)
Public propertyIsEmpty Gets a value indicating whether this instance is empty.
Public propertyNode Gets the wrapped XML-Element
(Inherited from CAEXWrapper)
Public propertyOwner Gets the wrapped Xml-Element's parent
(Inherited from CAEXWrapper)
Public propertyRevision Gets the collection of Revision objects contained in this instance.
(Inherited from CAEXBasicObject)
Public propertyRoleClassLib Gets the collection of RoleClassLib objects contained in the CAEXFile.
Public propertySchemaLocation Gets and sets the SchemaLocation attribute of the CAEXFile.
Public propertySchemaVersion Gets and sets the SchemaVersion attribute of the CAEXFile.
Public propertySourceDocumentInformation Gets the collection of SourceDocumentInformation objects contained in the CAEXFile.
Public propertySourceObjectInformation Gets the collection of SourceObjectInformation objects contained in this instance.
(Inherited from CAEXBasicObject)
Public propertySuperiorStandardVersion Gets the collection of SuperiorStandardVersion objects contained in the CAEXFile. The value of the SuperiorStandardVersion object is defined as a string.
Public propertySystemUnitClassLib Gets the collection of SystemUnitClassLib objects contained in the CAEXFile.
Public propertyTagName Gets the name of the CAEX tag for this CAEX object.
(Inherited from CAEXWrapper)
Public propertyVersion Gets and sets the Version for this object.
(Inherited from CAEXBasicObject)
Public propertyVersionElement Gets the wrapper for the Version element.
(Inherited from CAEXBasicObject)
Top
Methods
 NameDescription
Public methodCAEXChild Gets the first child of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper)
Public methodCAEXChildren Gets all children of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper)
Public methodCAEXSequence Gets the CAEXSequence owned by this CAEX object, which contains the specified CAEX object.
(Overrides CAEXBasicObjectCAEXSequence(ICAEXWrapper))
Public methodContainerT Gets the CAEX Container for elements of type T, which is owned by this CAEX object
(Inherited from CAEXBasicObject)
Public methodCopy Creates a deep copy of this CAEX object
(Inherited from CAEXWrapper)
Public methodEquals Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper)
Public methodGetEnumerator Gets an enumerator that enables enumeration of all libraries in the CAEX file.
Public methodGetFileNamePathObsolete.
Retrieves the file name including full path out of the CAEX document.
Public methodGetHashCode Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper)
Public methodGetXAttributeValue Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element.
(Inherited from CAEXWrapper)
Public methodImport Imports the specified CAEX object in it's associated sequence. The provided CAEX object is copied and all references are recalculated before it is inserted.
(Overrides CAEXBasicObjectImport(CAEXWrapper, String, Boolean))
Public methodInsert(CAEXWrapper, Boolean) Inserts the specified CAEX object in it's associated sequence. The CAEXFile defines the ExternalReference, InstanceHierarchy, InterfaceClassLib, RoleClassLib, SystemUnitClassLib and AttributeTypeLib sequences.
(Overrides CAEXBasicObjectInsert(CAEXWrapper, Boolean))
Public methodInsert(Int32, CAEXWrapper) Inserts the specified CAEX object in it's associated sequence at the given position. The CAEXFile defines the ExternalReference, InstanceHierarchy, InterfaceClassLib, RoleClassLib, SystemUnitClassLib and AttributeTypeLib sequences.
(Overrides CAEXBasicObjectInsert(Int32, CAEXWrapper))
Public methodInsertNew This method can be used to create an XML node, if this CAEX wrapper was instantiated without an XML node. This method can only be applied, if an Owner is defined. The new created CAEX object is inserted as a new child of the owner.
(Inherited from CAEXWrapper)
Public methodNew_Revision Creates a new Revision object and inserts it to the collection of Revision objects Revision either at the beginning or at the end of the sequence, according to the specified optional value. The Revision object is initialized with the provided values.
(Inherited from CAEXBasicObject)
Public methodRemove Removes this element. After that it is no longer assigned to a document and has no owner anymore.
(Inherited from CAEXWrapper)
Public methodSetXAttributeValue Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null).
(Inherited from CAEXWrapper)
Top
Events
 NameDescription
Public eventPropertyChanged The Change event raised when any property is modified.
(Inherited from CAEXWrapper)
Top
Extension Methods
 NameDescription
Public Extension MethodAddAutomationMLBPRInterfaceClassLib Adds the AutomationMLBPRInterfaceClassLib containing all interface classes used to model external document references to the AMLDocument.
(Defined by ExternalDataReference)
Public Extension MethodAddAutomationMLBPRRoleClassLib Adds the AutomationMLBPRRoleClassLib containing all role classes used to model external document references to the AMLDocument.
(Defined by ExternalDataReference)
Public Extension MethodAddExternalDataReferenceLibraries Adds the external data reference libraries used to model external document references. It is checked, if the needed role- and interface libraries are contained in the AMLDocument. If this libs are missing, they are imported from an embedded resource stream. The current Version of the embedded libs is version 1.0.0.
(Defined by ExternalDataReference)
Public Extension MethodAllElementsWithInternalLinks Getting an enumerable of all Elements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile. The enumeration may return InternalElements or SystemUnitClass elements.
(Defined by AMLEngineAdapter)
Public Extension MethodAllInternalElementsWithInternalLinks Getting an enumerable of InternalElements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile.
(Defined by AMLEngineAdapter)
Public Extension MethodAllLibraryReferences Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodAMLFile Converts a CAEX file to an AML file.
(Defined by AmlObjectsExtensions)
Public Extension MethodAppendDocumentVersionInformation Appends the provided document version information to the AutomationML document
(Defined by DocumentVersions)
Public Extension MethodAppendDocumentVersionInformation This function sets the DocumentVersion information for a referenced document. If DocumentVersion information about the same document Identifier already exists, this DocumentVersion information is replaced.
(Defined by DocumentVersions)
Public Extension MethodAutomationMLBPRInterfaceClassLib Gets the AutomationMLBPRInterfaceClassLib containing all interface classes used to model external document references to the AMLDocument.
(Defined by ExternalDataReference)
Public Extension MethodAutomationMLBPRRoleClassLib Gets the AutomationMLBPRRoleClassLib containing all role classes used to model external document references to the AMLDocument.
(Defined by ExternalDataReference)
Public Extension MethodAutomationMLEdition Gets the AutomationML edition of this caex object. The AutomationML edition is extracted from the AutomationML filename, if it is coded in the name as defined in the library development guide. If no edition is defined in the filename, the AutomationML version string is provided as it is found in the AutomationML document.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodAutomationMLVersion Gets the AutomationML version for this CAEXFile object.
(Defined by AmlObjectsExtensions)
Public Extension MethodClearMetaInformation Removes all "Writer Header" specific meta information out of this CAEX file.
(Defined by AmlObjectsExtensions)
Public Extension MethodcloneCopy(Boolean, Boolean, Boolean)
(Defined by AMLEngineAdapter)
Public Extension MethodCloneNode Clones the node.
(Defined by AMLEngineAdapter)
Public Extension MethodConsistencyCheck_ClassReference Check if the given classPath is a valid path to an existent class in the AML file.
(Defined by AMLEngineAdapter)
Public Extension MethodCreateDocumentVersionsHeader Creates the additional information representing a document versions header and appends it to the AutomationML document.
(Defined by DocumentVersions)
Public Extension MethodDeleteDocumentVersionInformation This function deletes all existing DocumentVersion information from the AutomationML document corresponding to the documentID.
(Defined by DocumentVersions)
Public Extension MethodDeleteMetaInformation This function deletes any existing meta information corresponding to the writerID.
(Defined by AmlObjectsExtensions)
Public Extension MethodDescendants Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendants Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendantsT Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDocumentVersionsHeader Get the Additional Information XML-Node from the CAEXFile, which represents the Document Versions node.
(Defined by DocumentVersions)
Public Extension MethodExternalDataReferenceInterfaceClass Gets the 'ExternalDataReference' InterfaceClass from the AML document.
(Defined by ExternalDataReference)
Public Extension MethodExternalDataRoleClass Gets the ExternalData RoleClass from the AML document. ExternalData RoleClass is only defined for CAEX 2.15 and AutomationML 2.0
(Defined by ExternalDataReference)
Public Extension MethodExternalReferences Enumeration Method for all ExternalReferences of the CAEXFile.
(Defined by AMLEngineAdapter)
Public Extension MethodFindFastByID Performs a document wide fast search and returns a CAEXObject given by its ID.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodFindFastByIDT Performs a document wide fast search and returns an object of type 'T' given by its ID.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodFindFastByPath Performs a document wide fast search and returns a CAEXObject given by its Path, e.g. "plant/unit" or -in case the document is based on CAEX 2.15 - "GUID:Interface".
(Defined by CAEXFileTypeExtensions)
Public Extension MethodFindFastByPathT Performs a document wide fast search and returns an object of type 'T' given by its Path, e.g. "plant/unit" or -in case the document is based on CAEX 2.15 - "GUID:Interface".
(Defined by CAEXFileTypeExtensions)
Public Extension MethodfindInternalElement Resolve a reference to an InternalElement and return the referenced element if found.
(Defined by AMLEngineAdapter)
Public Extension MethodGetAllDocumentVersionInformation This methods returns an Enumeration of all Information related to document versions defined in the "DocumentVersions" information of an AutomationML document.
(Defined by DocumentVersions)
Public Extension MethodGetAllElementsWithInternalLinks Getting a List of all Elements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile. The List may contain InternalElements and SystemUnitClass elements.
(Defined by AMLEngineAdapter)
Public Extension MethodGetAMLInfoFromFilename Get AutomationML file info from the caex filename.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodGetDocumentVersionInformation This function returns the DocumentVersion Information from the AutomationML document with the specified document Identifier, otherwise null.
(Defined by DocumentVersions)
Public Extension MethodGetMetaInformation This methods returns an Enumeration of all "WriterHeader" meta information out of an existing AutomationML file.
(Defined by AmlObjectsExtensions)
Public Extension MethodGetMetaInformation This function returns the MetaInformation corresponding to the writerID, otherwise null.
(Defined by AmlObjectsExtensions)
Public Extension MethodGetParent This method returns the parent CAEXBasicObject of the current CAEXBasicObject.
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedClass Getting the XML Node for a class path.
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedGUID Parsing a string of form GUID:Interface and returning the GUID
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedInterfaceClass Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations.
(Defined by AMLEngineAdapter)
Public Extension MethodgetReferencedInterfaceName Getting the name of the referenced Interface.
(Defined by AMLEngineAdapter)
Public Extension MethodHasNewVersion Determines, if this caex object has a related newer version
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodHasOldVersion Determines, if this caex object has a related older version
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodImport_AttributeTypeLib Imports the provided library into the AttributeTypeLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImport_InstanceHierarchy Imports the provided source instance hierarchy into the InstanceHierarchy collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImport_InterfaceClassLibHierarchy Imports the provided library into the InterfaceClassLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImport_RoleClassLibHierarchy Imports the provided library into the RoleClassLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImport_SystemUnitClassLibHierarchy Imports the provided library into the SystemUnitClassLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImportAttributeTypeLib Imports the provided library into the AttributeTypeLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImportInstanceHierarchy Imports the provided source instance hierarchy into the InstanceHierarchy collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImportInterfaceClassLib Imports the provided library into the InterfaceClassLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImportRoleClassLib Imports the provided library into the RoleClassLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodImportSystemUnitClassLib Imports the provided library into the SystemUnitClassLib collection of this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodInsert_Element Inserting an element of base type TypeBase to this object. The Element is inserted at the first Element of any existing Elements of the same Type if nothing else is explicit defined.
(Defined by AMLEngineAdapter)
Public Extension MethodInsert_ExternalReference Inserts the ExternalReference into the CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodInsert_InstanceHierarchy Insert an existing InstanceHierarchy to this CAEX file as the last InstanceHierarchy.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodInsert_InterfaceClassLibHierarchy Insert an existing InterfaceClassLib to this CAEX file as the last InterfaceClassLib.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodInsert_NewInstance Inserting a new class instance to this object. This method can be overridden in derived classes. The Instance is inserted as the first instance of any other element with the same type if nothing else is explicit defined.
(Defined by AMLEngineAdapter)
Public Extension MethodInsert_RoleClassLibHierarchy Insert a RoleClassLib to this CAEX file as the last RoleClassLib.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodInsert_SystemUnitClassLibHierarchy Append a SystemUnitClassLib to this CAEX file as the last SystemUnitClassLib.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodInsert_TypeBaseElementInsert(CAEXWrapper, Boolean)
(Defined by AMLEngineAdapter)
Public Extension MethodInstanceHierarchies Enumeration Method for all InstanceHierarchies of the CAEXFile.
(Defined by AMLEngineAdapter)
Public Extension MethodInterfaceClassLibraries Enumeration Method for all InterfaceClass Libraries of the CAEXFile.
(Defined by AMLEngineAdapter)
Public Extension MethodName Get the Name of the specified object.
(Defined by AMLEngineAdapter)
Public Extension MethodName Gets a names for the specified CAEX wrapper object. If the specified object is a CAEXObject, the Name is returned; otherwise the TagName of the CAEX item.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodNew_Description Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodNew_ExternalReference A new ExternalReference node is added to the CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodNew_InstanceHierarchy Adding a new InstanceHierarchy with the given name to this CAEX file. The Instance Hierarchy is always added as the last Instance Hierarchy.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodNew_InterfaceClassLibHierarchy Adding a new InterfaceClassLib to this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodNew_RoleClassLibHierarchy Adding a new RoleClassLib to this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodNew_SystemUnitClassLibHierarchy Adding a new SystemUnitClassLib to this CAEX file.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodPreorderTraversal Traversal method for a hierarchical tree, with identical childSelector for all tree nodes. The method uses a pre-order algorithm without recursion for the deep traversal of the complete tree.
(Defined by CAEXFileTypeExtensions)
Public Extension MethodReplaceDocumentVersionInformation This function replaces any existing DocumentVersion information corresponding to the identical oldDocumentID with the provided new DocumentVersion information.
(Defined by DocumentVersions)
Public Extension MethodReplaceMetaInformation This function replaces any existing meta information corresponding to the identical oldWriterID with the new meta information defined in the newMetainformation
(Defined by AmlObjectsExtensions)
Public Extension MethodRoleClassLibraries Enumeration Method for all RoleClass libraries of the CAEXFile.
(Defined by AMLEngineAdapter)
Public Extension MethodSetMetaInformation This method is a short version of the setMetaInformation. Meta data with identical WriterID is replaced.
(Defined by AmlObjectsExtensions)
Public Extension MethodSetMetaInformation This function sets the meta information required from AutomationML standard. If meta information about the same writerID already exists, this meta information is replaced. These information comprise source information about the AutomationML file.
(Defined by AmlObjectsExtensions)
Public Extension MethodSetMetaInformationStandardAutomationMLLibrary This method labels this CAEX file as a standard AutomationML library coming from the AutomationML e.V. It removes all other meta information and should only be used from authorized persons in agreement with the AutomationML e.V.
(Defined by AmlObjectsExtensions)
Public Extension MethodSetSourceDocumentInformation This function sets the meta information required from AutomationML standard. If meta information about the same writerID already exists, this meta information is replaced. These information comprise source information about the AutomationML file.
(Defined by AmlObjectsExtensions)
Public Extension MethodSystemUnitClassLibraries Enumeration Method for all SystemUnitClass libraries of the CAEXFile.
(Defined by AMLEngineAdapter)
Top
Explicit Interface Implementations
 NameDescription
Explicit interface implementationPrivate methodIEnumerableGetEnumerator Returns an enumerator that runs through a collection.
Top
Remarks
Initializes a new CAEXWrapper of the 'CAEXFile' element.
See Also