agi.foundation.access

(agi.foundation.core-2024r2.jar)

Class AccessConstraintHelper

java.lang.Object

agi.foundation.access.AccessConstraintHelper

public final class AccessConstraintHelper
extends Object

Contains helper methods that are useful when writing Access constraints.

Method Summary

Modifier and Type	Method and Description
static IServiceProvider	getConstrainedLinkEnd(ILinkConstraint constraint) Gets the object at the end of the link to which a specified constraint is applied.
static VectorDisplacement	getDisplacementVectorForLinkConstraint(ILinkConstraint constraint) Gets the displacement vector for a given link constraint and time observer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConstrainedLinkEnd

public static IServiceProvider getConstrainedLinkEnd(@Nonnull
                                                     ILinkConstraint constraint)

Gets the object at the end of the link to which a specified constraint is applied.

Parameters:

constraint - The constraint.

Returns:

The object at the end of the link to which the constraint is applied.

Throws:

ArgumentNullException - Thrown when constraint is null.

ServiceNotAvailableException - Thrown when the ConstrainedLink (get / set) property of constraint does not provide ILinkService.

getDisplacementVectorForLinkConstraint

@Nonnull
public static VectorDisplacement getDisplacementVectorForLinkConstraint(@Nonnull
                                                                                  ILinkConstraint constraint)

Gets the displacement vector for a given link constraint and time observer.

Parameters:

constraint - The link constraint for which to obtain the displacement vector.

Returns:

The displacement vector.

Throws:

ArgumentNullException - Thrown when constraint is null.

ServiceNotAvailableException - Thrown when the ConstrainedLink (get / set) property of constraint does not provide ILinkService.