agi.foundation.celestial

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

Class LinkRefracted

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ExtensibleObject

agi.foundation.celestial.LinkRefracted

All Implemented Interfaces:

ILinkService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, INameService, IServiceProvider

public class LinkRefracted
extends ExtensibleObject
implements ILinkService, INameService

A link between a Transmitter (get) and Receiver (get) that travels a refracted path. The refracted link relies on an underlying ExtensibleObject link instance as well as a AtmosphericRefractionModel (get / set) refraction model as the basis for computing the refracted link. In this way, a refracted link which also accounts for light travel time can be achieved by configuring the refracted link with a LinkSpeedOfLight instance as the underlying link. Or if light travel time is not important to the analysis, the LinkInstantaneous can be used as the basis for refraction.

Constructor Summary

Constructors

Modifier	Constructor and Description
	LinkRefracted() Initializes a new instance.
	LinkRefracted(IServiceProvider unrefractedLink, AtmosphericRefractionModel atmosphericRefractionModel) Initializes a new instance.
protected	LinkRefracted(LinkRefracted 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(ExtensibleObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(LinkRefracted 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.
AtmosphericRefractionModel	getAtmosphericRefractionModel() Gets the atmospheric refraction model.
String	getName() Gets the name of the underlying unrefracted link.
LinkDelayEvaluator	getOffsetToReceptionTimeEvaluator(EvaluatorGroup group) Gets an evaluator that, given a time at which an event occurs at the Transmitter (get), evaluates the time at which the event is received by the Receiver (get).
LinkDelayEvaluator	getOffsetToTransmissionTimeEvaluator(EvaluatorGroup group) Gets an evaluator that, given a time at which an event is received at the Receiver (get), evaluates the time at which the event occurred at the Transmitter (get).
IServiceProvider	getReceiver() Gets the receiver of the underlying unrefracted link.
VectorDisplacement	getReceiverDisplacementRelativeToTransmitter() Gets a displacement vector that represents the refracted displacement to the Receiver (get) as observed by the Transmitter (get).
IServiceProvider	getTransmitter() Gets the transmitter of the underlying unrefracted link.
VectorDisplacement	getTransmitterDisplacementRelativeToReceiver() Gets a displacement vector that represents the refracted displacement to the Transmitter (get) as observed by the Receiver (get).
IServiceProvider	getUnrefractedLink() Gets the underlying unrefracted link.
void	setAtmosphericRefractionModel(AtmosphericRefractionModel value) Sets the atmospheric refraction model.
void	setUnrefractedLink(IServiceProvider value) Sets the underlying unrefracted link.

Methods inherited from class agi.foundation.infrastructure.ExtensibleObject

checkForSameDefinition, freezeAggregatedObjects, getExtensions, getService

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

LinkRefracted

public LinkRefracted()

Initializes a new instance.

LinkRefracted

public LinkRefracted(IServiceProvider unrefractedLink,
                     AtmosphericRefractionModel atmosphericRefractionModel)

Initializes a new instance.

The unrefractedLink must provide the INameService and ILinkService services.

Parameters:

unrefractedLink - The unrefracted link used as a basis for refraction.

atmosphericRefractionModel - The refraction model which computes the refraction angle used to adjust the unrefracted link's motion.

LinkRefracted

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

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(ExtensibleObject 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 ExtensibleObject

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(LinkRefracted 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 LinkRefracted.checkForSameDefinition(agi.foundation.infrastructure.ExtensibleObject) method.

Overrides:

computeCurrentDefinitionHashCode in class ExtensibleObject

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 ExtensibleObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getName

public final String getName()

Gets the name of the underlying unrefracted link.

Specified by:

getName in interface INameService

Throws:

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

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the INameService service.

getTransmitter

public final IServiceProvider getTransmitter()

Gets the transmitter of the underlying unrefracted link.

Specified by:

getTransmitter in interface ILinkService

Throws:

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

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the ILinkService service.

getReceiver

public final IServiceProvider getReceiver()

Gets the receiver of the underlying unrefracted link.

Specified by:

getReceiver in interface ILinkService

Throws:

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

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the ILinkService service.

getUnrefractedLink

public final IServiceProvider getUnrefractedLink()

Gets the underlying unrefracted link.

setUnrefractedLink

public final void setUnrefractedLink(IServiceProvider value)

Sets the underlying unrefracted link.

getAtmosphericRefractionModel

public final AtmosphericRefractionModel getAtmosphericRefractionModel()

Gets the atmospheric refraction model.

setAtmosphericRefractionModel

public final void setAtmosphericRefractionModel(AtmosphericRefractionModel value)

Sets the atmospheric refraction model.

getTransmitterDisplacementRelativeToReceiver

public final VectorDisplacement getTransmitterDisplacementRelativeToReceiver()

Gets a displacement vector that represents the refracted displacement to the Transmitter (get) as observed by the Receiver (get).

Specified by:

getTransmitterDisplacementRelativeToReceiver in interface ILinkService

Returns:

The displacement vector.

Throws:

PropertyInvalidException - Thrown when UnrefractedLink (get / set) or AtmosphericRefractionModel (get / set) is null.

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the ILinkService service.

getReceiverDisplacementRelativeToTransmitter

public final VectorDisplacement getReceiverDisplacementRelativeToTransmitter()

Gets a displacement vector that represents the refracted displacement to the Receiver (get) as observed by the Transmitter (get).

Specified by:

getReceiverDisplacementRelativeToTransmitter in interface ILinkService

Returns:

The displacement vector.

Throws:

PropertyInvalidException - Thrown when UnrefractedLink (get / set) or AtmosphericRefractionModel (get / set) is null.

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the ILinkService service.

getOffsetToTransmissionTimeEvaluator

public final LinkDelayEvaluator getOffsetToTransmissionTimeEvaluator(EvaluatorGroup group)

Gets an evaluator that, given a time at which an event is received at the Receiver (get), evaluates the time at which the event occurred at the Transmitter (get).

Specified by:

getOffsetToTransmissionTimeEvaluator in interface ILinkService

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

The evaluator.

Throws:

ArgumentNullException - Thrown when group is null.

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

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the ILinkService service.

getOffsetToReceptionTimeEvaluator

public final LinkDelayEvaluator getOffsetToReceptionTimeEvaluator(EvaluatorGroup group)

Gets an evaluator that, given a time at which an event occurs at the Transmitter (get), evaluates the time at which the event is received by the Receiver (get).

Specified by:

getOffsetToReceptionTimeEvaluator in interface ILinkService

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

The evaluator.

Throws:

ArgumentNullException - Thrown when group is null.

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

ServiceNotAvailableException - Thrown when UnrefractedLink (get / set) does not provide the ILinkService service.