agi.foundation.communications

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

Interface ISignalPropagationPathService

public interface ISignalPropagationPathService

A service interface for objects which represent a propagation path from a transmission source to a receiver object.

Method Summary

Modifier and Type	Method and Description
IServiceProvider	findLinkForReceiver(IServiceProvider receiver) Finds the IServiceProvider which represents the link, in the signal propagation path, which has the provided receiver.
boolean	getEvaluateInterferenceSources() Gets a value indicating whether to evaluate signals from interference sources.
Iterable<IServiceProvider>	getLinkPath() Gets the link path which is a list of links, as IServiceProvider instances, from the transmission source to the receiver object.
IServiceProvider	getTransmitter() Gets the desired transmitter for the signal propagation path.

Method Detail

findLinkForReceiver

@Nullable
IServiceProvider findLinkForReceiver(IServiceProvider receiver)

Finds the IServiceProvider which represents the link, in the signal propagation path, which has the provided receiver.

Parameters:

receiver - The receiver used to search the signal propagation path.

Returns:

The link as an IServiceProvider or null if the receiver can not be found on the link path.

getTransmitter

@Nullable
IServiceProvider getTransmitter()

Gets the desired transmitter for the signal propagation path.

Returns:

The transmitter as a IServiceProvider or null if the transmitter is not found.

getLinkPath

Iterable<IServiceProvider> getLinkPath()

Gets the link path which is a list of links, as IServiceProvider instances, from the transmission source to the receiver object.

getEvaluateInterferenceSources

boolean getEvaluateInterferenceSources()

Gets a value indicating whether to evaluate signals from interference sources.