agi.foundation.communications

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

Class PointScattererLinkPath

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.PointScattererLinkPath

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, Iterable<IServiceProvider>

public final class PointScattererLinkPath
extends DefinitionalObject
implements Iterable<IServiceProvider>

Describes a propagation path from a transmitter through one or more point scatterers ending at a receiver.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
static PointScattererLinkPath	constructInstance(LinkPath linkPath) Constructs a new instance from a LinkPath.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
IServiceProvider	find(Predicate<IServiceProvider> match) Searches the link path for an IServiceProvider that matches the conditions defined by the supplied predicate and returns the first occurrence.
IServiceProvider	get(int index) Gets the IServiceProvider at the specified index.
int	getCount() Gets the number of IServiceProvider objects in the LinkPath.
LinkDelayEvaluator	getLinkPathDelayEvaluator(EvaluatorGroup group) Creates a LinkDelayEvaluator which evaluates the time delay offset from the initial service provider to the final service provider in the path.
Iterator<IServiceProvider>	iterator() Returns an iterator over elements of type T.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the PointScattererLinkPath.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

constructInstance

@Nullable
public static PointScattererLinkPath constructInstance(@Nonnull
                                                                  LinkPath linkPath)

Constructs a new instance from a LinkPath.

Parameters:

linkPath - Each link in the link path parameter must have a Transmitter (get) and Receiver (get) which can provide the IPointScattererService service, except for the first and last link. The first link must only have a Receiver (get) which provides the IPointScattererService service and the last link must only have a Transmitter (get) which provides the IPointScattererService service.

Returns:

A valid instance or null.

getLinkPathDelayEvaluator

@Nonnull
public final LinkDelayEvaluator getLinkPathDelayEvaluator(@Nonnull
                                                                    EvaluatorGroup group)

Creates a LinkDelayEvaluator which evaluates the time delay offset from the initial service provider to the final service provider in the path.

Parameters:

group - The evaluator group in which to create requisite link delay evaluators.

Returns:

The 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.

Throws:

IllegalStateException - Thrown when this link path is 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.

find

@Nullable
public final IServiceProvider find(@Nonnull
                                              Predicate<IServiceProvider> match)

Searches the link path for an IServiceProvider that matches the conditions defined by the supplied predicate and returns the first occurrence.

Parameters:

match - The IServiceProvider predicate.

Returns:

The first IServiceProvider which matches the conditions defined by the supplied predicate, or null if no match is found.

getCount

public final int getCount()

Gets the number of IServiceProvider objects in the LinkPath.

Returns:

The number of links in the path.

get

public final IServiceProvider get(int index)

Gets the IServiceProvider at the specified index.

Parameters:

index - The index into the LinkPath

Returns:

The IServiceProvider at the specified index.

iterator

public final Iterator<IServiceProvider> iterator()

Description copied from interface: java.lang.Iterable

Returns an iterator over elements of type T.

Specified by:

iterator in interface Iterable<IServiceProvider>

Returns:

an Iterator.