agi.foundation.geometry

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

Class ScalarPropagationLoss

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.geometry.CommunicationLinkScalar

agi.foundation.geometry.ScalarPropagationLoss

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class ScalarPropagationLoss
extends CommunicationLinkScalar

A scalar which represents the loss in power on a signal propagating along the link specified by the CommunicationLink (get / set). The loss is computed using the IntendedSignalStrategy (get / set) based on a comparison of the IPropagatedSignalService and the ITransmittedSignalService provided by the link. The value of this scalar will be negative, representing a negative gain (loss).

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScalarPropagationLoss() Initializes a new instance.
	ScalarPropagationLoss(IServiceProvider link, SignalPropagationGraph graph, IntendedSignalStrategy intendedSignalStrategy) Initialize a new instance based on the given parameters.
	ScalarPropagationLoss(IServiceProvider link, SignalPropagationGraph graph, IntendedSignalStrategy intendedSignalStrategy, SignalPropagationModel model) Initialize a new instance based on the given parameters.
	ScalarPropagationLoss(IServiceProvider link, SignalPropagationGraph graph, IntendedSignalStrategy intendedSignalStrategy, SignalPropagationModelChain selectedModels) Initialize a new instance based on the given parameters.
protected	ScalarPropagationLoss(ScalarPropagationLoss existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(CommunicationLinkScalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(ScalarPropagationLoss 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.
ScalarEvaluator	getEvaluator(EvaluatorGroup group) Get an evaluator to compute the loss in power from propagating the signal along the link.
LinkRole	getLinkEnd() Gets the enumeration indicating that this scalar is evaluated at the LinkRole.RECEIVER of the communication link.
SignalPropagationModelChain	getSelectedModels() Gets the propagation models to use when computing the loss.
void	setLinkEnd(LinkRole value) Sets the enumeration indicating that this scalar is evaluated at the LinkRole.RECEIVER of the communication link.
void	setSelectedModels(SignalPropagationModelChain value) Sets the propagation models to use when computing the loss.

Methods inherited from class agi.foundation.geometry.CommunicationLinkScalar

checkForSameDefinition, getCommunicationLink, getIntendedSignalStrategy, getPropagationGraph, getUseLogarithmicSampling, setCommunicationLink, setIntendedSignalStrategy, setPropagationGraph, setUseLogarithmicSampling, validateProperties

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, multiply, multiply, multiply, multiply, multiply, power, subtract, subtract, subtract, subtract, subtract, toScalar

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

Constructor Detail

ScalarPropagationLoss

public ScalarPropagationLoss()

Initializes a new instance.

ScalarPropagationLoss

public ScalarPropagationLoss(IServiceProvider link,
                             SignalPropagationGraph graph,
                             IntendedSignalStrategy intendedSignalStrategy)

Initialize a new instance based on the given parameters.

Parameters:

link - The link which provides the IPropagatedSignalService and ITransmittedSignalService needed to compute this scalar.

graph - The graph of the communication links used to propagate signals.

intendedSignalStrategy - The strategy used to identify the signal to use when computing the scalar value.

ScalarPropagationLoss

public ScalarPropagationLoss(IServiceProvider link,
                             SignalPropagationGraph graph,
                             IntendedSignalStrategy intendedSignalStrategy,
                             SignalPropagationModel model)

Initialize a new instance based on the given parameters.

Parameters:

link - The link which provides the IPropagatedSignalService and ITransmittedSignalService needed to compute this scalar.

graph - The graph of the communication links used to propagate signals.

intendedSignalStrategy - The strategy used to identify the signal to use when computing the scalar value.

model - The propagation model to use when computing the loss.

ScalarPropagationLoss

public ScalarPropagationLoss(IServiceProvider link,
                             SignalPropagationGraph graph,
                             IntendedSignalStrategy intendedSignalStrategy,
                             SignalPropagationModelChain selectedModels)

Initialize a new instance based on the given parameters.

Parameters:

link - The link which provides the IPropagatedSignalService and ITransmittedSignalService needed to compute this scalar.

graph - The graph of the communication links used to propagate signals.

intendedSignalStrategy - The strategy used to identify the signal to use when computing the scalar value.

selectedModels - The propagation models to use when computing the loss.

ScalarPropagationLoss

protected ScalarPropagationLoss(@Nonnull
                                ScalarPropagationLoss existingInstance,
                                @Nonnull
                                CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

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 final boolean checkForSameDefinition(CommunicationLinkScalar 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 CommunicationLinkScalar

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(ScalarPropagationLoss 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 ScalarPropagationLoss.checkForSameDefinition(agi.foundation.geometry.CommunicationLinkScalar) method.

Overrides:

computeCurrentDefinitionHashCode in class CommunicationLinkScalar

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 CommunicationLinkScalar

Parameters:

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

getSelectedModels

@Nullable
public final SignalPropagationModelChain getSelectedModels()

Gets the propagation models to use when computing the loss. By default this is null, which indicates that all propagation models will be used. The StartModel (get / set) is the first model to consider in the chain, and the StopModel (get / set) is the last model to consider in the chain. To select a single model, set both the start and stop models to the same model.

setSelectedModels

public final void setSelectedModels(@Nullable
                                    SignalPropagationModelChain value)

Sets the propagation models to use when computing the loss. By default this is null, which indicates that all propagation models will be used. The StartModel (get / set) is the first model to consider in the chain, and the StopModel (get / set) is the last model to consider in the chain. To select a single model, set both the start and stop models to the same model.

getLinkEnd

@Nonnull
public LinkRole getLinkEnd()

Gets the enumeration indicating that this scalar is evaluated at the LinkRole.RECEIVER of the communication link. Note that this value cannot be modified.

Specified by:

getLinkEnd in class CommunicationLinkScalar

Throws:

IllegalStateException - Thrown when this property is set.

setLinkEnd

public void setLinkEnd(@Nonnull
                       LinkRole value)

Sets the enumeration indicating that this scalar is evaluated at the LinkRole.RECEIVER of the communication link. Note that this value cannot be modified.

Specified by:

setLinkEnd in class CommunicationLinkScalar

Throws:

IllegalStateException - Thrown when this property is set.

getEvaluator

public ScalarEvaluator getEvaluator(EvaluatorGroup group)

Get an evaluator to compute the loss in power from propagating the signal along the link.

Specified by:

getEvaluator in class Scalar

Parameters:

group - The evaluator group in which to create evaluators.

Returns:

An evaluator which computes propagation loss.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown when PropagationGraph (get / set), IntendedSignalStrategy (get / set), or CommunicationLink (get / set) are null, or when PropagationGraph (get / set) does not contain CommunicationLink (get / set).