CommunicationLinkCollection

java.lang.Object
- agi.foundation.compatibility.BaseCollection<T>
- - agi.foundation.infrastructure.DefinitionalObjectCollection<ExtensibleObject>
  - - agi.foundation.infrastructure.ExtensibleObjectCollection
    - - agi.foundation.communications.CommunicationLinkCollection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, Iterable<ExtensibleObject>, Collection<ExtensibleObject>, List<ExtensibleObject>
```
public class CommunicationLinkCollection
extends ExtensibleObjectCollection
```
A collection of communication links, primarily used by the CommunicationSystem. While transceivers, transponders and links are not technically transmitter or receivers themselves; they can be passed directly to any of the methods in this class and it will retrieve the necessary link end for the desired roll.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CommunicationLinkCollection()` Creates a default instance.
`protected`	`CommunicationLinkCollection(CommunicationLinkCollection existingCollection, CopyContext context)` Creates an instance containing the objects provided.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExtensibleObject`	`add(IServiceProvider transmitter, IServiceProvider receiver)` Creates a new link from the provided transmitter and receiver and adds it to the collection.
`ExtensibleObject`	`add(IServiceProvider transmitter, IServiceProvider receiver, AtmosphericRefractionModel refractionModel)` Creates a new link from the provided transmitter and receiver and adds it to the collection.
`ExtensibleObject`	`add(String name, IServiceProvider transmitter, IServiceProvider receiver)` Creates a new link from the provided name, transmitter, and receiver and adds it to the collection.
`ExtensibleObject`	`add(String name, IServiceProvider transmitter, IServiceProvider receiver, AtmosphericRefractionModel refractionModel)` Creates a new link from the provided name, transmitter, and receiver and adds it to the collection.
`ArrayList<ExtensibleObject>`	`addChain(IServiceProvider... chain)` Adds multiple links to the collection at once, assuming that each item in the list either receives or transmits from the previous item.
`ArrayList<ExtensibleObject>`	`addChain(Iterable<? extends IServiceProvider> chain)` Adds multiple links to the collection at once, assuming that each item in the list either receives or transmits from the previous item.
`protected boolean`	`checkForSameDefinition(CommunicationLinkCollection other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`protected boolean`	`checkForSameDefinition(ExtensibleObjectCollection 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.
`void`	`enumerateDependencies(DependencyEnumerator enumerator)` Enumerates the dependencies of this object by calling `DependencyEnumerator#enumerate(T)` for each object that this object directly depends upon.
`Iterable<ExtensibleObject>`	`find(IServiceProvider linkEnd)` Finds all links in the collection that contains the provided link end in either the transmitter or receiver role.
`Iterable<ExtensibleObject>`	`find(IServiceProvider transmitter, IServiceProvider receiver)` Finds all links with the specified transmitter and receiver pair.
`Iterable<ExtensibleObject>`	`find(IServiceProvider linkEnd, LinkRole role)` Finds all links in the collection that contain the provided link end in the specified role.
`Iterable<ExtensibleObject>`	`find(String linkName)` Finds a link in the collection by name.
`ExtensibleObject`	`findFirst(IServiceProvider linkEnd)` Finds the first link in the collection that contains the provided link end in either the transmitter or receiver role.
`ExtensibleObject`	`findFirst(IServiceProvider transmitter, IServiceProvider receiver)` Finds the first link with the specified transmitter and receiver pair.
`ExtensibleObject`	`findFirst(IServiceProvider linkEnd, LinkRole role)` Finds the first link in the collection that contains the provided link end in the specified role.
`ExtensibleObject`	`findFirst(String linkName)` Finds the first instance of the named link.
`protected void`	`freezeAggregatedObjects()` Called by `DefinitionalObjectCollection.freeze()` to also freeze any objects that are considered to be a part of this object.
`AccessConstraintCollection`	`getDefaultAccessConstraints()` Gets the default access constraints list.
`ReferenceFrame`	`getDefaultInertialFrame()` Gets the default inertial frame in which the light path is modeled for new `LinkSpeedOfLight` instances created by the collection.
`List<SignalPropagationModel>`	`getDefaultPropagationModels()` Gets the default propagation models list.
`void`	`setDefaultInertialFrame(ReferenceFrame value)` Sets the default inertial frame in which the light path is modeled for new `LinkSpeedOfLight` instances created by the collection.

Methods inherited from class agi.foundation.infrastructure.ExtensibleObjectCollection
checkForSameDefinition

Methods inherited from class agi.foundation.infrastructure.DefinitionalObjectCollection
addRange, clearItems, freeze, getDefinitionHashCode, getIsFrozen, insertItem, isSameDefinition, removeItem, setItem, throwIfFrozen

Methods inherited from class agi.foundation.compatibility.BaseCollection
add, add, addAll, addAll, clear, contains, containsAll, get, getItems, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - CommunicationLinkCollection
```
public CommunicationLinkCollection()
```
    Creates a default instance.
    The DefaultInertialFrame (get / set) is set to the Earth's inertial frame and DefaultPropagationModels (get) are the same defaults defined by the WirelessLinkExtension. The DefaultAccessConstraints (get) collection contains a CentralBodyObstructionConstraint, using the Earth as the CentralBody (get / set) by default.
  - CommunicationLinkCollection
```
protected CommunicationLinkCollection(@Nonnull
                                      CommunicationLinkCollection existingCollection,
                                      @Nonnull
                                      CopyContext context)
```
    Creates an instance containing the objects provided.
    
    Parameters:
    
    existingCollection - The existing collection used to populate this collection initially.
    
    context - The context to use to perform the copy.
- 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
    
    Overrides:
    
    clone in class ExtensibleObjectCollection
    
    Parameters:
    
    context - The context to use to perform the copy.
    
    Returns:
    
    A new instance which is a copy of this object.
  - checkForSameDefinition
```
protected final boolean checkForSameDefinition(ExtensibleObjectCollection 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).
    
    Overrides:
    
    checkForSameDefinition in class ExtensibleObjectCollection
    
    Parameters:
    
    other - The other instance to compare to this one.
    
    Returns:
    
    true if the two objects are defined equivalently; otherwise false.
  - checkForSameDefinition
```
protected boolean checkForSameDefinition(CommunicationLinkCollection 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).
    
    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 CommunicationLinkCollection.checkForSameDefinition(agi.foundation.infrastructure.ExtensibleObjectCollection) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class ExtensibleObjectCollection
    
    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 DefinitionalObjectCollection<ExtensibleObject>
    
    Parameters:
    
    enumerator - The enumerator that is informed of the dependencies of this object.
  - freezeAggregatedObjects
```
protected void freezeAggregatedObjects()
```
    Called by DefinitionalObjectCollection.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
    
    Overrides:
    
    freezeAggregatedObjects in class DefinitionalObjectCollection<ExtensibleObject>
  - getDefaultInertialFrame
```
public final ReferenceFrame getDefaultInertialFrame()
```
    Gets the default inertial frame in which the light path is modeled for new LinkSpeedOfLight instances created by the collection.
  - setDefaultInertialFrame
```
public final void setDefaultInertialFrame(ReferenceFrame value)
```
    Sets the default inertial frame in which the light path is modeled for new LinkSpeedOfLight instances created by the collection.
  - getDefaultPropagationModels
```
@Nonnull
public final List<SignalPropagationModel> getDefaultPropagationModels()
```
    Gets the default propagation models list.
    The propagation models used by default are the same defaults defined by the WirelessLinkExtension.
  - getDefaultAccessConstraints
```
@Nonnull
public final AccessConstraintCollection getDefaultAccessConstraints()
```
    Gets the default access constraints list. The DefaultAccessConstraints collection contains a CentralBodyObstructionConstraint, using the Earth as a central body by default. The CentralBodyObstruction constraint causes the wireless link to be unavailable when the signal's path intersects the Earth's ellipsoid.
  - add
```
@Nonnull
public final ExtensibleObject add(IServiceProvider transmitter,
                                            IServiceProvider receiver)
```
    Creates a new link from the provided transmitter and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
    
    Parameters:
    
    transmitter - The transmitter on the link.
    
    receiver - The receiver on the link.
    
    Returns:
    
    A reference to the existing or new link that was added to the collection.
  - add
```
@Nonnull
public final ExtensibleObject add(String name,
                                            IServiceProvider transmitter,
                                            IServiceProvider receiver)
```
    Creates a new link from the provided name, transmitter, and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
    
    Parameters:
    
    name - The name of the link.
    
    transmitter - The transmitter on the link.
    
    receiver - The receiver on the link.
    
    Returns:
    
    A reference to the existing or new link that was added to the collection.
    
    Throws:
    
    PropertyInvalidException - Thrown if DefaultInertialFrame (get / set) is null.
  - add
```
@Nonnull
public final ExtensibleObject add(IServiceProvider transmitter,
                                            IServiceProvider receiver,
                                            AtmosphericRefractionModel refractionModel)
```
    Creates a new link from the provided transmitter and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
    
    Parameters:
    
    transmitter - The transmitter on the link.
    
    receiver - The receiver on the link.
    
    refractionModel - The model used to model atmospheric refraction.
    
    Returns:
    
    A reference to the existing or new link that was added to the collection.
    
    Throws:
    
    PropertyInvalidException - Thrown if DefaultInertialFrame (get / set) is null.
  - add
```
@Nonnull
public final ExtensibleObject add(String name,
                                            IServiceProvider transmitter,
                                            IServiceProvider receiver,
                                            AtmosphericRefractionModel refractionModel)
```
    Creates a new link from the provided name, transmitter, and receiver and adds it to the collection. If a link in the collection already exists for the specified transmitter and receiver pair, no new link is created and the existing link is returned instead.
    
    Parameters:
    
    name - The name of the link.
    
    transmitter - The transmitter on the link.
    
    receiver - The receiver on the link.
    
    refractionModel - The model used to model atmospheric refraction.
    
    Returns:
    
    A reference to the existing or new link that was added to the collection.
    
    Throws:
    
    PropertyInvalidException - Thrown if DefaultInertialFrame (get / set) is null.
  - addChain
```
@Nonnull
public final ArrayList<ExtensibleObject> addChain(IServiceProvider... chain)
```
    Adds multiple links to the collection at once, assuming that each item in the list either receives or transmits from the previous item. Usually, this contains a transmitter and receiver with zero or more transceivers or transponders in between.
    
    Parameters:
    
    chain - The elements of the chain to add to the collection, in order.
    
    Returns:
    
    The new and existing links that are now in the collection.
    
    Throws:
    
    ArgumentNullException - Thrown when chain is null.
    
    ArgumentException - Thrown when the chain has fewer than two elements.
  - addChain
```
@Nonnull
public final ArrayList<ExtensibleObject> addChain(@Nonnull
                                                            Iterable<? extends IServiceProvider> chain)
```
    Adds multiple links to the collection at once, assuming that each item in the list either receives or transmits from the previous item. Usually, this contains a transmitter and receiver with zero or more transceivers or transponders in between.
    
    Parameters:
    
    chain - The elements of the chain to add to the collection, in order.
    
    Returns:
    
    The new and existing links that are now in the collection.
    
    Throws:
    
    ArgumentNullException - Thrown when chain is null.
    
    ArgumentException - Thrown when the chain has fewer than two elements.
  - find
```
@Nonnull
public final Iterable<ExtensibleObject> find(String linkName)
```
    Finds a link in the collection by name.
    
    Parameters:
    
    linkName - The name of the link to find.
    
    Returns:
    
    All links with the specified name.
  - findFirst
```
@Nullable
public final ExtensibleObject findFirst(String linkName)
```
    Finds the first instance of the named link.
    
    Parameters:
    
    linkName - The name of the link to find.
    
    Returns:
    
    The first instance in the collection of the named link, or null if the named link is not present.
  - find
```
@Nonnull
public final Iterable<ExtensibleObject> find(IServiceProvider transmitter,
                                                       IServiceProvider receiver)
```
    Finds all links with the specified transmitter and receiver pair.
    
    Parameters:
    
    transmitter - The transmitter to search for.
    
    receiver - The receiver to search for.
    
    Returns:
    
    An enumeration with all links in this collection that contain both the transmitter and the receiver.
  - findFirst
```
@Nullable
public final ExtensibleObject findFirst(IServiceProvider transmitter,
                                                   IServiceProvider receiver)
```
    Finds the first link with the specified transmitter and receiver pair.
    
    Parameters:
    
    transmitter - The transmitter to search for.
    
    receiver - The receiver to search for.
    
    Returns:
    
    The first link in the collection that contains both the transmitter and the receiver.
  - find
```
@Nonnull
public final Iterable<ExtensibleObject> find(IServiceProvider linkEnd,
                                                       @Nonnull
                                                       LinkRole role)
```
    Finds all links in the collection that contain the provided link end in the specified role.
    
    Parameters:
    
    linkEnd - The receiver or transmitter to search for.
    
    role - The role specifying whether it's a receiver or transmitter.
    
    Returns:
    
    All links in the collection that contain the link end.
  - findFirst
```
@Nullable
public final ExtensibleObject findFirst(IServiceProvider linkEnd,
                                                   @Nonnull
                                                   LinkRole role)
```
    Finds the first link in the collection that contains the provided link end in the specified role.
    
    Parameters:
    
    linkEnd - The receiver or transmitter to search for.
    
    role - The role specifying whether it's a receiver or transmitter.
    
    Returns:
    
    The first link in the collection that contains the link end in the specified role.
  - find
```
@Nonnull
public final Iterable<ExtensibleObject> find(IServiceProvider linkEnd)
```
    Finds all links in the collection that contains the provided link end in either the transmitter or receiver role.
    
    Parameters:
    
    linkEnd - The receiver or transmitter to search for.
    
    Returns:
    
    All links in the collection that contains the link end.
  - findFirst
```
@Nullable
public final ExtensibleObject findFirst(IServiceProvider linkEnd)
```
    Finds the first link in the collection that contains the provided link end in either the transmitter or receiver role.
    
    Parameters:
    
    linkEnd - The receiver or transmitter to search for.
    
    Returns:
    
    The first link in the collection that contains the link end.

Class CommunicationLinkCollection

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.infrastructure.ExtensibleObjectCollection

Methods inherited from class agi.foundation.infrastructure.DefinitionalObjectCollection

Methods inherited from class agi.foundation.compatibility.BaseCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

CommunicationLinkCollection

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

freezeAggregatedObjects

getDefaultInertialFrame

setDefaultInertialFrame

getDefaultPropagationModels

getDefaultAccessConstraints

add

add

add

add

addChain

addChain

find

findFirst

find

findFirst

find

findFirst

find

findFirst