Skip to content
This repository has been archived by the owner on Jun 22, 2019. It is now read-only.

T_CAEX_ClassModel_CAEXFileType

AutomationML edited this page Feb 23, 2017 · 2 revisions

CAEXFileType Class

The CAEXFileType class is the CAEX-Wrapper around the CAEX-Element 'CAEXFile', which is the Root-Element in any CAEXDocument. The CAEXFileType provides Methods to insert and order children as it is required by the CAEX-Schema. Until Version 2.1 of the AMLEngine, the CAEXFileType has an associated set of HashTables for fast access. From version 3.0, these Tables have been moved to the CAEXDocument. It is still possible to access the tables from here, but the access is internally redirected to the CAEXDocument. The CAEXFileType can be set to enable event handling EnableEventHandling(Boolean). If this is set to true, CAEXObjects can be registered - as example RegisterCaexObjectsForNodeInsertedEvent(XmlNode, Boolean, XmlNodeChangedEventHandler) - to receive changed events when the XmlData has been modified.

Class CAEXFileType.

Inheritance Hierarchy

System.Object
  TypeBase
    CAEX_ClassModel.CAEXBasicObject
      CAEX_ClassModel.CAEXFileType
Namespace: CAEX_ClassModel
Assembly: AMLEngine (in AMLEngine.dll) Version: 3.5

Syntax

C#

public class CAEXFileType : CAEXBasicObject

C++

public ref class CAEXFileType : public CAEXBasicObject

The CAEXFileType type exposes the following members.

Constructors

 

Name Description
Public method CAEXFileType Initializes a new instance of the CAEXFileType class.
  Back to Top

Properties

 

Name Description
Public property CaexSchemaLocation field for CAEX Schema reference
Public property Copyright Get the CopyrightType of this header object. (Inherited from CAEXBasicObject.)
Public property Description Get the description of this object. The returned object is null when no description element is found! (Inherited from CAEXBasicObject.)
Public property IDHashList **Obsolete. ** A list of all CAEX object instances in the whole CAEX-Document which have an ID, providing the pair "ID" and "CAEXObject". This was the basis for the fast search methods FindFastByID(String, Boolean) until Version 2.1 of the AMLEngine. The update of this list is done calling the method UpdateCAEXObjectHashListsFastWithoutValidation() this is not done automatically!

Remarks

This IDHashList is not used for fast search methods anymore. The Fast Search is based on the new IDTable which contains the XMLElements and not the CAEXWrappers around the XmlElements. It is still possible to use this Property, it will be rebuild from the IDTable but creates additional overhead to build and store the CAEXWrappers around the XmlElements.

Public property NumberOfAllObjects number of all checked objects
Public property NumberOfAttributes number of checked Attributes
Public property NumberOfInterfaceClasses number of checked InterfaceClasses
Public property NumberOfInterfaceInstances Gets the number of interface instances.
Public property NumberOfInternalElements number of InternalElements
Public property NumberOfLinks number of checked Links
Public property NumberOfRoleClasses number of checked RoleClasses
Public property NumberOfSystemUnitClasses number of checked SystemUnitClasses
Public property PathHashList **Obsolete. ** A list of all CAEX object classes in the whole document, providing the pair "Path" and CAEXObject. This was the basis for the fast search methods FindFastByPath(String, Boolean) until Version 2.1 of the AMLEngine. The update of this list is done calling the method UpdateCAEXObjectHashListsFastWithoutValidation() this is not done automatically!

Remarks

This PathHashList is not used for fast search methods anymore. The Fast Search is based on the new PathTable which contains the XMLElements and not the CAEXWrappers around the XmlElements. It is still possible to use this Property, it will be rebuild from the PathTable but creates additional overhead to build and store the CAEXWrappers around the XmlElements.

Field Value

Type:
The path hash list.

Public propertyStatic member StaticInfo Gets the static information.
Public property Version Get the VersionType of this header object. (Inherited from CAEXBasicObject.)
  Back to Top

Methods

 

Name Description
Public method AddObjToHashList **Obsolete. ** This method adds a CAEX object to the hash list. If required, it performs validation steps and can auto repair some errors.
Public method AllElementsWithInternalLinks Getting an enumerable of all Elements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile. The enumeration may return InternalElements or SystemUnitClass elements.
Public method AllInternalElementsWithInternalLinks Getting an enumerable of InternalElements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile.
Public method CAEXPath() Get the path to this in the object tree. For all objects, it returns the XML full Node Path except for Interface instances, then it returns GUID:InterfaceName. (Inherited from CAEXBasicObject.)
Public method CAEXPath(CAEXBasicObject) Returns the CAEX path of this object, search able with FindFastByPath(String, Boolean) methods. Examples: "plant/unit/tank" or GUID:interface. If the full hierarchical Path is required, use the method HierarchyPath instead which delivers the full node path.
Public method Children(Type) Gets all Children of this instance which are of the specified childrenType. This returns only the direct Children. (Inherited from CAEXBasicObject.)
Public method Children(Type, Func(XmlNode, CAEXBasicObject)) Gets all Children of this instance which are of the specified childrenType. This returns only the direct Children. (Inherited from CAEXBasicObject.)
Public method Children(T)() Gets all Children of this instance which are of Type T. This returns only the direct Children. (Inherited from CAEXBasicObject.)
Public method Children(T)(Func(XmlNode, T)) Gets all Children of this instance which are of Type T. This returns only the direct Children. (Inherited from CAEXBasicObject.)
Public method clone Create a clone of this object via reflection. The underlying XMLNode is normally cloned and a new instance of this class is created via Activator.CreateInstance with the cloned xml node. If an object of type InternalElement should be cloned, the method create_unique copy is called instead of using reflection to automatically get new GUIDs assigned. (Inherited from CAEXBasicObject.)
Public method CloneNode(Boolean) Clones the node. (Inherited from CAEXBasicObject.)
Public method CloneNode(Boolean, Boolean) Clones the node. (Inherited from CAEXBasicObject.)
Public method ConsistencyCheck_ClassReference Check if the given classPath is a valid path to an existent class in the AML file. (Inherited from CAEXBasicObject.)
Public method Descendants(Type) Gets all Descendants of this instance which are of the specified descendantType. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.)
Public method Descendants(Type, Func(XmlNode, CAEXBasicObject)) Gets all Descendants of this instance which are of the specified descendantType. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.)
Public method Descendants(T)() Gets all Descendants of this instance which are of Type T. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.)
Public methodCode example Descendants(T)(Func(XmlNode, T)) Gets all Descendants of this instance which are of Type T. This returns all subordinate Children and their Descendants. (Inherited from CAEXBasicObject.)
Public method EnableEventHandling The XMLDocument NodeInserted and NodeRemoved Events are caught by the CAEXFileType Object
Public method Equals Determines, if the specified Object and the current Object are equal. (Inherited from CAEXBasicObject.)
Public method ExternalReferences Enumeration Method for all ExternalReferences of the CAEXFile.
Public method FindFastByID(String, Boolean) Performs a document wide fast search and returns a CAEXObject given by its ID. This method is fast due to table support. If the actual Tables don't contain any Object, the UpdateAllTables(Boolean) method is called. If you have made unregistered changes to the document, the update method should be called explicit to ensure, that all Objects in the current Caex Document are registered.
Public method FindFastByID(T)(String, Boolean) Performs a document wide fast search and returns a CaexWrapper of the specified Parameter Type for the Object given by its ID. This method is fast due to table support. If the actual Tables don't contain any Object, the UpdateAllTables(Boolean) method is called. If you have made unregistered changes to the document, the update method should be called explicit to ensure, that all Objects in the current Caex Document are registered.
Public method FindFastByPath(String, Boolean) Performs a document wide fast search and returns a CAEXObject given by its Path, e.g. "plant/unit" or "GUID:Interface" If the actual Tables don't contain any Object, the UpdateAllTables(Boolean) method is called. If you have made unregistered changes to the document, the update method should be called explicit to ensure, that all Objects in the current Caex Document are registered.
Public method FindFastByPath(T)(String, Boolean) Performs a document wide fast search and returns a CaexWrapper of the specified Parameter Type for the Object given by its Path, e.g. "plant/unit" or "GUID:Interface" If the actual Tables don't contain any Object, the UpdateAllTables(Boolean) method is called. If you have made unregistered changes to the document, the update method should be called explicit to ensure, that all Objects in the current Caex Document are registered.
Public method findInternalElement Resolve a reference to an InternalElement and return the referenced element if found. Use FindFastByID for speed optimizations. (Inherited from CAEXBasicObject.)
Public method FirstAncestor(T) Gets the first ancestor of the specified type for this CaexObject (Inherited from CAEXBasicObject.)
Public method GetAllAttributes Retrieves all attributes and child attributes as a flat list.
Public method GetAllElementsWithInternalLinks Getting a List of all Elements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile. The List may contain InternalElements and SystemUnitClass elements.
Public method GetAllInternalElementsWithInternalLinks Getting a List of all InternalElements with InternalLinks of all InstanceHierarchies and SystemUnitClassLibraries in the CAEXFile.
Public methodStatic member GetFileNamePath Retrieves the file name including full path out of the CAEX document.
Public method getFullNodePath Getting the full path from document root to the specified XmlNode. As name of an XmlNode is the value of the contained attribute "name" taken. Hierarchies are separated via the path separator (slash '/'). The name of the document root element CAEXFile is not contained in the path. (Inherited from CAEXBasicObject.)
Public method GetHashCode Returns a hash code for this instance. (Inherited from CAEXBasicObject.)
Public method getLastAttributeNode **Obsolete. ** Gets the last attribute node. (Inherited from CAEXBasicObject.)
Public method getLastHeaderNode This methods returns the last XmlNode of this CAEX basic object according to the element order given by the CAEX schema. In this context "last" describes the element that is at the end of this header elements. (Inherited from CAEXBasicObject.)
Public method GetParent() This method returns the parent CAEXBasicObject of the current CAEXBasicObject. (Inherited from CAEXBasicObject.)
Public method GetParent(CAEXBasicObject) This method returns the parent CAEXBasicObject of the current CAEXBasicObject.
Public method getReferencedClass Getting the XmlNode for a class path. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.)
Public method getReferencedGUID Parsing a string of form GUID:Interface and returning the GUID (Inherited from CAEXBasicObject.)
Public method getReferencedInterfaceClass Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.)
Public method getReferencedInterfaceName Getting the name of the referenced Interface. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.)
Public method getReferencedRoleClass Getting a referenced RoleClass. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.)
Public method getReferencedSystemUnitClass Getting a referenced SystemUnitClass. Use FindFastByPath for speed optimizations. (Inherited from CAEXBasicObject.)
Public method GetReferenceHierarchy(T) Getting the reference hierarchy. hierarchy is build up as a queue. the most specialized class is first one in queue (Inherited from CAEXBasicObject.)
Public method getSchemaLocation Get the CAEX Schema location of this xml document
Public method HierarchyPath Returns the hierarchical full node path of this object, e. g. "plant/unit/tank" or "plant/unit/tank/interface" or "plant/unit/tank/attribute". If the CAEXPath is required, use the method Path which delivers e.g. GUID:interface.
Public method Import_ExternalReference Importing an ExternalReference from another document context. If another externalReference with the same path and the same alias Attribute exists, nothing is imported.
Public method Import_InstanceHierarchy Importing an InstanceHierarchy from another document context. Unlike Insert_InstanceHierarchy(InstanceHierarchyType) InstanceHierarchy's that are coming from other files can be inserted.
Public method Import_InterfaceClassLibHierarchy Importing an InterfaceClassLibHierarchy from another document context. Unlike Insert_InterfaceClassLibHierarchy(InterfaceClassLibType) InterfaceClassLibHierarchy's that are coming from other files can be inserted.
Public method Import_RoleClassLibHierarchy Importing a RoleClassLib from another document context. Unlike method Insert_RoleClassLibHierarchy(..) RoleClassLibs that are coming from other files can be inserted.
Public method Import_SystemUnitClassLibHierarchy Importing a SystemUnitClassLib from another document context. Unlike method Insert_SystemUnitClassLibHierarchy(..) SystemUnitClassLibs that are coming from other files can be inserted.
Public method Insert_ExternalReference Inserts the external reference.
Public method Insert_InstanceHierarchy Insert an existing InstanceHierarchy to this aml file as the Last InstanceHierarchy
Public method Insert_InterfaceClassLibHierarchy Insert an existing InterfaceClassLib to this aml file as the Last InterfaceClassLib
Public method Insert_RoleClassLibHierarchy Insert a RoleClassLib to this aml file as the Last RoleClassLib.
Public method Insert_SystemUnitClassLibHierarchy Append a SystemUnitClassLib to this aml file as the Last SystemUnitClassLib
Public method Insert_TypeBaseElement Generic method to insert an element of type TypeBase in this object. This method could be declared as abstract, but then all inherited classes have to implement this method but not all inherited classes use this method. (Inherited from CAEXBasicObject.)
Public method InstanceHierarchies Enumeration Method for all InstanceHierarchies of the CAEXFile.
Public method InterfaceClassLibraries Enumeration Method for all InterfaceClass Libraries of the CAEXFile.
Public methodStatic member IterateInternalElementsForLinks Iterating through all InternalElements starting with the given InternalElement and collecting all InternalLinks
Public method New_AdditionalInformation Adding a new AdditionalInformation node to this basic object. It is allowed to insert more than one AdditionalInformation node (Inherited from CAEXBasicObject.)
Public method New_Copyright Adding an new Copyright node to this object. If a Copyright node is already existent when calling this method an exception is thrown. (Inherited from CAEXBasicObject.)
Public method New_Description Creating a new description element. An exception is thrown when a description element is already present. (Inherited from CAEXBasicObject.)
Public method New_ExternalReferenceHierarchy A new ExternalReference node is added to the CAEX file.
Public method New_InstanceHierarchy Adding a new InstanceHierarchy to this CAEX file. The name attribute is set to "New InstanceHierarchy"; The Instance Hierarchy is always added as the last Instance Hierarchy.
Public method New_InterfaceClassLibHierarchy Adding a new InterfaceClassLib hierarchy node to this CAEX file.
Public method New_Revision Creating a new revision element. According to CAEX schema each revision element must contain at least the two sub elements "RevisionDate" and "AuthorName". They are created with this revision object. The sibling order according to the CAEX Schema is preserved in that way, that revision nodes are always inserted nodes of type VersionType (Inherited from CAEXBasicObject.)
Public method New_RoleClassLibHierarchy Adding a new RoleClassLib to this CAEX file.
Public method New_SystemUnitClassLibHierarchy Adding a new SystemUnitClassLib Hierarchy to this CAEX file.
Public method New_Version Creating a new version element. An exception is thrown when a version element is already present. The sibling order according to the CAEX Schema is preserved in that way, that version nodes are always inserted after nodes of type DescriptionType (Inherited from CAEXBasicObject.)
Public method PreorderTraversal Traversal method for a hierarchical tree, with identical childSelector for all tree nodes. The method uses a preorder algorithm without recursion for the deep traversal of the complete tree.
Public method RegisterCaexObjectsForNodeInsertedEvent Register an XMLNode Object for a NodeInserted Event in the CAEXFileTypes XMLDocument
Public method RegisterCaexObjectsForNodeRemovedEvent Register an XMLNode Object for a NodeRemoved Event in the CAEXFileTypes XMLDocument
Public method RemoveHeader Removing all header elements from this basic object (Inherited from CAEXBasicObject.)
Public method ReplaceObjectInHashList **Obsolete. ** Replace the object in the hash-list, necessary if the object has got a new CAEXWrapper. author: Josef Prinz
Public method RoleClassLibraries Enumeration Method for all RoleClass Libraries of the CAEXFile.
Public methodStatic member SchemaFileStream Get the file stream for the CAEX Schema.
Public method setSchemaLocation Sets the schema location in the CAEX File.
Public method SystemUnitClassLibraries Enumeration Method for all SystemUnitClass Libraries of the CAEXFile.
Public method UpdateCAEXObjectHashListsFastWithoutValidation **Obsolete. ** Updates the Hash Lists of all CAEXObjects. This Methods has a new Implementation in Version 3.0 and calls the UpdateAllTables(Boolean) Method, which uses additional Tables. The IDHashList and PathHashList are not used any more, but are still provided for downward compatibility.
Public method UpdateCAEXObjectHashListsWithValidation **Obsolete. ** Updates the Hash Lists of all CAEXObjects and checks the consistency of the CAEXObjects. This Methods has a new Implementation in Version 3.0 and calls the UpdateAllTables(Boolean) Method, which uses additional Tables. The IDHashList and PathHashList are not used any more, but are still provided for downward compatibility.
  Back to Top

Fields

 

Name Description
Public field AdditionalInformation The additional information (Inherited from CAEXBasicObject.)
Public field ChangeMode The change mode (Inherited from CAEXBasicObject.)
Public field ExternalReference The external reference
Public field FileName The file name
Public field InstanceHierarchy The instance hierarchy
Public field InterfaceClassLib The interface class library
Public field Revision The revision (Inherited from CAEXBasicObject.)
Public field RoleClassLib The role class library
Public field SchemaVersion The schema version
Public field SystemUnitClassLib The system unit class library
  Back to Top

Extension Methods

 

Name Description
Public Extension Method AddAutomationMLBPRInterfaceClassLib Adds the AutomationMLBPRInterfaceClassLib containing all interface classes used to model external document references to the AMLDocument. (Defined by ExternalDataReference.)
Public Extension Method AddAutomationMLBPRRoleClassLib Adds the AutomationMLBPRRoleClassLib containing all role classes used to model external document references to the AMLDocument. (Defined by ExternalDataReference.)
Public Extension Method AddExternalDataReferenceLibraries 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 Method AppendDocumentVersionInformation(DocumentVersionInformation, String) Overloaded.
Appends the provided document version information to the AutomationML document (Defined by DocumentVersions.)
Public Extension Method AppendDocumentVersionInformation(String, String, String) Overloaded.
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 Method AutomationMLBPRInterfaceClassLib Gets the AutomationMLBPRInterfaceClassLib containing all interface classes used to model external document references to the AMLDocument. (Defined by ExternalDataReference.)
Public Extension Method AutomationMLBPRRoleClassLib Gets the AutomationMLBPRRoleClassLib containing all role classes used to model external document references to the AMLDocument. (Defined by ExternalDataReference.)
Public Extension Method ClearMetaInformation Removes all "Writer Header" specific meta information out of this CAEX file. (Defined by BasicExtensions.)
Public Extension Method CopyToClipboard Copies the XML node's outer xml text to the clipboard. The Data format string is set to "CAEX". (Defined by AutomationMLClipboard.)
Public Extension Method CreateDocumentVersionsHeader Creates the additional information representing a document versions header and appends it to the AutomationML document. (Defined by DocumentVersions.)
Public Extension Method DeleteDocumentVersionInformation This function deletes all existing DocumentVersion information from the AutomationML document corresponding to the documentID. (Defined by DocumentVersions.)
Public Extension Method DeleteMetaInformation This function deletes any existing meta information corresponding to the writerID. (Defined by BasicExtensions.)
Public Extension Method DocumentVersionsHeader Get the Additional Information XML-Node from the CAEXFile, which represents the Document Versions node. (Defined by DocumentVersions.)
Public Extension Method ExternalDataReferenceInterfaceClass Gets the ExternalDataReference InterfaceClass from the AMLDocument. (Defined by ExternalDataReference.)
Public Extension Method ExternalDataRoleClass Gets the ExternalData RoleClass from the AMLDocument. (Defined by ExternalDataReference.)
Public Extension Method FindByID(String) Overloaded.
Searches an object starting from the given CAEXBasicObject that has the given ID, the expected type must be casted in the source code. This search bases on XPath and is slow. (Defined by NavigationExtensions.)
Public Extension Method FindByID(T)(String) Overloaded.
Searches an object starting from the given CAEXBasicObject that has the given ID, the expected type must be given in angle brackets. (Defined by NavigationExtensions.)
Public Extension Method FindByXPath(String) Overloaded.
Searches a CAEXBasicObject from the given path. The search bases on XPath and is slow. For speed optimization, use FindFastByPath instead. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.)
Public Extension Method FindByXPath(String) Overloaded.
Searches a CAEXBasicObject from the given xPath, you must cast the returned CAEXBasicObject into the type you expect. The search bases on XPath and is slow. For speed optimization, use FindFastByPath instead. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.)
Public Extension Method FindByXPath(T)(String) Overloaded.
Searches an object in the whole document that has the given Path. The search bases on XPath and is slow. For speed optimization, use FindFastByPath instead. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.)
Public Extension Method FindByXPath(T)(String) Overloaded.
Searches a CAEXBasicObject from the given xPath, the type must be given in angle brackets. The search bases on XPath and is slow. For speed optimization, use FindFastByPath instead. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.)
Public Extension Method FindFastByPath Performs a document wide fast search and returns a CAEXObject given by its ID. It is fast due to hash table support. If your CAEX file has changed, update the hash tables before using this function using updateCAEXObjectHashLists before. (Defined by NavigationExtensions.)
Public Extension Method ForEachInstanceHierarchy perform an action on each InstanceHierarchy in the CaexFile (Defined by ActionExtensions.)
Public Extension Method ForEachInterfaceClassLib perform an action on each InterfaceClassLib in the CaexFile (Defined by ActionExtensions.)
Public Extension Method ForEachRoleClassLib perform an action on each RoleClassLib in the CaexFile (Defined by ActionExtensions.)
Public Extension Method ForEachSystemUnitClassLib perform an action on each SystemUnitClassLib in the CaexFile (Defined by ActionExtensions.)
Public Extension Method GetAllDocumentVersionInformation This methods returns an Enumeration of all Informations related to document versions defined in the "DocumentVersions" information of an AutomationML document. (Defined by DocumentVersions.)
Public Extension Method GetAllInternalElements Returns an Enumerable of all internal elements in a CAEXFile from all Instance Hierarchies and all SystemUnitClass Libraries (Defined by ExternalizationExtensions.)
Public Extension Method GetAncestors(T) Gets all Ancestors in the Hierarchy of the specified Caex-Object, which are of Type T (Defined by NavigationExtensions.)
Public Extension Method GetAutomationMLVersion Returns the AutomationML Version of CAEX-File. This string is automatically be set by the AutomationML engine while creating a new CAEX document. (Defined by BasicExtensions.)
Public Extension Method GetChangeMode Returns the change mode out of the given CAEXBasicObject. (Defined by BasicExtensions.)
Public Extension Method GetClassLibrary(T) Enables every CAEXBasicObject, to get its class Library. You must specify the type of the ClassLibrary-Type that you expect. (Defined by NavigationExtensions.)
Public Extension Method GetDocumentVersionInformation This function returns the DocumentVersion Information from the AutomationML document with the specified document Identifier, otherwise null. (Defined by DocumentVersions.)
Public Extension Method GetLibraryOfCaexObject Gets the library of any caex object. (Defined by NavigationExtensions.)
Public Extension Method GetMetaInformation() Overloaded.
This methods returns an Enumeration of all "WriterHeader" meta information out of an existing AutomationML file. (Defined by BasicExtensions.)
Public Extension Method GetMetaInformation(String) Overloaded.
This function returns the MetaInformation corresponding to the writerID, otherwise null. (Defined by BasicExtensions.)
Public Extension Method GetParent(T) Enables every CAEXBasicObject to get its parent object as a CAEX_ClassModel class. You must specify the type of the CAEX_ClassModel type that you exspect. (Defined by NavigationExtensions.)
Public Extension Method GetParentNodeName Returns the AML node name of the parent (Defined by NavigationExtensions.)
Public Extension Method GetWriterHeader This methods returns an Enumeration of all "WriterHeader" meta information out of an existing AutomationML file. (Defined by BasicExtensions.)
Public Extension Method Import_ExternalReference Importing an InstanceHierarchy from another document context. Unlike method Insert_InstanceHierarchy(..) InstanceHierarchies that are coming from other files can be inserted. (Defined by ExternalizationExtensions.)
Public Extension Method Import_InstanceHierarchy Importing an InternalElement from another document context. Unlike method Insert_InternalElement(..) InternalElements that are coming from other files can be inserted. (Defined by ExternalizationExtensions.)
Public Extension Method Insert_ExternalReference Insert an existing InstanceHierarchy. (Defined by ExternalizationExtensions.)
Public Extension Method Insert_InstanceHierarchy Insert an existing InstanceHierarchy. (Defined by ExternalizationExtensions.)
Public Extension Method Name Get the Name of the specified object. (Defined by BasicExtensions.)
Public Extension Method New_Revision Creates a new Revision object including dataTime and AuthorName (Defined by SpecificExtensions.)
Public Extension Method OwnerDocument returns a CAEXDocument of an XML node (Defined by NavigationExtensions.)
Public Extension Method Remove Deletes the object from the AML document. (Defined by BasicExtensions.)
Public Extension Method ReplaceDocumentVersionInformation This function replaces any existing DocumentVersion information corresponding to the identical oldDocumentID with the provided new DocumentVersion information. (Defined by DocumentVersions.)
Public Extension Method ReplaceMetaInformation This function replaces any existing meta information corresponding to the identical oldWriterID with the new meta information defined in the newMetainformation (Defined by BasicExtensions.)
Public Extension Method SetAutomationMLVersion Allows setting the AutomationML Version of CAEX-File. The version string is automatically be set by the AutomationML engine while creating a new CAEX document. (Defined by BasicExtensions.)
Public Extension Method SetChangeMode Sets or removes the change mode of the given CAEXBasicObject. (Defined by BasicExtensions.)
Public Extension Method SetMetaInformation(MetaInformation) Overloaded.
This method is a short version of the setMetaInformation. Metadata with identical WriterID is replaced. (Defined by BasicExtensions.)
Public Extension Method SetMetaInformation(String, String, String, String, String, String, String, String, String) Overloaded.
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 BasicExtensions.)
Public Extension Method SetMetaInformationStandardAutomationMLLibrary 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 BasicExtensions.)
  Back to Top

See Also

Reference

CAEX_ClassModel Namespace

  • Introduction
  • [Version History](Version history)
    • [Version 3.5](Version 3.4)
    • [Version 3.1](Version 3.0)
    • [Version 2.1](Version 2.1)
    • [Version 2.0](Version 2.0)
  • [Getting Started](Getting started)
  • Examples
  • AMLEngine API
BEST Practice Content

Extensions

CAEX Elements

AutomationML

Utilities

Interfaceclasses

Exceptions

Objecttables and Document validation

Clone this wiki locally