agi.foundation.communications.antennas

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

Class OpticalGainPattern

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.antennas.BaseGainPattern

agi.foundation.communications.antennas.OpticalGainPattern

All Implemented Interfaces:

IAntennaGainService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

GaussianOpticalGainPattern

public abstract class OpticalGainPattern
extends BaseGainPattern

Base class for all optical antenna gain patterns.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpticalGainPattern() Initializes a new instance.
protected	OpticalGainPattern(double apertureDiameter, double divergenceAngle, double efficiency, double pointingError) Create a new instance based on the given aperture diameter, divergence angle, efficiency, and pointing error.
protected	OpticalGainPattern(OpticalGainPattern 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(BaseGainPattern other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(OpticalGainPattern other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
double	getApertureDiameter() Gets the aperture diameter, in meters.
double	getDivergenceAngle() Gets the divergence angle, in radians.
double	getEfficiency() Gets the efficiency, as a ratio between zero and one.
double	getPointingError() Gets the pointing error angle, in radians.
void	setApertureDiameter(double value) Sets the aperture diameter, in meters.
void	setDivergenceAngle(double value) Sets the divergence angle, in radians.
void	setEfficiency(double value) Sets the efficiency, as a ratio between zero and one.
void	setPointingError(double value) Sets the pointing error angle, in radians.
protected void	validateProperties() Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.communications.antennas.BaseGainPattern

checkForSameDefinition, getAntennaGainEvaluator, getAntennaGainEvaluator, getApplyAntennaGainEvaluator, getService

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

OpticalGainPattern

protected OpticalGainPattern()

Initializes a new instance.

OpticalGainPattern

protected OpticalGainPattern(double apertureDiameter,
                             double divergenceAngle,
                             double efficiency,
                             double pointingError)

Create a new instance based on the given aperture diameter, divergence angle, efficiency, and pointing error.

Parameters:

apertureDiameter - The diameter of the optical circular aperture, in meters.

divergenceAngle - The beam divergence angle, in radians. Typically represents the angle at which the gain is 1/e² below the on axis (boresight) value.

efficiency - The efficiency of the optical antenna.

pointingError - The pointing error angle, in radians, for the optical antenna. The pointing error angle is defined as a constant offset which is added to the off-boresight angle, when computing the gain value. The off-boresight angle is the angle between the boresight vector and the link direction vector.

OpticalGainPattern

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

checkForSameDefinition

protected final boolean checkForSameDefinition(BaseGainPattern 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 BaseGainPattern

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(OpticalGainPattern 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 OpticalGainPattern.checkForSameDefinition(agi.foundation.communications.antennas.BaseGainPattern) method.

Overrides:

computeCurrentDefinitionHashCode in class BaseGainPattern

Returns:

The computed hash code.

getApertureDiameter

public final double getApertureDiameter()

Gets the aperture diameter, in meters.

setApertureDiameter

public final void setApertureDiameter(double value)

Sets the aperture diameter, in meters.

getDivergenceAngle

public final double getDivergenceAngle()

Gets the divergence angle, in radians. Typically represents the angle at which the gain is 1/e² below the on axis (boresight) value.

setDivergenceAngle

public final void setDivergenceAngle(double value)

Sets the divergence angle, in radians. Typically represents the angle at which the gain is 1/e² below the on axis (boresight) value.

getEfficiency

public final double getEfficiency()

Gets the efficiency, as a ratio between zero and one.

setEfficiency

public final void setEfficiency(double value)

Sets the efficiency, as a ratio between zero and one.

getPointingError

public final double getPointingError()

Gets the pointing error angle, in radians. The pointing error angle is defined as a constant offset which is added to the off-boresight angle, when computing the gain value. The off-boresight angle is the angle between the boresight vector and the link direction vector.

setPointingError

public final void setPointingError(double value)

Sets the pointing error angle, in radians. The pointing error angle is defined as a constant offset which is added to the off-boresight angle, when computing the gain value. The off-boresight angle is the angle between the boresight vector and the link direction vector.

validateProperties

protected void validateProperties()

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing BaseGainPattern.getApplyAntennaGainEvaluator(agi.foundation.EvaluatorGroup, agi.foundation.geometry.Vector, agi.foundation.geometry.Axes, agi.foundation.communications.ISignalSource, agi.foundation.communications.SignalPropagationGraph), as well as validate their own properties.

Throws:

PropertyInvalidException - Thrown if ApertureDiameter (get / set) or DivergenceAngle (get / set) is not positive, or if PointingError (get / set) is not greater than zero, or if Efficiency (get / set) is not between 0 and 1.