Click or drag to resize

LinkHelper.GetDisplacementVectorByRole Method (IServiceProvider, LinkRole)

Gets the displacement vector for a given link and role.

Namespace:  AGI.Foundation.Access
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public static VectorDisplacement GetDisplacementVectorByRole(
	IServiceProvider link,
	LinkRole role
)

Parameters

link
Type: System.IServiceProvider
The link.
role
Type: AGI.Foundation.Access.LinkRole
The role for which to obtain the displacement vector.

Return Value

Type: VectorDisplacement
The displacement vector.
Exceptions
ExceptionCondition
ArgumentNullException Thrown when link is null.
ArgumentException Thrown when role is not Transmitter or Receiver.
ServiceNotAvailableException Thrown when link does not provide ILinkService.
See Also