 | Supported |
This class is a wrapper for the CAEXElement 'SupportedRoleClass' assignable to
a SystemUnitClass. Associated supported roles of a SystemUnitClass are used to specify some
semantic meanings like features or functions for the associated object.
Inheritance HierarchySystemObject
Aml.Engine.CAEXCAEXWrapper
Aml.Engine.CAEXCAEXBasicObject
Aml.Engine.CAEXSupportedRoleClassType
Aml.Engine.CAEXCAEXWrapper
Aml.Engine.CAEXCAEXBasicObject
Aml.Engine.CAEXSupportedRoleClassType
Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
SyntaxThe SupportedRoleClassType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SupportedRoleClassType | Initializes a new instance of the SupportedRoleClassType class. |
Properties| Name | Description | |
|---|---|---|
 | AdditionalInformation |
Gets the collection of AdditionalInformation values contained in this instance.
(Inherited from CAEXBasicObject) |
| CAEXDocument |
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) |
| CAEXParent |
Gets the CAEXParent of this instance if it exists.
(Inherited from CAEXWrapper) |
| CAEXSequenceOfCAEXObject |
Gets the CAEXSequence containing this CAEX object
(Inherited from CAEXWrapper) |
| ChangeMode |
Gets and sets the change mode for a CAEX element (Optional in CAEX).
(Inherited from CAEXBasicObject) |
| Copyright |
Gets and sets the Copyright for this object.
(Inherited from CAEXBasicObject) |
| CopyrightElement |
Gets the wrapper for the Copyright element.
(Inherited from CAEXBasicObject) |
| Description |
Gets and sets the Description for this object.
(Inherited from CAEXBasicObject) |
| DescriptionElement |
Gets the wrapper for the Description element.
(Inherited from CAEXBasicObject) |
| Document |
Gets the XDocument of the wrapped XML-Element
(Inherited from CAEXWrapper) |
| Exists |
Determines if this is a wrapper around an existing XML-Element
(Inherited from CAEXWrapper) |
| IsDeleted |
Determines, if this object is not contained in any document
(Inherited from CAEXWrapper) |
| MappingObject | Gets the MappingObject associated with a SupportedRoleClass. Mapping objects are used to define mappings between properties of the associated object and the role class itself. |
| Node |
Gets the wrapped XML-Element
(Inherited from CAEXWrapper) |
| Owner |
Gets the wrapped Xml-Element's parent
(Inherited from CAEXWrapper) |
| RefRoleClassPath | Gets and sets the Attribute ATTRIBUTE_NAME_REFROLECLASSPATH of this SupportedRoleClass object. |
| Revision |
Gets the collection of Revision objects contained in this instance.
(Inherited from CAEXBasicObject) |
| RoleClass | Gets and sets the RoleClass, referenced from this SupportedRoleClass object using the RefRoleClassPath. |
| RoleReference | Gets or sets the role reference. This property is equivalent to RefRoleClassPath. |
| SourceObjectInformation |
Gets the collection of SourceObjectInformation objects contained in this instance.
(Inherited from CAEXBasicObject) |
| SystemUnitClass | Gets the associated SystemUnitClass for this SupportedRoleClass object. |
| TagName |
Gets the name of the CAEX tag for this CAEX object.
(Inherited from CAEXWrapper) |
| Version |
Gets and sets the Version for this object.
(Inherited from CAEXBasicObject) |
| VersionElement |
Gets the wrapper for the Version element.
(Inherited from CAEXBasicObject) |
Methods| Name | Description | |
|---|---|---|
| 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 instance, which contains the specified CAEX object.
For example, if the specified object is a revision object,
the sequence of the revision objects Revision is returned.
(Inherited from CAEXBasicObject) |
| 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) |
| 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 SupportedRoleClassType
defines the MappingType (Overrides CAEXBasicObjectInsert(CAEXWrapper, Boolean)) |
| Insert(Int32, CAEXWrapper) |
Inserts the specified CAEX object in it's associated sequence. The SupportedRoleClassType
defines the MappingType (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) |
| New_MappingObject | Adding a new MappingObject element to this SupportedRoleClass. |
| 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) |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged |
The Change event raised when any property is modified.
(Inherited from CAEXWrapper) |
Extension Methods| Name | Description | |
|---|---|---|
 | AllLibraryReferences |
Gets all libraries which are referenced by this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| 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) |
| 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) |
| 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) |
| FindCaexObjectFromIdT |
Finds the CAEX object with the specified id and the specified Type.
(Defined by CAEXBasicObjectExtensions) |
| 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) |
| 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) |
| 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_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_MappingObject |
Adding a MappingObject element to this Supported Role.
(Defined by AMLEngineAdapter) |
| 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) |
| 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_Description |
Adds an new Description node to this object if it doesn't exists.
(Defined by CAEXBasicObjectExtensions) |
See Also