agi.foundation.radar

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

Class FixedNumberOfPulsesWaveformIntegrator

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.radar.RadarWaveformProcessor

agi.foundation.radar.FixedNumberOfPulsesWaveformIntegrator

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantEfficiencyFixedNumberOfPulsesWaveformIntegrator, PerfectFixedNumberOfPulsesWaveformIntegrator

public abstract class FixedNumberOfPulsesWaveformIntegrator
extends RadarWaveformProcessor

A radar waveform integrator which will integrate a fixed number of pulses in the waveform.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FixedNumberOfPulsesWaveformIntegrator() Initializes a new instance.
protected	FixedNumberOfPulsesWaveformIntegrator(FixedNumberOfPulsesWaveformIntegrator existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	FixedNumberOfPulsesWaveformIntegrator(int pulseCount) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(FixedNumberOfPulsesWaveformIntegrator other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(RadarWaveformProcessor 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.
int	getPulseCount() Gets the pulse count.
boolean	getUseWaveformPulseCount() Gets a value indicating whether to use waveform pulse count.
void	setPulseCount(int value) Sets the pulse count.
void	setUseWaveformPulseCount(boolean value) Sets a value indicating whether to use waveform pulse count.
protected void	validateProperties(EvaluatorGroup group, IntendedSignalStrategy intendedSignalStrategy, SignalPropagationGraph graph) Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.radar.RadarWaveformProcessor

attachSignalProcessorAsInput, checkForSameDefinition, enumerateDependencies, getEvaluator, getInputWaveformProcessor, setInputWaveformProcessor

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

FixedNumberOfPulsesWaveformIntegrator

protected FixedNumberOfPulsesWaveformIntegrator()

Initializes a new instance.

By default, the PulseCount (get / set) is 1 and UseWaveformPulseCount (get / set) is true.

FixedNumberOfPulsesWaveformIntegrator

protected FixedNumberOfPulsesWaveformIntegrator(int pulseCount)

Initializes a new instance.

By default, UseWaveformPulseCount (get / set) is false.

Parameters:

pulseCount - The number of pulses to integrate. If the value is larger than the number of pulses found in the waveform, the number of pulses in the waveform is used for integration.

FixedNumberOfPulsesWaveformIntegrator

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

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(FixedNumberOfPulsesWaveformIntegrator 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 FixedNumberOfPulsesWaveformIntegrator.checkForSameDefinition(agi.foundation.radar.RadarWaveformProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class RadarWaveformProcessor

Returns:

The computed hash code.

getPulseCount

public final int getPulseCount()

Gets the pulse count.

setPulseCount

public final void setPulseCount(int value)

Sets the pulse count.

getUseWaveformPulseCount

public final boolean getUseWaveformPulseCount()

Gets a value indicating whether to use waveform pulse count. If set to true, the total number of pulses found in the received waveform will be integrated. If set to false, the number of pulses defined by the PulseCount (get / set) property will be used if less than the waveform pulse count, otherwise the number of pulses in the waveform will be integrated.

setUseWaveformPulseCount

public final void setUseWaveformPulseCount(boolean value)

Sets a value indicating whether to use waveform pulse count. If set to true, the total number of pulses found in the received waveform will be integrated. If set to false, the number of pulses defined by the PulseCount (get / set) property will be used if less than the waveform pulse count, otherwise the number of pulses in the waveform will be integrated.

validateProperties

protected void validateProperties(EvaluatorGroup group,
                                  IntendedSignalStrategy intendedSignalStrategy,
                                  SignalPropagationGraph graph)

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Overrides:

validateProperties in class RadarWaveformProcessor

Parameters:

group - The evaluator group used to optimize the evaluators.

intendedSignalStrategy - The intended signal strategy used to choose one of the signals in the signal collection.

graph - The signal propagation graph, which represents all of the signal paths in the analysis.

Throws:

PropertyInvalidException - Thrown when PulseCount (get / set) is less than one.

ArgumentNullException - Thrown when group, intendedSignalStrategy, or graph is null.

PropertyInvalidException - Thrown when InputWaveformProcessor (get / set) is null.