 | Role |
The RoleRequirementsType type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AssignQualifiedRoleClassAttribute | This method supports the Multiple Roles concept in AutomationML 2.0, based on CAEX 2.15. The method is not applicable for documents, based on CAEX 3.0 and later. It tests, if the provided Attribute object is a role class attribute of a supported role class object which can be used in a Multiple role mapping and assigns it to this RoleRequirements instance. |
| AssignQualifiedRoleClassInterface | This method supports the Multiple Roles concept in AutomationML 2.0, based on CAEX 2.15. The method is not applicable for documents, based on CAEX 3.0 and later. It tests, if the provided ExternalInterface object is a role class interface of a supported role class object which can be used in a Multiple role mapping and assigns it to this RoleRequirements instance. |
| CAEXChild |
Gets the first child of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper) |
| CAEXChildren |
Gets all children of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper) |
| CAEXSequence |
Gets the CAEXSequence owned by this CAEX object, which contains the specified CAEX object.
(Overrides CAEXBasicObjectCAEXSequence(ICAEXWrapper)) |
| ContainerT |
Gets the CAEX Container for elements of type T, which is owned by this CAEX object
(Inherited from CAEXBasicObject) |
| Copy |
Creates a deep copy of this CAEX object
(Inherited from CAEXWrapper) |
| Equals |
Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper) |
| GetHashCode |
Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper) |
| GetXAttributeValue |
Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element.
(Inherited from CAEXWrapper) |
| HasRoleClassReference | Determines whether this RoleRequirements object has an associated reference to the provided RoleClass. If inheritance relations between RoleClasses should be regarded, the optional parameter 'regardInheritance' should be set. In this case the specified RoleClass is either identical to the referenced RoleClass or the referenced RoleClass is derived from the provided RoleClass. |
| Import |
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)) |
| Insert(CAEXWrapper, Boolean) |
Inserts the specified CAEX object in it's associated sequence. The RoleRequirementsType
defines the Attribute and ExternalInterface sequence.
(Overrides CAEXBasicObjectInsert(CAEXWrapper, Boolean)) |
| Insert(Int32, CAEXWrapper) |
Inserts the specified CAEX object in it's associated sequence. The RoleRequirementsType
defines the Attribute and ExternalInterface sequence.
(Overrides CAEXBasicObjectInsert(Int32, CAEXWrapper)) |
| InsertNew |
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) |
| IsAssignableRoleClassAttribute | This method supports the Multiple Roles concept in AutomationML 2.0, based on CAEX 2.15. The method is not applicable for documents, based on CAEX 3.0 and later. It tests, if the provided attribute is a role class attributes of a supported role class object which can be used in a Multiple role mapping and is assignable to this RoleRequirements instance |
| IsAssignableRoleClassInterface | This method supports the Multiple Roles concept in AutomationML 2.0, based on CAEX 2.15. The method is not applicable for documents, based on CAEX 3.0 and later. It tests, if the provided ExternalInterface object is a role class interface of a supported role class object which can be used in a Multiple role mapping and is assignable to this RoleRequirements instance |
| New_MappingObject | Adding a new MappingObject element to this RoleRequirements object. |
| New_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) |
| Remove |
Removes this element. After that it is no longer assigned to a document and has no owner anymore.
(Inherited from CAEXWrapper) |
| SetXAttributeValue |
Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null).
(Inherited from CAEXWrapper) |
| UpdateInstance | Updates the RoleRequirement using added attributes andd added external interfaces of the referenced RoleClass. |
Extension Methods| Name | Description | |
|---|---|---|
  | AddAttributeTypeReference |
Adds an AttributeType reference to this ObjectWithAttribute using the provided
AttributeType object. The AttributeType reference is added as
a AttributeType object.
(Defined by ObjectWithAttributes) |
| AddAttributeTypeReference |
Adds an AttributeType reference to this ObjectWithAttribute using the provided
CAEX path, referencing an AttributeType object. The AttributeType reference is added as
a AttributeType object.
(Defined by ObjectWithAttributes) |
| AddInterfaceClassReference |
Adds an InterfaceClass reference to this ObjectWithExternalInterface using the provided
InterfaceClass object. The InterfaceClass reference is added as
a ExternalInterfaceType object.
(Defined by ObjectWithExternalInterface) |
| AddInterfaceClassReference |
Adds an InterfaceClass reference to this ObjectWithExternalInterface using the provided
CAEX path, referencing an InterfaceClass object. The InterfaceClass reference is added as
a ExternalInterfaceType object.
(Defined by ObjectWithExternalInterface) |
| AllLibraryReferences |
Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| AMLAttributes |
Conversion of any object which has an attribute collection to get access
to specific AutomationML defined attributes.
(Defined by AmlObjectsExtensions) |
| AMLSchemaManager |
Gets the associated CAEX schema manager of the CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| Ancestors |
Finds all ancestors of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| AncestorsT |
Finds the ancestors of the provided CAEX object which have the given type.
(Defined by CAEXBasicObjectExtensions) |
| Attributes |
Enumeration Method for direct Children of Type AttributeType (Defined by AMLEngineAdapter) |
| AutomationMLEdition |
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) |
| CAEXDocument |
Gets the CAEX document which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| CAEXFile |
Gets the CAEX file which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| CAEXSchema |
Gets the associated CAEX schema of the CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| clone | Copy(Boolean, Boolean, Boolean) (Defined by AMLEngineAdapter) |
| CloneNode |
Clones the node.
(Defined by AMLEngineAdapter) |
| ConsistencyCheck_ClassReference |
Check if the given classPath is a valid path to an existent class in the AML file.
(Defined by AMLEngineAdapter) |
| CopyAttributesFrom |
Copies all attribute of the source object with attributes to the target object including
children
(Defined by ObjectWithAttributes) |
| CreateListAttribute |
Creates a new list attribute for an element which can have attributes.
(Defined by ListAttribute) |
| Descendants |
Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| Descendants |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| ExternalInterfaces |
Enumeration Method for direct Children of Type InterfaceClassType (Defined by AMLEngineAdapter) |
| FindCaexObjectFromIdT |
Finds the CAEX object with the specified id and the specified Type.
(Defined by CAEXBasicObjectExtensions) |
| findExternalInterface |
Searches for an ExternalInterface in this InternalElement
(Defined by AMLEngineAdapter) |
| findInternalElement |
Resolve a reference to an InternalElement and return the referenced element if found.
(Defined by AMLEngineAdapter) |
| FindReferencedClassT |
Finds the CAEX object with the specified CAEX path and the specified Type.
(Defined by CAEXBasicObjectExtensions) |
| FirstAncestor |
Finds the first ancestor of the specified CAEX object which fulfils the specified predicate
(Defined by CAEXBasicObjectExtensions) |
| FirstAncestor |
Finds the first ancestor of the specified CAEX object with the given Tag name
(Defined by CAEXBasicObjectExtensions) |
| FirstAncestorT |
Finds the first ancestor of the specified CAEX object in the given Type.
(Defined by CAEXBasicObjectExtensions) |
| FrameAttribute |
Gets a defined FrameAttribute from the Attribute
collection of the IObjectWithAttributes.
If no such attribute exists, null is returned.
(Defined by AmlObjectsExtensions) |
| GetAttribute |
Gets the first attribute with the specified name from the attribute collection of the CAEX object.
(Defined by ObjectWithAttributes) |
| getAttributeField |
Get the whole attribute field containing a collection of all attributes of this object.
(Defined by AMLEngineAdapter) |
| GetAttributeValue |
Returns an attribute value of a given attribute name.
(Defined by AMLEngineAdapter) |
| GetExternalInterfaces |
Gets the external interfaces.
(Defined by AMLEngineAdapter) |
| GetParentT |
Tries to get a CAEX parent with the specified Type of the provided caexObject. If the parent is
not assignable to the provided type, the result is null.
(Defined by CAEXBasicObjectExtensions) |
| getReferencedClass |
Getting the XML Node for a class path.
(Defined by AMLEngineAdapter) |
| getReferencedGUID |
Parsing a string of form GUID:Interface and returning the GUID
(Defined by AMLEngineAdapter) |
| getReferencedInterfaceClass |
Getting a referenced InterfaceClass. Use FindFastByPath for speed optimizations.
(Defined by AMLEngineAdapter) |
| getReferencedInterfaceName |
Getting the name of the referenced Interface.
(Defined by AMLEngineAdapter) |
| HasInterfaceClassReference |
Determines whether an object with ExternalInterfaces has an associated reference to
the specified InterfaceClass. If inheritance relations between InterfaceClasses should be regarded, the
optional parameter 'regardInheritance' should be set. In this case the specified InterfaceClass is either identical
to a referenced InterfaceClass or a referenced InterfaceClass is derived from the specified InterfaceClass.
(Defined by ObjectWithExternalInterface) |
| HasInterfaceClassReference |
Determines whether this Object with ExternalInterfaces has an associated InterfaceClass reference
with the specified CAEX path interface reference. If inheritance relations between interface classes should be
regarded, the
optional parameter 'regardInheritance' should be set. In this case the specified InterfaceClass is either identical
to a referenced InterfaceClass or a referenced InterfaceClass is derived from the specified InterfaceClass.
(Defined by ObjectWithExternalInterface) |
| HasNewVersion |
Determines, if this caex object has a related newer version
(Defined by CAEXBasicObjectExtensions) |
| HasOldVersion |
Determines, if this caex object has a related older version
(Defined by CAEXBasicObjectExtensions) |
| Insert_Attribute |
Inserts an Attribute object in the Attribute collection of the objectWithAttributes.
(Defined by SystemUnitClassTypeExtensions) |
| Insert_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) |
| Insert_ExternalInterface |
Inserting an ExternalInterface to the ExternalInterface-Collection of the
objectWithExternalInterface.
The Element is inserted at the first Element
of any existing ExternalInterfaces if no other position is defined.
(Defined by SystemUnitClassTypeExtensions) |
| Insert_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) |
| Insert_TypeBaseElement | Insert(CAEXWrapper, Boolean) (Defined by AMLEngineAdapter) |
| InterfaceClassReferences |
All external Interfaces of this Object with ExternalInterfaces with an associated InterfaceClass reference
with the specified CAEX path interface reference. If inheritance relations between interface classes should be
regarded, the
optional parameter 'regardInheritance' should be set. In this case the specified InterfaceClass is either identical
to a referenced InterfaceClass or a referenced InterfaceClass is derived from the specified InterfaceClass.
(Defined by ObjectWithExternalInterface) |
| IsAMLObject |
Determines whether the CAEX object is an AutomationML object. If the CAEX object is a SystemUnitClass or
InternalElement,
it is checked, if there exists a role reference to the AutomationMLBaseRole. If the CAEX object is an
ExternalInterface,
it is checked, if there exists an InterfaceClass reference to an AutomationMLBase Interface.
(Defined by AmlObjectsExtensions) |
| IsAutomationMLBaseRole |
Determines whether the specified role reference defines an inheritance relation from the
AutomationMLBaseRole RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsDerivedFromRoleClass |
Determines whether the specified role reference defines an inheritance relation from the role,
uniquely identifiable by the given role class path. The role class path may contain an alias.
(Defined by InheritanceExtensions) |
| IsFacet |
Determines whether the specified role reference defines an inheritance relation from the
Facet RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsFrame |
Determines whether the specified role reference defines an inheritance relation from the
Frame RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsGroup |
Determines whether the specified role reference defines an inheritance relation from the
Group RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsInterlockingSourceGroup |
Determines whether the specified role reference defines an inheritance relation from the
InterlockingSourceGroup RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsInterlockingTargetGroup |
Determines whether the specified role reference defines an inheritance relation from the
InterlockingTargetGroup RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsLogicObject |
Determines whether the specified role reference defines an inheritance relation from the
LogicObject RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsPort |
Determines whether the specified role reference defines an inheritance relation from the
Port RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsProcess |
Determines whether the specified role reference defines an inheritance relation from the
Process RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsProcessStructure |
Determines whether the specified role reference defines an inheritance relation from the
ProcessStructure RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsProduct |
Determines whether the specified role reference defines an inheritance relation from the
Product RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsProductStructure |
Determines whether the specified role reference defines an inheritance relation from the
ProductStructure RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsPropertySet |
Determines whether the specified role reference defines an inheritance relation from the
PropertySet RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsResource |
Determines whether the specified role reference defines an inheritance relation from the
Resource RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsResourceStructure |
Determines whether the specified role reference defines an inheritance relation from the
ResourceStructure RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| IsStructure |
Determines whether the specified role reference defines an inheritance relation from the
Structure RoleClass
(Defined by AutomationMLBaseRoleClassLib) |
| Library |
Gets the Library which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| MakeAutomationMLBaseRole |
Makes the AutomationML base role.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeFacet |
Makes the facet.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeGroup |
Makes the group.
(Defined by AutomationMLBaseRoleClassLib) |
| MakePort |
Makes the port.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeProcess |
Makes the process.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeProcessStructure |
Makes the process structure.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeProduct |
Makes the Product.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeProductStructure |
Makes the product structure.
(Defined by AutomationMLBaseRoleClassLib) |
| MakePropertySet |
Makes the property set.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeResource |
Makes the resource.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeResourceStructure |
Makes the resource structure.
(Defined by AutomationMLBaseRoleClassLib) |
| MakeStructure |
Makes the structure.
(Defined by AutomationMLBaseRoleClassLib) |
| Name |
Get the Name of the specified object.
(Defined by AMLEngineAdapter) |
| Name |
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) |
| New_Attribute |
Appends a new Attribute object with the defined name to the specified CAEX object.
(Defined by ObjectWithAttributes) |
| New_Description |
Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
| New_ExternalInterface |
Adding a new ExternalInterface instance to the ExternalInterface-Collection of the
objectWithExternalInterface.
The New ExternalInterface is inserted as the
first ExternalInterface of any existing Interfaces if nothing else is explicit defined.
(Defined by SystemUnitClassTypeExtensions) |
| New_ExternalInterface |
Adding a new ExternalInterface instance to the ExternalInterface-Collection of the
objectWithExternalInterface referencing a specific InterfaceClass.
The New ExternalInterface is inserted as the
first ExternalInterface of any existing Interfaces if nothing else is explicit defined.
The provided interfaceClassPath is set as the RefBaseClassPath value.
(Defined by SystemUnitClassTypeExtensions) |
| New_FrameAttribute |
Creates a new Frame attribute for the IObjectWithAttributes if no Frame
attribute exists.
The provided values are used to initialize the Frame attribute values.
(Defined by AmlObjectsExtensions) |
| OfInterfaceClass |
Gets all ExternalInterface objects from the specified objectWithExternalInterface, which are
derived from an
InterfaceClass, identified with the given interfaceClassPath.
(Defined by ExternalInterfaceTypeExtensions) |
| RefTypeAttribute |
Gets the RefTypeAttributeTypefrom the objectWithAttributes if one exists.
This Attribute is defined for a COLLADAInterface.
(Defined by AmlObjectsExtensions) |
| RefURIAttribute |
Gets the RefURIAttributeType from the objectWithAttributes if one exists.
(Defined by AmlObjectsExtensions) |
| SetAttributeValue |
Sets a value for the attribute from a string with the specified name from the attribute collection of the CAEX object.
If no attribute with that name exists, it is created.
(Defined by ObjectWithAttributes) |
| SetAttributeValue |
Modifies the attribute with the specified name from the attribute collection of the CAEX object, using
the provided double value. If no attribute with that name exists, it is created.
Sets the AttributeDataType to xs:double. To change existing attributes it is recommended to use
indexers (see examples below).
(Defined by ObjectWithAttributes) |
| SetAttributeValue |
Modifies the attribute with the specified name from the attribute collection of the CAEX object, using
the provided values. If no attribute with that name exists, it is created.
(Defined by ObjectWithAttributes) |
| SetAttributeValue |
Modifies the attribute with the specified name from the attribute collection of the CAEX object, using
the provided values. If no attribute with that name exists, it is created. Sets the AttributeDataType to xs:double
(Defined by ObjectWithAttributes) |
| SetAttributeValue |
Modifies the attribute with the specified name from the attribute collection of the CAEX object, using
the provided values. If no attribute with that name exists, it is created.
(Defined by ObjectWithAttributes) |
| SetAttributeValueT |
Sets a typed value for the attribute with the specified name from the attribute collection of the CAEX object.
If no attribute with that name exists, it is created. The correct encoding for the attribute value xml representation
is automatically defined.
(Defined by ObjectWithAttributes) |
See Also