agi.foundation.radar

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

Class SingleTargetRadarLinkScalar

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.radar.SingleTargetRadarLinkScalar

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

DwellTimeScalar, EffectiveIsotropicRadiatedPowerScalar, IntegratedPulseCountScalar, MitchellWalkerProbabilityOfDetectionScalar, MonostaticAmbiguousTargetRangeScalar, MonostaticAmbiguousTargetVelocityScalar, PulseIntegrationTimeScalar, ReceiveAntennaGainScalar, ReceiveAntennaOutputInterferencePowerScalar, ReceiveAntennaOutputPowerScalar, SignalToNoiseRatioScalar, TargetRadarCrossSectionScalar, TargetScatteredPowerScalar, TargetToReceiverDopplerFrequencyScalar, TargetToReceiverDopplerShiftScalar, TargetToReceiverPropagationLossScalar, TargetToReceiverReceivedIsotropicPowerScalar, TransmitAntennaGainScalar, TransmitterToTargetDopplerFrequencyScalar, TransmitterToTargetDopplerShiftScalar, TransmitterToTargetPropagationLossScalar, TransmitterToTargetReceivedIsotropicPowerScalar

public abstract class SingleTargetRadarLinkScalar
extends Scalar

A scalar which represents a two way radar transmission from a transmitter, scattered off of a target, and back to a receiver.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleTargetRadarLinkScalar(IServiceProvider radarTransmitter, IServiceProvider target, IServiceProvider radarReceiver, IntendedSignalStrategy intendedSignalStrategy, SignalPropagationGraph graph, boolean evaluateInterference) Initializes a new instance.
protected	SingleTargetRadarLinkScalar(SingleTargetRadarLinkScalar 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(Scalar other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(SingleTargetRadarLinkScalar 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.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
boolean	getEvaluateInterference() Gets a value indicating whether or not the scalar should account for interference during the scalar evaluation.
IntendedSignalStrategy	getIntendedSignalStrategy() Gets the method used to identify the desired signal for scalar evaluation.
IServiceProvider	getRadarReceiver() Gets the IServiceProvider which represents the radar receiver.
IServiceProvider	getRadarTransmitter() Gets the IServiceProvider which represents the radar transmitter.
SignalPropagationGraph	getSignalPropagationGraph() Gets the signal propagation graph.
IServiceProvider	getTarget() Gets the IServiceProvider which represents the radar target.
boolean	getUseLogarithmicSampling() Gets a value indicating whether computed values will be converted to a logarithmic scale when performing sampling for access calculations.
protected void	setUseLogarithmicSampling(boolean value) Sets a value indicating whether computed values will be converted to a logarithmic scale when performing sampling for access calculations.
protected void	validateProperties() Validates all properties for use in constructing the signal evaluator.

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, 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

SingleTargetRadarLinkScalar

protected SingleTargetRadarLinkScalar(IServiceProvider radarTransmitter,
                                      IServiceProvider target,
                                      IServiceProvider radarReceiver,
                                      IntendedSignalStrategy intendedSignalStrategy,
                                      SignalPropagationGraph graph,
                                      boolean evaluateInterference)

Initializes a new instance.

Parameters:

radarTransmitter - An IServiceProvider which represents the radar transmitter.

target - An IServiceProvider which represents the radar target. A valid target instance must provide the IPointScattererService service.

radarReceiver - An IServiceProvider which represents the radar receiver.

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

intendedSignalStrategy - The method used to identify the desired signal for scalar evaluation.

evaluateInterference - Indicates whether or not the scalar should account for interference sources in the scalar evaluation. If false, no interference will be evaluated, even if present in the SignalPropagationGraph (get).

SingleTargetRadarLinkScalar

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

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.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 DefinitionalObject

getUseLogarithmicSampling

public final boolean getUseLogarithmicSampling()

Gets a value indicating whether computed values will be converted to a logarithmic scale when performing sampling for access calculations. Radar scalars can span an extremely large range of values, so in order to avoid comparing values larger than 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.

setUseLogarithmicSampling

protected final void setUseLogarithmicSampling(boolean value)

Sets a value indicating whether computed values will be converted to a logarithmic scale when performing sampling for access calculations. Radar scalars can span an extremely large range of values, so in order to avoid comparing values larger than 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.

getEvaluateInterference

public final boolean getEvaluateInterference()

Gets a value indicating whether or not the scalar should account for interference during the scalar evaluation.

If false, no interference will be evaluated, even if present in the SignalPropagationGraph (get).

getRadarTransmitter

public final IServiceProvider getRadarTransmitter()

Gets the IServiceProvider which represents the radar transmitter.

getRadarReceiver

public final IServiceProvider getRadarReceiver()

Gets the IServiceProvider which represents the radar receiver.

getTarget

public final IServiceProvider getTarget()

Gets the IServiceProvider which represents the radar target.

A valid target instance must provide the IPointScattererService service.

getIntendedSignalStrategy

public final IntendedSignalStrategy getIntendedSignalStrategy()

Gets the method used to identify the desired signal for scalar evaluation.

getSignalPropagationGraph

public final SignalPropagationGraph getSignalPropagationGraph()

Gets the signal propagation graph.

validateProperties

protected void validateProperties()

Validates all properties for use in constructing the signal evaluator.