This repository has been archived by the owner on Jun 22, 2019. It is now read-only.
Methods_T_AMLEngineExtensions_BasicExtensions
The BasicExtensions type exposes the following members.
| Name | Description | |
|---|---|---|
 
|
AddInstance | Inserts a new class instance to the parentInternalElement. If there are existing instances of the same Type, the Element is inserted after the last Element of that Type. Before Insertion, the Uniqueness of the Name among the siblings of that Type is checked. |
|
|
AddInternalElement | Add an internalElement to the parentInstanceHierarchy. If there are existing internalElements, the Element is inserted after the last Child. Before Insertion, the Uniqueness of the Name among the children is checked. |
|
|
AddNewInternalElement(InstanceHierarchyType, String) | Creates a new InternalElement and inserts it after the last InternalElement of the parent InstanceHierarchy if the elementName is unique among the childs. The ChangeMode is set to the Value 'Create' |
|
|
AddNewInternalElement(SystemUnitClassType, String) | Creates a new InternalElement and inserts it after the last InternalElement of the parent if the elementName is unique among the childs. The ChangeMode is set to the Value 'Create' |
|
|
All | Returns a flat list of all attributes of an object, nested attributes inclusive. |
|
|
ClearMetaInformation | Removes all "Writer Header" specific meta information out of this CAEX file. |
|
|
Clone_Save(T) | Clones a CAEX Object. |
|
|
DeleteMetaInformation | This function deletes any existing meta information corresponding to the writerID. |
|
|
GetAllFullRolePathNamesForRequiredRoles | Gets all full role path names of the required roles for the given internal element. |
|
|
GetAllFullRolePathNamesForSupportedRoles | Gets all full role path names of the supported roles for the given internal element. |
|
|
GetAllRoleNamesForRequiredRoles | Gets all role names of the required roles for the given internal element. |
|
|
GetAllRoleNamesForSupportedRoles | Gets all role names of the supported roles for the given internal element. |
|
|
GetAttribute(IObjectWithAttributes, String) | Finds an attribute with a given name. |
|
|
GetAttribute(MemberElement_Attribute, String) | Finds an attribute with a given name. |
|
|
GetAttributeValue | Returns an attribute value of a given attribute name. |
|
|
GetAutomationMLVersion | Returns the AutomationML Version of CAEX-File. This string is automatically be set by the AutomationML engine while creating a new CAEX document. |
|
|
GetChangeMode | Returns the change mode out of the given CAEXBasicObject. |
|
|
GetClassName(InterfaceClassType) | Returns the class name of the given external interface. |
|
|
GetClassName(InternalElementType) | Returns the class name of the given InternalElement. |
|
|
GetFullClassName(InterfaceClassType) | Returns the full class name of the given external interface. |
|
|
GetFullClassName(InternalElementType) | Returns the class name of the given InternalElement. |
|
|
GetMetaInformation(CAEXFileType) | This methods returns an Enumeration of all "WriterHeader" meta information out of an existing AutomationML file. |
|
|
GetMetaInformation(CAEXFileType, String) | This function returns the MetaInformation corresponding to the writerID, otherwise null. |
|
|
GetMetaObjectInformation(CAEXObject) | this methods returns the meta information out of an existing AutomationML file for an AutomationML Object |
|
|
GetMetaObjectInformation(CAEXObject, String) | this methods returns the meta information out of an existing AutomationML file for an AutomationML Object and a specific Writer-ID |
|
|
GetParent | Enables every CAEXBasicObject to get its parent object as a CAEX_ClassModel class. You must cast the result in your own code. |
|
|
GetRefBaseClassPath(InterfaceClassType) | Get the RefBaseClassPath of the given external interface. |
|
|
GetRefBaseClassPath(RoleClassType) | Get the ClassPath of a RoleClass (Inheritance Relation) |
|
|
GetRefBaseClassPath(SystemUnitClassType) | Get the ClassPath of a SystemUnitClassType (Inheritance Relation) |
|
|
GetRefBaseSystemUnitPath | Returns the path of the referenced SystemUnitClass with path information, or an empty string if not available. |
|
|
GetRoleName | Gets the role name of the given internal element. |
|
|
GetWriterHeader | This methods returns an Enumeration of all "WriterHeader" meta information out of an existing AutomationML file. |
|
|
HasColladaInterface | Determines whether the specified systemUnitClass has a collada interface. |
|
|
HasPLCOpenInterface | Determines whether the specified systemUnitClass has a PLCOpen interface. |
|
|
HasRoleReference(InternalElementType, String) | Checks, if a role reference is present in the RoleRequirements or the SupportedRoleClasses of the given internal element. |
|
|
HasRoleReference(SystemUnitClassType, RoleClassType) | Checks, if a role reference to the RoleClass is present in the SupportedRoleClasses of the given systemUnitClass. |
|
|
HasRoleReference(SystemUnitClassType, String) | Checks, if a role reference is present in the SupportedRoleClasses of the given systemUnitClass. |
|
|
Name | Get the Name of the specified object. |
|
|
Remove | Deletes the object from the AML document. |
|
|
RemoveSubElements(T) | Removes all InternalElement and ExternalInterface Elements from a SystemUnit Class. |
|
|
Replace(T) | Replaces a CaexObject by another CaexObject |
|
|
ReplaceMetaInformation | This function replaces any existing meta information corresponding to the identical oldWriterID with the new meta information defined in the newMetainformation |
|
|
RoleReference | returns the role reference if it is present in the RoleRequirements or the SupportedRoleClasses of the given internal element. |
|
|
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. |
|
|
SetChangeMode | Sets or removes the change mode of the given CAEXBasicObject. |
|
|
SetMetaInformation(CAEXFileType, MetaInformation) | This method is a short version of the setMetaInformation. Metadata with identical WriterID is replaced. |
|
|
SetMetaInformation(CAEXFileType, String, String, String, String, String, String, String, String, String) | 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. |
|
|
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. |
|
|
SetMetaObjectInformation(CAEXObject, MetaObjectInformation) | this method is a short version of the setMetaInformation for any caex object |
|
|
SetMetaObjectInformation(CAEXObject, String, String, String) | this function sets the meta information to store tool specific object-IDs |
|
|
SetRole | Sets the role class path of the provided InternalElement. |