agi.foundation.communications.signalprocessing

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

Class DigitalModulator<TModulation extends DigitalModulation>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.DigitalModulator<TModulation>

Type Parameters:

TModulation - The type of modulation to add to the signal as data.

All Implemented Interfaces:

ISignalSource, ISignalOutputService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

public class DigitalModulator<TModulation extends DigitalModulation>
extends SignalProcessor

Takes an input Signal and adds the specified modulation as data to the signal, and sets the frequency of the carrier and the signal bandwidth based on the SpectralEfficiency (get). The bandwidth of the modulated signal will be twice the SignalDataRate divided by the SpectralEfficiency (get).

If an input Signal does not have SignalDataRate data added to it, there will be no output signal.

If the input signal has any DigitalModulation (get / set) data added to it, the old modulation will be removed.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DigitalModulator() Initializes a new instance.
protected	DigitalModulator(DigitalModulator<TModulation> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	DigitalModulator(SignalProcessor inputSignalProcessor, TModulation digitalModulation, double carrierFrequency) Initialize a new instance based on the given input and modulation.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DigitalModulator<TModulation> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SignalProcessor 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.
double	getCarrierFrequency() Gets the frequency to set on the modulated carrier signal created by this modulator, in hertz.
TModulation	getDigitalModulation() Gets the digital modulation to add to the signals.
SignalProcessor	getInputSignalProcessor() Gets the signal processor which produces the set of signals which this processor modifies.
SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Gets the signal evaluator from the input signal.
void	setCarrierFrequency(double value) Sets the frequency to set on the modulated carrier signal created by this modulator, in hertz.
void	setDigitalModulation(TModulation value) Sets the digital modulation to add to the signals.
void	setInputSignalProcessor(SignalProcessor value) Sets the signal processor which produces the set of signals which this processor modifies.

Methods inherited from class agi.foundation.communications.signalprocessing.SignalProcessor

checkForSameDefinition, getProcessingDelay, getService, getSignalEvaluator, getSignalOutput

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

DigitalModulator

public DigitalModulator()

Initializes a new instance.

DigitalModulator

public DigitalModulator(SignalProcessor inputSignalProcessor,
                        TModulation digitalModulation,
                        double carrierFrequency)

Initialize a new instance based on the given input and modulation.

Parameters:

inputSignalProcessor - The source of the input signals to the modulator.

digitalModulation - The modulation to add to the signal.

carrierFrequency - The frequency for the carrier, in hertz.

DigitalModulator

protected DigitalModulator(@Nonnull
                           DigitalModulator<TModulation> 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(SignalProcessor 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 SignalProcessor

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(DigitalModulator<TModulation> 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 DigitalModulator.checkForSameDefinition(agi.foundation.communications.signalprocessing.SignalProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalProcessor

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.

getInputSignalProcessor

public SignalProcessor getInputSignalProcessor()

Gets the signal processor which produces the set of signals which this processor modifies.

Specified by:

getInputSignalProcessor in class SignalProcessor

setInputSignalProcessor

public void setInputSignalProcessor(SignalProcessor value)

Sets the signal processor which produces the set of signals which this processor modifies.

Specified by:

setInputSignalProcessor in class SignalProcessor

getCarrierFrequency

public final double getCarrierFrequency()

Gets the frequency to set on the modulated carrier signal created by this modulator, in hertz.

setCarrierFrequency

public final void setCarrierFrequency(double value)

Sets the frequency to set on the modulated carrier signal created by this modulator, in hertz.

getDigitalModulation

public final TModulation getDigitalModulation()

Gets the digital modulation to add to the signals.

setDigitalModulation

public final void setDigitalModulation(TModulation value)

Sets the digital modulation to add to the signals.

getSignalEvaluator

public SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                          SignalPropagationGraph graph)

Gets the signal evaluator from the input signal.

Specified by:

getSignalEvaluator in interface ISignalSource

Specified by:

getSignalEvaluator in class SignalProcessor

Parameters:

group - The evaluator group in which to create the evaluator.

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

Returns:

The signal evaluator from the input signal.

Throws:

ArgumentNullException - Thrown when group or graph is null.

PropertyInvalidException - Thrown if the input processor or the modulation is null.

PropertyInvalidException - Thrown when the frequency is negative.