LinkPathGetLinkPathDelayEvaluator Method |
Creates a
LinkDelayEvaluator which evaluates the time delay offset from the initial service
provider to the final service provider in the path.
Namespace:
AGI.Foundation.Access
Assembly:
AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax public LinkDelayEvaluator GetLinkPathDelayEvaluator(
EvaluatorGroup group,
LinkRole roleOfTimeObserver
)
Public Function GetLinkPathDelayEvaluator (
group As EvaluatorGroup,
roleOfTimeObserver As LinkRole
) As LinkDelayEvaluator
public:
LinkDelayEvaluator^ GetLinkPathDelayEvaluator(
EvaluatorGroup^ group,
LinkRole roleOfTimeObserver
)
member GetLinkPathDelayEvaluator :
group : EvaluatorGroup *
roleOfTimeObserver : LinkRole -> LinkDelayEvaluator
Parameters
- group
- Type: AGI.FoundationEvaluatorGroup
The evaluator group in which to create requisite link delay evaluators. - roleOfTimeObserver
- Type: AGI.Foundation.AccessLinkRole
The role of the time observer. If the role is receiving,
the delay is negative. If the role is transmitting, the delay is positive.
Return Value
Type:
LinkDelayEvaluatorThe link delay offset evaluator from the first link to the last in this collection. If there
are no links in the collection, the evaluator produces no delay.
Exceptions Exception | Condition |
---|
InvalidOperationException | Thrown when this link path does not continuously connected
from beginning to end or when the path is not correctly directed in a single direction from beginning to end.
This could occur if two links in the chain both point to a single receiver object rather than one transmitting
to the other which in turn transmits to another etc.
|
Remarks If the roleOfTimeObserver is Receiver,
the resulting delay evaluator will produce the offset to the time of first transmission when given the time of
reception. If the roleOfTimeObserver is Transmitter,
the resulting delay evaluator will produce the offset to the time of final reception
when given the time of first transmission.
See Also