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

Methods_T_CAEX_ClassModel_RoleRequirementsType

Jump to bottom
AutomationML edited this page Feb 23, 2017 · 2 revisions

RoleRequirementsType Methods

The RoleRequirementsType type exposes the following members.

Methods

 

Name Description
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 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 Equals Determines, if the specified Object and the current Object are equal. (Inherited from CAEXBasicObject.)
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 GetAttribute Gets the attribute with the specified name.
Public method getAttributeField Get the whole attribute field containing a collection of all attributes of this object.
Public method GetDerivedAttributes A RoleRequirementsType does not have any class references and therefore no derived attributes
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 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 Insert_Attribute Inserting an attribute element to this class
Public method Insert_Element Inserting an element generically to this object.
Public method Insert_ExternalInterface Inserting an externalInterface to this class.
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 MergeContent Merging the content of this RoleRequirement class with the given RoleRequirement class by copying all attributes and external interfaces.
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_Attribute A new attribute is created and returned.
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_ExternalInterface Adding a new ExternalInterface.
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_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 RemoveHeader Removing all header elements from this basic object (Inherited from CAEXBasicObject.)
Public method ResolveExternalInterfaceReferences Resolving references to ExternalInterfaces that are contained in this class. ExternalInterface with class references in this class are replaced with instances of the referenced interface classes. There is no need to recursive call this method, because interface are not allowed to contain sub-interfaces
  Back to Top

Extension Methods

 

Name Description
Public Extension Method All Returns a flat list of all attributes of an object, nested attributes inclusive. (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 CreateListAttribute Creates a new list attribute for an element which can have attributes. (Defined by ListAttribute.)
Public Extension Method FindAttributeWithPath Tries to find an attribute among the attributes of the specified objectWithAttributes which is uniquely identified with the specified attribute path. The attribute path should be a concatenation of names of nested attributes - don't use the full node path to locate an attribute with this method AttributePath. (Defined by FacetType.)
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 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 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 GetAncestors(T) Gets all Ancestors in the Hierarchy of the specified Caex-Object, which are of Type T (Defined by NavigationExtensions.)
Public Extension Method GetAttribute(String) Overloaded.
Finds an attribute with a given name. (Defined by BasicExtensions.)
Public Extension Method GetAttribute(String) Overloaded.
Gets the attribute with the specified name. (Defined by ObjectWithAttributes.)
Public Extension Method GetAttributeValue Returns an attribute value of a given attribute name. (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 GetLibraryOfCaexObject Gets the library of any caex object. (Defined by NavigationExtensions.)
Public Extension Method GetOwnAndDerivedAttributes Get all Attributes of the CAEXObjects, including all own and derived attributes (Defined by MappingExtension.)
Public Extension Method GetParent() Overloaded.
Enables every CAEXBasicObject to get its parent object as a CAEX_ClassModel class. You must cast the result in your own code. (Defined by BasicExtensions.)
Public Extension Method GetParent(T)() Overloaded.
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 IsAutomationMLBaseRole Determines whether the specified role reference defines an inheritance relation from the AutomationMLBaseRole RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsDerivedFromRoleClass Determines whether the specified role reference defines an inheritance relation from the role, uniquely identifyable by the given role class path. The role class path may contain an alias. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsFacet Determines whether the specified role reference defines an inheritance relation from the Facet RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsFrame Determines whether the specified role reference defines an inheritance relation from the Frame RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsGroup Determines whether the specified role reference defines an inheritance relation from the Group RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsLogicObject Determines whether the specified role reference defines an inheritance relation from the LogicObject RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsPort Determines whether the specified role reference defines an inheritance relation from the Port RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsProcess Determines whether the specified role reference defines an inheritance relation from the Process RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsProcessStructure Determines whether the specified role reference defines an inheritance relation from the ProcessStructure RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsProduct Determines whether the specified role reference defines an inheritance relation from the Product RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsProductStructure Determines whether the specified role reference defines an inheritance relation from the ProductStructure RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsPropertySet Determines whether the specified role reference defines an inheritance relation from the PropertySet RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsResource Determines whether the specified role reference defines an inheritance relation from the Resource RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsResourceStructure Determines whether the specified role reference defines an inheritance relation from the ResourceStructure RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method IsStructure Determines whether the specified role reference defines an inheritance relation from the Structure RoleClass (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeAutomationMLBaseRole Makes the AutomationML base role. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeFacet Makes the facet. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeGroup Makes the group. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakePort Makes the port. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeProcess Makes the process. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeProcessStructure Makes the process structure. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeProduct Makes the product. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeProductStructure Makes the product structure. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakePropertySet Makes the property set. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeResource Makes the resource. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeResourceStructure Makes the resource structure. (Defined by AutomationMLBaseRoleClassLib.)
Public Extension Method MakeStructure Makes the structure. (Defined by AutomationMLBaseRoleClassLib.)
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 RoleRequirementIsSupportedBySystemUnitClass Test, if RoleRequirement ist directly supported from any SupportedRole of the SystemUnitClass (Defined by MappingExtension.)
Public Extension Method SetAttributeValue(String, String) Overloaded.
Sets an attribute value (creates attribute if it does not exist) as child of the parent object parameter. (Defined by ObjectWithAttributes.)
Public Extension Method SetAttributeValue(String, Double) Overloaded.
Sets an attribute value (creates attribute if it does not exist) as child of the parent object parameter. Sets the AttributeDataType to xs:double (Defined by ObjectWithAttributes.)
Public Extension Method SetAttributeValue(String, String, String, String) Overloaded.
Sets an attribute value (creates attribute if it does not exist). (Defined by ObjectWithAttributes.)
Public Extension Method SetAttributeValue(String, Double, Double, String, String) Overloaded.
Sets an attribute value (creates attribute if it does not exist). Sets the AttributeDataType to xs:double (Defined by ObjectWithAttributes.)
Public Extension Method SetAttributeValue(String, String, String, String, String, String) Overloaded.
Sets an attribute value (creates attribute if it does not exist). (Defined by ObjectWithAttributes.)
Public Extension Method SetChangeMode Sets or removes the change mode of the given CAEXBasicObject. (Defined by BasicExtensions.)
  Back to Top

See Also

Reference

RoleRequirementsType Class
CAEX_ClassModel Namespace

AMLEngine Documentation

Copyright © AutomationML Association 2016

Send comments on this topic to [AutomationML office](mailto:office%40automationml.org?Subject=AMLEngine Documentation)
  • 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