agi.foundation.communications.signalprocessing

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

Class PulsedSignalSource

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.SignalSource

agi.foundation.communications.signalprocessing.PulsedSignalSource

All Implemented Interfaces:

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

public class PulsedSignalSource
extends SignalSource

A SignalSource which produces a pulsed signal. A pulsed signal is defined as a series of pulses repeating based on the pulse repetition frequency setting, each with the same pulse width.

Constructor Summary

Constructors

Modifier	Constructor and Description
	PulsedSignalSource() Initializes a new instance.
	PulsedSignalSource(PulsedSignalData pulsedSignalData) Initializes a new instance.
	PulsedSignalSource(PulsedSignalData pulsedSignalData, SignalDataCollection additionalSignalData) Create a new instance.
	PulsedSignalSource(PulsedSignalData pulsedSignalData, TimeIntervalCollection generationTimes, SignalDataCollection additionalSignalData) Create a new instance.
protected	PulsedSignalSource(PulsedSignalSource 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(PulsedSignalSource other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SignalSource 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.
PulsedSignalData	getPulsedSignalData() Gets the PulsedSignalData.
SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Get an evaluator which produces the new signal based on the signal properties and generation times.
void	setPulsedSignalData(PulsedSignalData value) Sets the PulsedSignalData.
protected void	validateProperties() Validates that all properties are configured correctly for evaluation.

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

checkForSameDefinition, getGenerationTimes, getInputSignalProcessor, getSignalToTransmit, setInputSignalProcessor, setSignalToTransmit

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

PulsedSignalSource

public PulsedSignalSource()

Initializes a new instance.

The generation times default to Infinite (get).

PulsedSignalSource

public PulsedSignalSource(PulsedSignalData pulsedSignalData)

Initializes a new instance.

The generation times default to Infinite (get).

Parameters:

pulsedSignalData - The pulsed signal data.

PulsedSignalSource

public PulsedSignalSource(PulsedSignalData pulsedSignalData,
                          SignalDataCollection additionalSignalData)

Create a new instance.

The generation times default to Infinite (get).

Parameters:

pulsedSignalData - The pulsed signal data.

additionalSignalData - Any additional data that should be included with the signal which is produced by the generator.

PulsedSignalSource

public PulsedSignalSource(PulsedSignalData pulsedSignalData,
                          TimeIntervalCollection generationTimes,
                          SignalDataCollection additionalSignalData)

Create a new instance.

Parameters:

pulsedSignalData - The pulsed signal data.

generationTimes - The times at which the signal is generated.

additionalSignalData - Any additional data that should be included with the signal which is produced by the generator.

PulsedSignalSource

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

Overrides:

clone in class SignalSource

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(SignalSource 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).

Overrides:

checkForSameDefinition in class SignalSource

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(PulsedSignalSource 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 PulsedSignalSource.checkForSameDefinition(agi.foundation.communications.signalprocessing.SignalSource) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalSource

Returns:

The computed hash code.

getPulsedSignalData

public final PulsedSignalData getPulsedSignalData()

Gets the PulsedSignalData.

setPulsedSignalData

public final void setPulsedSignalData(PulsedSignalData value)

Sets the PulsedSignalData.

validateProperties

protected void validateProperties()

Validates that all properties are configured correctly for evaluation.

getSignalEvaluator

public SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                          SignalPropagationGraph graph)

Get an evaluator which produces the new signal based on the signal properties and generation times.

The signal produced by the evaluator will contain as part of its data collection an instance of the PulsedSignalData containing the configured pulse repetition frequency, pulse width, and pulse count values.

Specified by:

getSignalEvaluator in interface ISignalSource

Overrides:

getSignalEvaluator in class SignalSource

Parameters:

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

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

Returns:

The evaluator for the new signal.

Throws:

PropertyInvalidException - Thrown if the PulseRepetitionFrequency (get) is less than or equal to 0.0, if the PulseCount (get) is less than 1, and if the PulseWidth (get) is less than or equal to 0.0 or greater than or equal to 1 / PulseRepetitionFrequency (get).

ArgumentNullException - Thrown when group or graph is null.