agi.foundation.communications

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

Class Transponder

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ExtensibleObject

agi.foundation.communications.Transponder

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, INameService, IServiceProvider

public class Transponder
extends ExtensibleObject
implements INameService

The single input, single output transponder which takes in a signal, optionally filters it, amplifies it and then retransmits it without any demodulation or remodulation.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Transponder() Initializes a new instance.
	Transponder(String name, Point inputAntennaLocationPoint, Axes inputAntennaOrientationAxes, RadioFrequencyGainPattern inputAntennaGainPattern, Point outputAntennaLocationPoint, Axes outputAntennaOrientationAxes, RadioFrequencyGainPattern outputAntennaGainPattern, double gain, double noiseFactor, SignalFilter filter) Creates a new instance specifying all properties.
	Transponder(String name, Point inputAntennaLocationPoint, Axes inputAntennaOrientationAxes, RadioFrequencyGainPattern inputAntennaGainPattern, PolarizationSource inputPolarizationSource, Point outputAntennaLocationPoint, Axes outputAntennaOrientationAxes, RadioFrequencyGainPattern outputAntennaGainPattern, PolarizationSource outputPolarizationSource, double gain, double noiseFactor, SignalFilter filter) Creates a new instance specifying all properties.
	Transponder(String name, Point inputAntennaLocationPoint, RadioFrequencyGainPattern inputAntennaGainPattern, Point outputAntennaLocationPoint, RadioFrequencyGainPattern outputAntennaGainPattern, double gain, double noiseFactor) Creates a new instance with the specified properties.
protected	Transponder(Transponder 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(Transponder 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.
SignalFilter	getFilter() Gets the filter for the incoming signal, prior to amplification and retransmission.
double	getGain() Gets the gain (a factor that multiplies the signal power) used in the transponder's amplifier.
ExtensibleObject	getHardwareLink() Gets an instance of an ExtensibleObject which implements ILinkService and represents the wired link between the InputAntenna (get) and the OutputAntenna (get).
Platform	getInputAntenna() Gets the input antenna platform.
RadioFrequencyGainPattern	getInputAntennaGainPattern() Gets the antenna gain pattern used by the transponder's input antenna.
PolarizationSource	getInputPolarizationSource() Gets the input polarization source.
String	getName() Gets the transponder's name.
double	getNoiseFactor() Gets the NoiseFactor (get / set) used in the transponder's Amplifier.
Platform	getOutputAntenna() Gets the output antenna platform.
RadioFrequencyGainPattern	getOutputAntennaGainPattern() Gets the antenna gain pattern used by the transponder's output antenna.
PolarizationSource	getOutputPolarizationSource() Gets the output polarization source.
void	setFilter(SignalFilter value) Sets the filter for the incoming signal, prior to amplification and retransmission.
void	setGain(double value) Sets the gain (a factor that multiplies the signal power) used in the transponder's amplifier.
void	setInputAntennaGainPattern(RadioFrequencyGainPattern value) Sets the antenna gain pattern used by the transponder's input antenna.
void	setInputPolarizationSource(PolarizationSource value) Sets the input polarization source.
void	setName(String value) Sets the transponder's name.
void	setNoiseFactor(double value) Sets the NoiseFactor (get / set) used in the transponder's Amplifier.
void	setOutputAntennaGainPattern(RadioFrequencyGainPattern value) Sets the antenna gain pattern used by the transponder's output antenna.
void	setOutputPolarizationSource(PolarizationSource value) Sets the output polarization source.

Methods inherited from class agi.foundation.infrastructure.ExtensibleObject

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

Transponder

public Transponder()

Initializes a new instance.

The default values for Gain (get / set) and NoiseFactor (get / set) are 100 and 1.0 respectively.

Transponder

public Transponder(String name,
                   Point inputAntennaLocationPoint,
                   RadioFrequencyGainPattern inputAntennaGainPattern,
                   Point outputAntennaLocationPoint,
                   RadioFrequencyGainPattern outputAntennaGainPattern,
                   double gain,
                   double noiseFactor)

Creates a new instance with the specified properties.

Parameters:

name - The name of the transponder.

inputAntennaLocationPoint - The Point defining the location of the input antenna over time.

inputAntennaGainPattern - The gain pattern used by the input antenna.

outputAntennaLocationPoint - The Point defining the location of the output antenna over time.

outputAntennaGainPattern - The gain pattern used by the output antenna.

gain - The gain value to be applied to the transponder's amplifier.

noiseFactor - The NoiseFactor (get / set) to be applied to the transponder's amplifier.

Transponder

public Transponder(String name,
                   Point inputAntennaLocationPoint,
                   Axes inputAntennaOrientationAxes,
                   RadioFrequencyGainPattern inputAntennaGainPattern,
                   Point outputAntennaLocationPoint,
                   Axes outputAntennaOrientationAxes,
                   RadioFrequencyGainPattern outputAntennaGainPattern,
                   double gain,
                   double noiseFactor,
                   SignalFilter filter)

Creates a new instance specifying all properties.

Parameters:

name - The name of the transponder.

inputAntennaLocationPoint - The Point defining the location of the input antenna over time.

inputAntennaOrientationAxes - The Axes defining the orientation of the input antenna over time.

inputAntennaGainPattern - The gain pattern used by the input antenna.

outputAntennaLocationPoint - The Point defining the location of the output antenna over time.

outputAntennaOrientationAxes - The Axes defining the orientation of the output antenna over time.

outputAntennaGainPattern - The gain pattern used by the output antenna.

gain - The gain value to be applied to the transponder's amplifier.

noiseFactor - The NoiseFactor (get / set) factor to be applied to the transponder's amplifier.

filter - The SignalFilter used to filter the incoming signal prior to amplification and retransmission.

Transponder

public Transponder(String name,
                   Point inputAntennaLocationPoint,
                   Axes inputAntennaOrientationAxes,
                   RadioFrequencyGainPattern inputAntennaGainPattern,
                   PolarizationSource inputPolarizationSource,
                   Point outputAntennaLocationPoint,
                   Axes outputAntennaOrientationAxes,
                   RadioFrequencyGainPattern outputAntennaGainPattern,
                   PolarizationSource outputPolarizationSource,
                   double gain,
                   double noiseFactor,
                   SignalFilter filter)

Creates a new instance specifying all properties.

Parameters:

name - The name of the transponder.

inputAntennaLocationPoint - The Point defining the location of the input antenna over time.

inputAntennaOrientationAxes - The Axes defining the orientation of the input antenna over time.

inputAntennaGainPattern - The gain pattern used by the input antenna.

inputPolarizationSource - The input polarization source.

outputAntennaLocationPoint - The Point defining the location of the output antenna over time.

outputAntennaOrientationAxes - The Axes defining the orientation of the output antenna over time.

outputAntennaGainPattern - The gain pattern used by the output antenna.

outputPolarizationSource - The output polarization source.

gain - The gain value to be applied to the transponder's amplifier.

noiseFactor - The NoiseFactor (get / set) to be applied to the transponder's amplifier.

filter - The SignalFilter used to filter the incoming signal prior to amplification and retransmission.

Transponder

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

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.

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

Overrides:

computeCurrentDefinitionHashCode in class ExtensibleObject

Returns:

The computed hash code.

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 ExtensibleObject

getName

public final String getName()

Gets the transponder's name.

Specified by:

getName in interface INameService

setName

public final void setName(String value)

Sets the transponder's name.

getHardwareLink

public final ExtensibleObject getHardwareLink()

Gets an instance of an ExtensibleObject which implements ILinkService and represents the wired link between the InputAntenna (get) and the OutputAntenna (get).

getInputAntenna

public final Platform getInputAntenna()

Gets the input antenna platform.

getOutputAntenna

public final Platform getOutputAntenna()

Gets the output antenna platform.

getInputAntennaGainPattern

public final RadioFrequencyGainPattern getInputAntennaGainPattern()

Gets the antenna gain pattern used by the transponder's input antenna.

setInputAntennaGainPattern

public final void setInputAntennaGainPattern(RadioFrequencyGainPattern value)

Sets the antenna gain pattern used by the transponder's input antenna.

getOutputAntennaGainPattern

public final RadioFrequencyGainPattern getOutputAntennaGainPattern()

Gets the antenna gain pattern used by the transponder's output antenna.

setOutputAntennaGainPattern

public final void setOutputAntennaGainPattern(RadioFrequencyGainPattern value)

Sets the antenna gain pattern used by the transponder's output antenna.

getNoiseFactor

public final double getNoiseFactor()

Gets the NoiseFactor (get / set) used in the transponder's Amplifier.

setNoiseFactor

public final void setNoiseFactor(double value)

Sets the NoiseFactor (get / set) used in the transponder's Amplifier.

getGain

public final double getGain()

Gets the gain (a factor that multiplies the signal power) used in the transponder's amplifier.

setGain

public final void setGain(double value)

Sets the gain (a factor that multiplies the signal power) used in the transponder's amplifier.

getInputPolarizationSource

public final PolarizationSource getInputPolarizationSource()

Gets the input polarization source.

setInputPolarizationSource

public final void setInputPolarizationSource(PolarizationSource value)

Sets the input polarization source.

getOutputPolarizationSource

public final PolarizationSource getOutputPolarizationSource()

Gets the output polarization source.

setOutputPolarizationSource

public final void setOutputPolarizationSource(PolarizationSource value)

Sets the output polarization source.

getFilter

public final SignalFilter getFilter()

Gets the filter for the incoming signal, prior to amplification and retransmission.

setFilter

public final void setFilter(SignalFilter value)

Sets the filter for the incoming signal, prior to amplification and retransmission.