agi.foundation.communications

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

Class PointScattererFrequencyBandCollection

java.lang.Object

agi.foundation.compatibility.BaseCollection<T>

agi.foundation.infrastructure.DefinitionalObjectCollection<PointScattererFrequencyBand>

agi.foundation.communications.PointScattererFrequencyBandCollection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, Iterable<PointScattererFrequencyBand>, Collection<PointScattererFrequencyBand>, List<PointScattererFrequencyBand>

public final class PointScattererFrequencyBandCollection
extends DefinitionalObjectCollection<PointScattererFrequencyBand>

Represents a collection of PointScattererFrequencyBand objects. The PointScattererFrequencyBandCollection is valid for frequencies ranging from MinimumFrequency (get) to MaximumFrequency (get). The minimum and maximum frequencies for the collection default to CommunicationsConstants.MinimumRfFrequency and CommunicationsConstants.MaximumRfFrequency respectively. The LowerFrequency (get) value for each PointScattererFrequencyBand instance in the collection must be greater than or equal to MinimumFrequency (get) and less than MaximumFrequency (get). Band insert and add operations on the collection will validate the band's lower frequency and will also check to make sure that there is not an existing band in the collection with the same lower frequency value.

Constructor Summary

Constructors

Constructor and Description
PointScattererFrequencyBandCollection() Initializes a new instance.
PointScattererFrequencyBandCollection(double minimumFrequency, double maximumFrequency) Initializes a new instance.
PointScattererFrequencyBandCollection(double minimumFrequency, double maximumFrequency, ScatteringCoefficient scatteringCoefficient) Initializes a new instance.
PointScattererFrequencyBandCollection(ScatteringCoefficient scatteringCoefficient) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	add(double lowerFrequency, ScatteringCoefficient scatteringCoefficient) Adds a new point scattering frequency band with the given lower frequency and scattering coefficient.
protected boolean	checkForSameDefinition(DefinitionalObjectCollection<PointScattererFrequencyBand> 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.
double	getMaximumFrequency() Gets the maximum frequency for the overall frequency band of the collection.
double	getMinimumFrequency() Gets the minimum frequency for the overall frequency band of the collection.
protected void	insertItem(int index, PointScattererFrequencyBand item) Inserts an element into the DefinitionalObjectCollection at the specified index.
protected void	setItem(int index, PointScattererFrequencyBand item) Replaces the element at the specified index.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObjectCollection

addRange, clearItems, enumerateDependencies, freeze, freezeAggregatedObjects, getDefinitionHashCode, getIsFrozen, isSameDefinition, removeItem, 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

PointScattererFrequencyBandCollection

public PointScattererFrequencyBandCollection()

Initializes a new instance.

MinimumFrequency (get) defaults to CommunicationsConstants.MinimumRfFrequency and MaximumFrequency (get) defaults to CommunicationsConstants.MaximumRfFrequency

PointScattererFrequencyBandCollection

public PointScattererFrequencyBandCollection(ScatteringCoefficient scatteringCoefficient)

Initializes a new instance.

MinimumFrequency (get) defaults to CommunicationsConstants.MinimumRfFrequency and MaximumFrequency (get) defaults to CommunicationsConstants.MaximumRfFrequency

Parameters:

scatteringCoefficient - The scattering coefficient for the first band in the collection.

PointScattererFrequencyBandCollection

public PointScattererFrequencyBandCollection(double minimumFrequency,
                                             double maximumFrequency,
                                             ScatteringCoefficient scatteringCoefficient)

Initializes a new instance.

Parameters:

minimumFrequency - The minimum frequency for the overall frequency band for the collection.

maximumFrequency - The maximum frequency for the overall frequency band for the collection.

scatteringCoefficient - The scattering coefficient for the first band in the collection.

PointScattererFrequencyBandCollection

public PointScattererFrequencyBandCollection(double minimumFrequency,
                                             double maximumFrequency)

Initializes a new instance.

Parameters:

minimumFrequency - The minimum frequency for the overall frequency band for the collection.

maximumFrequency - The maximum frequency for the overall frequency band for the collection.

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 DefinitionalObjectCollection<PointScattererFrequencyBand>

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(DefinitionalObjectCollection<PointScattererFrequencyBand> other)

Description copied from class: DefinitionalObjectCollection

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 DefinitionalObjectCollection<PointScattererFrequencyBand>

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 PointScattererFrequencyBandCollection.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObjectCollection<agi.foundation.communications.PointScattererFrequencyBand>) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObjectCollection<PointScattererFrequencyBand>

Returns:

The computed hash code.

setItem

protected void setItem(int index,
                       PointScattererFrequencyBand item)

Description copied from class: DefinitionalObjectCollection

Replaces the element at the specified index.

Overrides:

setItem in class DefinitionalObjectCollection<PointScattererFrequencyBand>

Parameters:

index - The zero-based index of the element to replace.

item - The new value for the element at the specified index. The value can be null for reference types.

insertItem

protected void insertItem(int index,
                          PointScattererFrequencyBand item)

Description copied from class: DefinitionalObjectCollection

Inserts an element into the DefinitionalObjectCollection at the specified index.

Overrides:

insertItem in class DefinitionalObjectCollection<PointScattererFrequencyBand>

Parameters:

index - The zero-based index at which item should be inserted.

item - The object to insert. The value can be null for reference types.

add

public final void add(double lowerFrequency,
                      ScatteringCoefficient scatteringCoefficient)

Adds a new point scattering frequency band with the given lower frequency and scattering coefficient.

Parameters:

lowerFrequency - The frequency band lower frequency, in hertz.

scatteringCoefficient - The scattering coefficient instance.

getMinimumFrequency

public final double getMinimumFrequency()

Gets the minimum frequency for the overall frequency band of the collection.

getMaximumFrequency

public final double getMaximumFrequency()

Gets the maximum frequency for the overall frequency band of the collection.