agi.foundation.geometry

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

Class CommunicationObjectScalar

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.geometry.CommunicationObjectScalar

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ScalarBitErrorRate, ScalarCarrierToInterference, ScalarCarrierToNoise, ScalarCarrierToNoiseDensity, ScalarCarrierToNoiseDensityPlusInterference, ScalarCarrierToNoisePlusInterference, ScalarEnergyPerBitToNoiseDensity, ScalarGpsCommunicationsReceiverChannelNoise, ScalarJammingToSignal, ScalarNoisePlusInterference, ScalarPolarizationEfficiency, ScalarPowerAtReceiverOutput

public abstract class CommunicationObjectScalar
extends Scalar

Base class for scalars representing values associated with a CommunicationObject (get / set).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(CommunicationObjectScalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(Scalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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.
IServiceProvider	getCommunicationObject() Gets the object which provides the services needed to compute this scalar.
IntendedSignalStrategy	getIntendedSignalStrategy() Gets the strategy used to identify the signal to be used when computing this scalar.
SignalPropagationGraph	getPropagationGraph() Gets the graph of communication links used to propagate signals.
boolean	getUseLogarithmicSampling() Gets a value indicating whether this scalar's values will be converted to a logarithmic scale when performing sampling for access calculations.
void	setCommunicationObject(IServiceProvider value) Sets the object which provides the services needed to compute this scalar.
void	setIntendedSignalStrategy(IntendedSignalStrategy value) Sets the strategy used to identify the signal to be used when computing this scalar.
void	setPropagationGraph(SignalPropagationGraph value) Sets the graph of communication links used to propagate signals.
protected void	setUseLogarithmicSampling(boolean value) Sets a value indicating whether this scalar's values will be converted to a logarithmic scale when performing sampling for access calculations.
protected void	validateProperties(EvaluatorGroup group, boolean checkObject) Checks to see if any of the properties are null and, if so, throws an exception.

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, 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, clone, 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

CommunicationObjectScalar

protected CommunicationObjectScalar()

Initializes a new instance.

CommunicationObjectScalar

protected CommunicationObjectScalar(IServiceProvider communicationObject,
                                    SignalPropagationGraph graph,
                                    IntendedSignalStrategy intendedSignalStrategy)

Initialize a new instance based on the given parameters.

Parameters:

communicationObject - The object which provides the services needed to compute this scalar.

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

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

CommunicationObjectScalar

protected CommunicationObjectScalar(@Nonnull
                                    CommunicationObjectScalar 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

checkForSameDefinition

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

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected abstract boolean checkForSameDefinition(CommunicationObjectScalar 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 CommunicationObjectScalar.checkForSameDefinition(agi.foundation.geometry.Scalar) method.

Overrides:

computeCurrentDefinitionHashCode in class Scalar

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.

getCommunicationObject

public final IServiceProvider getCommunicationObject()

Gets the object which provides the services needed to compute this scalar.

setCommunicationObject

public final void setCommunicationObject(IServiceProvider value)

Sets the object which provides the services needed to compute this scalar.

getPropagationGraph

public final SignalPropagationGraph getPropagationGraph()

Gets the graph of communication links used to propagate signals.

setPropagationGraph

public final void setPropagationGraph(SignalPropagationGraph value)

Sets the graph of communication links used to propagate signals.

getIntendedSignalStrategy

public final IntendedSignalStrategy getIntendedSignalStrategy()

Gets the strategy used to identify the signal to be used when computing this scalar.

setIntendedSignalStrategy

public final void setIntendedSignalStrategy(IntendedSignalStrategy value)

Sets the strategy used to identify the signal to be used when computing this scalar.

getUseLogarithmicSampling

public final boolean getUseLogarithmicSampling()

Gets a value indicating whether this scalar's values will be converted to a logarithmic scale when performing sampling for access calculations. Most communication scalars span an extremely large range of values, especially for wireless communications over large distances. In order to avoid comparing values above one with values very near zero, the logarithmic scale gives a better means of analyzing the behavior of the function without running into numerical issue with floating point numbers. This value is set by its derived classes and in most cases is set to false by default. The notable exception is the ScalarBitErrorRate, which has a range of value from zero to one and therefore does not use a logarithmic scale.

setUseLogarithmicSampling

protected final void setUseLogarithmicSampling(boolean value)

Sets a value indicating whether this scalar's values will be converted to a logarithmic scale when performing sampling for access calculations. Most communication scalars span an extremely large range of values, especially for wireless communications over large distances. In order to avoid comparing values above one with values very near zero, the logarithmic scale gives a better means of analyzing the behavior of the function without running into numerical issue with floating point numbers. This value is set by its derived classes and in most cases is set to false by default. The notable exception is the ScalarBitErrorRate, which has a range of value from zero to one and therefore does not use a logarithmic scale.

validateProperties

protected void validateProperties(@Nonnull
                                  EvaluatorGroup group,
                                  boolean checkObject)

Checks to see if any of the properties are null and, if so, throws an exception.

Parameters:

group - The evaluator group in which to create evaluators.

checkObject - Whether the PropagationGraph (get / set) be checked to see if it contains or uses the CommunicationObject (get / set).

Throws:

ArgumentNullException - Thrown when the group is null.

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