Transceiver

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.infrastructure.ExtensibleObject
  - - agi.foundation.communications.Transceiver

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, INameService, IServiceProvider
```
public class Transceiver
extends ExtensibleObject
implements INameService
```
The single input, single output Transceiver which takes in a single digital signal, demodulates it and then remodulates it using the specified modulation scheme, prior to retransmitting it.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Transceiver()` Initializes a new instance.
	`Transceiver(String name, Point inputAntennaLocationPoint, Axes inputAntennaOrientationAxes, RadioFrequencyGainPattern inputAntennaGainPattern, Point outputAntennaLocationPoint, Axes outputAntennaOrientationAxes, RadioFrequencyGainPattern outputAntennaGainPattern, DigitalModulation modulation, double gain, double noiseFactor, double carrierFrequency, SignalFilter filter)` Creates a new instance specifying all properties.
	`Transceiver(String name, Point inputAntennaLocationPoint, Axes inputAntennaOrientationAxes, RadioFrequencyGainPattern inputAntennaGainPattern, PolarizationSource inputPolarizationSource, Point outputAntennaLocationPoint, Axes outputAntennaOrientationAxes, RadioFrequencyGainPattern outputAntennaGainPattern, PolarizationSource outputPolarizationSource, DigitalModulation modulation, double gain, double noiseFactor, double carrierFrequency, SignalFilter filter)` Creates a new instance specifying all properties.
	`Transceiver(String name, Point inputAntennaLocationPoint, RadioFrequencyGainPattern inputAntennaGainPattern, Point outputAntennaLocationPoint, RadioFrequencyGainPattern outputAntennaGainPattern, DigitalModulation modulation, double gain, double noiseFactor, double carrierFrequency)` Creates a new instance using the specified properties.
`protected`	`Transceiver(Transceiver existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.

Method Summary

All Methods Instance Methods Concrete Methods
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(Transceiver 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.
`double`	`getCarrierFrequency()` Gets the carrier frequency of the remodulated signal, in hertz.
`SignalFilter`	`getFilter()` Gets the filter for the incoming signal, prior to amplification and retransmission.
`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 input antenna.
`double`	`getInputAntennaNoiseTemperature()` Gets the equivalent noise temperature for the antenna, in kelvin.
`PolarizationSource`	`getInputPolarizationSource()` Gets the input polarization source.
`DigitalModulation`	`getModulation()` Gets the type of modulation applied to the signal prior to retransmission.
`String`	`getName()` Gets the transceiver's name.
`Platform`	`getOutputAntenna()` Gets the output antenna platform.
`RadioFrequencyGainPattern`	`getOutputAntennaGainPattern()` Gets the antenna gain pattern used by the output antenna.
`double`	`getOutputGain()` Gets the gain (a factor that multiplies the signal power) applied to the signal after demodulation before remodulation.
`double`	`getOutputNoiseFactor()` Gets the `NoiseFactor` (`get` / `set`) used in the transceiver's `Amplifier` with respect to a `ReferenceTemperature` (`get` / `set`) of 290 kelvin.
`PolarizationSource`	`getOutputPolarizationSource()` Gets the output polarization source.
`void`	`setCarrierFrequency(double value)` Sets the carrier frequency of the remodulated signal, in hertz.
`void`	`setFilter(SignalFilter value)` Sets the filter for the incoming signal, prior to amplification and retransmission.
`void`	`setInputAntennaGainPattern(RadioFrequencyGainPattern value)` Sets the antenna gain pattern used by the input antenna.
`void`	`setInputAntennaNoiseTemperature(double value)` Sets the equivalent noise temperature for the antenna, in kelvin.
`void`	`setInputPolarizationSource(PolarizationSource value)` Sets the input polarization source.
`void`	`setModulation(DigitalModulation value)` Sets the type of modulation applied to the signal prior to retransmission.
`void`	`setName(String value)` Sets the transceiver's name.
`void`	`setOutputAntennaGainPattern(RadioFrequencyGainPattern value)` Sets the antenna gain pattern used by the output antenna.
`void`	`setOutputGain(double value)` Sets the gain (a factor that multiplies the signal power) applied to the signal after demodulation before remodulation.
`void`	`setOutputNoiseFactor(double value)` Sets the `NoiseFactor` (`get` / `set`) used in the transceiver's `Amplifier` with respect to a `ReferenceTemperature` (`get` / `set`) of 290 kelvin.
`void`	`setOutputPolarizationSource(PolarizationSource value)` Sets the output polarization source.

Methods inherited from class agi.foundation.infrastructure.ExtensibleObject
checkForSameDefinition, getExtensions, getService

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Transceiver
```
public Transceiver()
```
    Initializes a new instance.
    The default values for OutputGain (get / set) and OutputNoiseFactor (get / set) are 100 and 1.0 respectively.
  - Transceiver
```
public Transceiver(String name,
                   Point inputAntennaLocationPoint,
                   RadioFrequencyGainPattern inputAntennaGainPattern,
                   Point outputAntennaLocationPoint,
                   RadioFrequencyGainPattern outputAntennaGainPattern,
                   DigitalModulation modulation,
                   double gain,
                   double noiseFactor,
                   double carrierFrequency)
```
    Creates a new instance using the specified properties.
    
    Parameters:
    
    name - The name of the transceiver.
    
    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.
    
    modulation - The modulation used when retransmitting the signal.
    
    gain - The gain value to be applied to the transceiver's amplifier.
    
    noiseFactor - The OutputNoiseFactor (get / set) to be applied to the transceiver's amplifier.
    
    carrierFrequency - The carrier frequency of the remodulated signal.
  - Transceiver
```
public Transceiver(String name,
                   Point inputAntennaLocationPoint,
                   Axes inputAntennaOrientationAxes,
                   RadioFrequencyGainPattern inputAntennaGainPattern,
                   Point outputAntennaLocationPoint,
                   Axes outputAntennaOrientationAxes,
                   RadioFrequencyGainPattern outputAntennaGainPattern,
                   DigitalModulation modulation,
                   double gain,
                   double noiseFactor,
                   double carrierFrequency,
                   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.
    
    modulation - The modulation used when retransmitting the signal.
    
    gain - The gain value to be applied to the transceiver's amplifier.
    
    noiseFactor - The OutputNoiseFactor (get / set) factor to be applied to the transceiver's amplifier.
    
    carrierFrequency - The carrier frequency of the remodulated signal, in hertz.
    
    filter - The SignalFilter used to filter the incoming signal prior to amplification and retransmission.
  - Transceiver
```
public Transceiver(String name,
                   Point inputAntennaLocationPoint,
                   Axes inputAntennaOrientationAxes,
                   RadioFrequencyGainPattern inputAntennaGainPattern,
                   PolarizationSource inputPolarizationSource,
                   Point outputAntennaLocationPoint,
                   Axes outputAntennaOrientationAxes,
                   RadioFrequencyGainPattern outputAntennaGainPattern,
                   PolarizationSource outputPolarizationSource,
                   DigitalModulation modulation,
                   double gain,
                   double noiseFactor,
                   double carrierFrequency,
                   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.
    
    modulation - The modulation used when retransmitting the signal.
    
    gain - The gain value to be applied to the transceiver's amplifier.
    
    noiseFactor - The OutputNoiseFactor (get / set) factor to be applied to the transceiver's amplifier.
    
    carrierFrequency - The carrier frequency of the remodulated signal, in hertz.
    
    filter - The SignalFilter used to filter the incoming signal prior to amplification and retransmission.
  - Transceiver
```
protected Transceiver(@Nonnull
                      Transceiver 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(Transceiver 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 Transceiver.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.
  - 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 transceiver's name.
    
    Specified by:
    
    getName in interface INameService
  - setName
```
public final void setName(String value)
```
    Sets the transceiver'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.
  - getCarrierFrequency
```
public final double getCarrierFrequency()
```
    Gets the carrier frequency of the remodulated signal, in hertz.
  - setCarrierFrequency
```
public final void setCarrierFrequency(double value)
```
    Sets the carrier frequency of the remodulated signal, in hertz.
  - getInputAntennaGainPattern
```
public final RadioFrequencyGainPattern getInputAntennaGainPattern()
```
    Gets the antenna gain pattern used by the input antenna.
  - setInputAntennaGainPattern
```
public final void setInputAntennaGainPattern(RadioFrequencyGainPattern value)
```
    Sets the antenna gain pattern used by the input antenna.
  - getOutputAntennaGainPattern
```
public final RadioFrequencyGainPattern getOutputAntennaGainPattern()
```
    Gets the antenna gain pattern used by the output antenna.
  - setOutputAntennaGainPattern
```
public final void setOutputAntennaGainPattern(RadioFrequencyGainPattern value)
```
    Sets the antenna gain pattern used by the output antenna.
  - 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.
  - getOutputNoiseFactor
```
public final double getOutputNoiseFactor()
```
    Gets the NoiseFactor (get / set) used in the transceiver's Amplifier with respect to a ReferenceTemperature (get / set) of 290 kelvin.
  - setOutputNoiseFactor
```
public final void setOutputNoiseFactor(double value)
```
    Sets the NoiseFactor (get / set) used in the transceiver's Amplifier with respect to a ReferenceTemperature (get / set) of 290 kelvin.
  - getInputAntennaNoiseTemperature
```
public final double getInputAntennaNoiseTemperature()
```
    Gets the equivalent noise temperature for the antenna, in kelvin. It is used to model noise which comes from the antenna pointing at Earth's albedo and other effects prior to reaching the signal processors. It is added to any noise which is added during propagation.
  - setInputAntennaNoiseTemperature
```
public final void setInputAntennaNoiseTemperature(double value)
```
    Sets the equivalent noise temperature for the antenna, in kelvin. It is used to model noise which comes from the antenna pointing at Earth's albedo and other effects prior to reaching the signal processors. It is added to any noise which is added during propagation.
  - getModulation
```
public final DigitalModulation getModulation()
```
    Gets the type of modulation applied to the signal prior to retransmission.
  - setModulation
```
public final void setModulation(DigitalModulation value)
```
    Sets the type of modulation applied to the signal prior to retransmission.
  - getOutputGain
```
public final double getOutputGain()
```
    Gets the gain (a factor that multiplies the signal power) applied to the signal after demodulation before remodulation.
  - setOutputGain
```
public final void setOutputGain(double value)
```
    Sets the gain (a factor that multiplies the signal power) applied to the signal after demodulation before remodulation.
  - 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.

Class Transceiver

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.infrastructure.ExtensibleObject

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

Transceiver

Transceiver

Transceiver

Transceiver

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

freezeAggregatedObjects

getName

setName

getHardwareLink

getInputAntenna

getOutputAntenna

getCarrierFrequency

setCarrierFrequency

getInputAntennaGainPattern

setInputAntennaGainPattern

getOutputAntennaGainPattern

setOutputAntennaGainPattern

getInputPolarizationSource

setInputPolarizationSource

getOutputPolarizationSource

setOutputPolarizationSource

getOutputNoiseFactor

setOutputNoiseFactor

getInputAntennaNoiseTemperature

setInputAntennaNoiseTemperature

getModulation

setModulation

getOutputGain

setOutputGain

getFilter

setFilter