agi.foundation.communications.signalprocessing

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

Class DigitalDataSource

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.DigitalDataSource

All Implemented Interfaces:

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

public class DigitalDataSource
extends SignalProcessor

A digital data source which constructs a signal and adds a SignalDataRate property.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DigitalDataSource() Initializes a new instance.
protected	DigitalDataSource(DigitalDataSource existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	DigitalDataSource(double dataRate) Create a new source based on the given data rate.
	DigitalDataSource(double dataRate, SignalDataCollection signalData) Create a new source based on the given data rate and signal data.
	DigitalDataSource(double dataRate, SignalDataCollection signalData, TimeIntervalCollection generationTimes) Create a new source based on the given data rate, signal data and generation times.
	DigitalDataSource(double dataRate, TimeIntervalCollection generationTimes) Create a new source based on the given data rate and generation times.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DigitalDataSource 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.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
SignalDataCollection	getAdditionalSignalData() Gets the additional data included on the signal.
double	getDataRate() Gets the data rate in bits per second.
TimeIntervalCollection	getGenerationTimes() Gets a collection of the TimeIntervals when the signal is being generated.
SignalProcessor	getInputSignalProcessor() Gets the input to the signal processor.
SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Get an evaluator which produces the new signal based on the signal properties and generation times.
void	setDataRate(double value) Sets the data rate in bits per second.
void	setInputSignalProcessor(SignalProcessor value) Sets the input to the signal processor.

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

DigitalDataSource

public DigitalDataSource()

Initializes a new instance.

By default, the source will always produce a signal. The values are all zeros until set.

DigitalDataSource

public DigitalDataSource(double dataRate)

Create a new source based on the given data rate.

By default, the signal is continuously generated.

Parameters:

dataRate - The data rate, in bits per second.

DigitalDataSource

public DigitalDataSource(double dataRate,
                         SignalDataCollection signalData)

Create a new source based on the given data rate and signal data.

By default, the signal is continuously generated.

Parameters:

dataRate - The data rate, in bits per second.

signalData - The data to add to the signal.

DigitalDataSource

public DigitalDataSource(double dataRate,
                         @Nonnull
                         TimeIntervalCollection generationTimes)

Create a new source based on the given data rate and generation times.

Parameters:

dataRate - The data rate, in bits per second.

generationTimes - The times at which the signal is generated.

DigitalDataSource

public DigitalDataSource(double dataRate,
                         SignalDataCollection signalData,
                         @Nonnull
                         TimeIntervalCollection generationTimes)

Create a new source based on the given data rate, signal data and generation times.

Parameters:

dataRate - The data rate, in bits per second.

signalData - The data to add to the signal.

generationTimes - The times at which the signal is generated.

DigitalDataSource

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

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

getInputSignalProcessor

public SignalProcessor getInputSignalProcessor()

Gets the input to the signal processor. This is always null, and cannot be set, since this is the beginning of a chain of signal processors.

Specified by:

getInputSignalProcessor in class SignalProcessor

Throws:

IllegalStateException - Thrown if this property is set.

setInputSignalProcessor

public void setInputSignalProcessor(SignalProcessor value)

Sets the input to the signal processor. This is always null, and cannot be set, since this is the beginning of a chain of signal processors.

Specified by:

setInputSignalProcessor in class SignalProcessor

Throws:

IllegalStateException - Thrown if this property is set.

getSignalEvaluator

public SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                          SignalPropagationGraph graph)

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

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 evaluator for the new signal.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown if DataRate (get / set) is negative or zero.

getDataRate

public final double getDataRate()

Gets the data rate in bits per second. This adds a SignalDataRate object to the signal's data list.

setDataRate

public final void setDataRate(double value)

Sets the data rate in bits per second. This adds a SignalDataRate object to the signal's data list.

getAdditionalSignalData

@Nonnull
public final SignalDataCollection getAdditionalSignalData()

Gets the additional data included on the signal.

getGenerationTimes

@Nonnull
public final TimeIntervalCollection getGenerationTimes()

Gets a collection of the TimeIntervals when the signal is being generated.