agi.foundation.communications.antennas

(agi.foundation.communications-2025r1.jar)

Class StaticDirection

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.antennas.StaticDirection

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class StaticDirection
extends DefinitionalObject

Type which associates a direction, in the form of a UnitCartesian, with a TimeIntervalCollection of availability intervals and an optional weighting metric.

The weighting metric can be used by the MinimumVarianceDistortionlessResponseBeamformer when determining the covariance matrix used when computing the complex element weights. The complex elements weights are used to steer nulls in desired directions. For example, if the weighting metric is set to be the received power from a jamming source, the beamformer can prioritize forming nulls in the direction of the jamming source with the largest interference power.

Constructor Summary

Constructors

Modifier	Constructor and Description
	StaticDirection() Initializes a new instance.
protected	StaticDirection(StaticDirection existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	StaticDirection(UnitCartesian direction) Initializes a new instance.
	StaticDirection(UnitCartesian direction, TimeIntervalCollection availability) Initializes a new instance.
	StaticDirection(UnitCartesian direction, TimeIntervalCollection availability, double weightingMetric) Initializes a new instance.
	StaticDirection(UnitCartesian direction, TimeIntervalCollection availability, Scalar weightingMetric) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(StaticDirection 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.
TimeIntervalCollection	getAvailability() Gets the collection of availability intervals.
UnitCartesian	getDirection() Gets the direction.
Scalar	getWeightingMetric() Gets the associated weighting metric.
void	setAvailability(TimeIntervalCollection value) Sets the collection of availability intervals.
void	setDirection(UnitCartesian value) Sets the direction.
void	setWeightingMetric(Scalar value) Sets the associated weighting metric.

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

StaticDirection

public StaticDirection()

Initializes a new instance.

Direction defaults to a UnitZ (get), availability defaults to Infinite (get), and weighting metric defaults to 1.0.

StaticDirection

public StaticDirection(@Nonnull
                       UnitCartesian direction)

Initializes a new instance.

Availability defaults to Infinite (get) and weighting metric defaults to 1.0.

Parameters:

direction - The direction.

StaticDirection

public StaticDirection(@Nonnull
                       UnitCartesian direction,
                       TimeIntervalCollection availability)

Initializes a new instance.

Weighting metric defaults to 1.0.

Parameters:

direction - The direction.

availability - The collection of availability intervals.

StaticDirection

public StaticDirection(@Nonnull
                       UnitCartesian direction,
                       @Nonnull
                       TimeIntervalCollection availability,
                       double weightingMetric)

Initializes a new instance.

Parameters:

direction - The direction.

availability - The collection of availability intervals.

weightingMetric - The associated weighting metric.

StaticDirection

public StaticDirection(@Nonnull
                       UnitCartesian direction,
                       @Nonnull
                       TimeIntervalCollection availability,
                       @Nonnull
                       Scalar weightingMetric)

Initializes a new instance.

Parameters:

direction - The direction.

availability - The collection of availability intervals.

weightingMetric - The associated weighting metric.

StaticDirection

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

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

getAvailability

@Nonnull
public final TimeIntervalCollection getAvailability()

Gets the collection of availability intervals.

setAvailability

public final void setAvailability(@Nonnull
                                  TimeIntervalCollection value)

Sets the collection of availability intervals.

getDirection

@Nonnull
public final UnitCartesian getDirection()

Gets the direction.

setDirection

public final void setDirection(@Nonnull
                               UnitCartesian value)

Sets the direction.

getWeightingMetric

public final Scalar getWeightingMetric()

Gets the associated weighting metric.

The weighting metric can be used by beamformers in order to prioritize directions when computing complex element weights.

setWeightingMetric

public final void setWeightingMetric(Scalar value)

Sets the associated weighting metric.

The weighting metric can be used by beamformers in order to prioritize directions when computing complex element weights.