InterfaceNameMappingTypeRoleClassMappingElements Method

Gets the collection of possible mapping identifiers for this InterfaceNameMappingType for elements of the mapped RoleClass. The Collection contains all ExternalInterfaces (including inherited) of the RoleClass. The ExternalInterface Name is used as the Mapping identifier.

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

public override IEnumerable<(ExternalInterfaceType CaexObject, string MappingIdentifier)> RoleClassMappingElements(
	bool includeDuplicates = false
)

Public Overrides Function RoleClassMappingElements ( 
	Optional includeDuplicates As Boolean = false
) As IEnumerable(Of (CaexObject As ExternalInterfaceType, MappingIdentifier As String))

public:
virtual IEnumerable<ValueTuple<ExternalInterfaceType^, String^>>^ RoleClassMappingElements(
	bool includeDuplicates = false
) override

Parameters

includeDuplicates Boolean (Optional): if set to true duplicate identifiers are included.

Return Value

IEnumerableValueTupleExternalInterfaceType, String
The possible mapping identifiers to map ExternalInterfaces of the RoleClass.

Remarks

The MultipleRole Concept in AutomationML 2.0 based on CAEX 2.15 allows the definition of Mappings to SupportedRoleClass objects. These Elements are only included in this collection, if a qualified element has been already assigned to the RoleRequirements object. To get the possible qualified RoleClass ExternalInterfaces, which are not already assigned to the RoleRequirements object, the method UnAssignedQualifiedRoleClassInterfacesOfMultipleRoles can be used.

If an instance supports multiple roles and the requirements to the different roles shall be stored at the instance, this shall be done using the CAEX element "RoleRequirements" whereas the corresponding attributes or interfaces are directly assigned including the role name, a separator string "." and the attribute or interface name.

Reference

InterfaceNameMappingType Class

Aml.Engine.CAEX Namespace