agi.foundation.geometry

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

Class ScalarDelayedByLink

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.geometry.Scalar

agi.foundation.geometry.ScalarDelayedByLink

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class ScalarDelayedByLink
extends Scalar

A scalar which wraps another scalar while delaying it by a time specified by a LinkDelayEvaluator obtained from a LinkPath. When evaluating this scalar at a given time, the resulting value will represent the value of the wrapped scalar at the delayed time. The time delay is either positive or negative, depending on the LinkRole of this scalar.

Usually, the ScalarDelayedByLink will act as a LinkRole.RECEIVER and the time delay will evaluate the wrapped scalar by applying the "offset to time of transmission" to the time at which this scalar is evaluated.

Constructor Summary

Constructors

Constructor and Description
ScalarDelayedByLink() Initializes a new instance.
ScalarDelayedByLink(Scalar scalarToDelay, IServiceProvider link, LinkRole directionOfDelay) Initialize a new instance based on the given scalar delayed by the given link.
ScalarDelayedByLink(Scalar scalarToDelay, LinkPath linkPath, LinkRole directionOfDelay) Initialize a new instance based on the given scalar delayed by the given link.

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.
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.
LinkRole	getDirectionOfDelay() Gets an enumeration indicating the direction of the delay to apply to ScalarToDelay (get / set).
ScalarEvaluator	getEvaluator(EvaluatorGroup group) Get an evaluator which evaluates the ScalarToDelay (get / set) by applying the delay from the PathForTimeDelay (get / set) which will be positive or negative depending on the DirectionOfDelay (get / set).
LinkPath	getPathForTimeDelay() Gets the path from which to obtain the link delay.
Scalar	getScalarToDelay() Gets the scalar which is delayed by the PathForTimeDelay (get / set).
void	setDirectionOfDelay(LinkRole value) Sets an enumeration indicating the direction of the delay to apply to ScalarToDelay (get / set).
void	setPathForTimeDelay(LinkPath value) Sets the path from which to obtain the link delay.
void	setScalarToDelay(Scalar value) Sets the scalar which is delayed by the PathForTimeDelay (get / set).

Methods inherited from class agi.foundation.geometry.Scalar

add, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, 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, 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

ScalarDelayedByLink

public ScalarDelayedByLink()

Initializes a new instance.

ScalarDelayedByLink

public ScalarDelayedByLink(Scalar scalarToDelay,
                           IServiceProvider link,
                           @Nonnull
                           LinkRole directionOfDelay)

Initialize a new instance based on the given scalar delayed by the given link.

Usually, the directionOfDelay will be LinkRole.RECEIVER and the time delay will evaluate the scalarToDelay by applying the offset to time of transmission to the time at which this scalar is evaluated.

Parameters:

scalarToDelay - The scalar to evaluate at a delayed time.

link - The link which provides the delay.

directionOfDelay - An enumeration indicating at which end of the link this scalar is to be evaluated. If this scalar is at the receiving end, the scalarToDelay will be evaluated before this scalar. If this scalar is at the transmitting end, the scalarToDelay will be evaluated after this scalar.

ScalarDelayedByLink

public ScalarDelayedByLink(Scalar scalarToDelay,
                           @Nonnull
                           LinkPath linkPath,
                           @Nonnull
                           LinkRole directionOfDelay)

Initialize a new instance based on the given scalar delayed by the given link.

Usually, the directionOfDelay will be LinkRole.RECEIVER and the time delay will evaluate the scalarToDelay by applying the offset to time of transmission to the time at which this scalar is evaluated.

Parameters:

scalarToDelay - The scalar to evaluate at a delayed time.

linkPath - The link path which provides the delay.

directionOfDelay - An enumeration indicating at which end of the link the scalar is to be evaluated. If the scalar is at the receiving end, the scalarToDelay will be evaluated after this scalar. If the scalar is at the transmitting end, the scalarToDelay will be evaluated before this scalar.

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

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 ScalarDelayedByLink.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.

getPathForTimeDelay

public final LinkPath getPathForTimeDelay()

Gets the path from which to obtain the link delay.

setPathForTimeDelay

public final void setPathForTimeDelay(LinkPath value)

Sets the path from which to obtain the link delay.

getScalarToDelay

public final Scalar getScalarToDelay()

Gets the scalar which is delayed by the PathForTimeDelay (get / set).

setScalarToDelay

public final void setScalarToDelay(Scalar value)

Sets the scalar which is delayed by the PathForTimeDelay (get / set).

getDirectionOfDelay

@Nonnull
public final LinkRole getDirectionOfDelay()

Gets an enumeration indicating the direction of the delay to apply to ScalarToDelay (get / set). If the direction is receiving, the ScalarToDelay (get / set) will be evaluated at a time prior to this scalar, representing the offset to the time of transmission. If the role is transmitting, the ScalarToDelay (get / set) will be evaluated at a time after this scalar, representing the offset to the time of reception. By default, the value is: receiving.

setDirectionOfDelay

public final void setDirectionOfDelay(@Nonnull
                                      LinkRole value)

Sets an enumeration indicating the direction of the delay to apply to ScalarToDelay (get / set). If the direction is receiving, the ScalarToDelay (get / set) will be evaluated at a time prior to this scalar, representing the offset to the time of transmission. If the role is transmitting, the ScalarToDelay (get / set) will be evaluated at a time after this scalar, representing the offset to the time of reception. By default, the value is: receiving.

getEvaluator

public ScalarEvaluator getEvaluator(EvaluatorGroup group)

Get an evaluator which evaluates the ScalarToDelay (get / set) by applying the delay from the PathForTimeDelay (get / set) which will be positive or negative depending on the DirectionOfDelay (get / set).

Specified by:

getEvaluator in class Scalar

Parameters:

group - The group in which to create evaluators.

Returns:

An evaluator for the delayed scalar.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown when ScalarToDelay (get / set) or PathForTimeDelay (get / set) is null.