M_AMLEngineExtensions_MappingExtension_InternalElementMappsToSystemUnitClassWithAncestorRole

MappingExtension.InternalElementMappsToSystemUnitClassWithAncestorRole Method

Test, if an InternalElements RoleRequirement is supported from any SupportedRole of the SystemUnitClass and the SupportedRole is an Ancestor of the Required Role. The returned result is the Ancestor Generation of the Supported Role (-1=no Ancestor, 0=Identical, 1=Parent, 2=GrandParent, ...)

Namespace: AMLEngineExtensions
Assembly: AMLEngineExtensions (in AMLEngineExtensions.dll) Version: 3.5

Syntax

C#

public static int InternalElementMappsToSystemUnitClassWithAncestorRole(
	this InternalElementType internalElement,
	SystemUnitClassType systemUnitClass,
	out SupportedRoleClassType supportedRole
)

C++

public:
[ExtensionAttribute]
static int InternalElementMappsToSystemUnitClassWithAncestorRole(
	InternalElementType^ internalElement, 
	SystemUnitClassType^ systemUnitClass, 
	[OutAttribute] SupportedRoleClassType^% supportedRole
)

Parameters

 

internalElement

Type: CAEX_ClassModel.InternalElementType
The InternalElement which should be mapped on a SystemUnitClass

systemUnitClass

Type: CAEX_ClassModel.SystemUnitClassType
The SystemUnitClass, which is tested as a Mapping Candidate

supportedRole

Type: CAEX_ClassModel.SupportedRoleClassType
The SupportedRole of the SystemUnitClass, which is the nearest generation to the required role

Return Value

Type: Int32
Ancestor Generation

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type InternalElementType. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

 

Exception	Condition
ArgumentNullException	systemUnitClass

See Also

Reference

MappingExtension Class
AMLEngineExtensions Namespace