public class SimpleReceiver extends Platform
ConstantGainAmplifier and IsotropicGainPattern.| Modifier | Constructor and Description |
|---|---|
|
SimpleReceiver()
Initializes a new instance.
|
protected |
SimpleReceiver(SimpleReceiver existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
SimpleReceiver(String name,
Point locationPoint,
Axes orientationAxes,
double gain,
double noiseFactor,
double targetFrequency,
double filterBandwidth)
Creates a new instance specifying all parameters.
|
|
SimpleReceiver(String name,
Point locationPoint,
Axes orientationAxes,
double gain,
double noiseFactor,
double targetFrequency,
double filterBandwidth,
PolarizationSource polarizationSource)
Creates a new instance specifying all parameters.
|
|
SimpleReceiver(String name,
Point locationPoint,
double gain,
double noiseFactor,
double targetFrequency,
double filterBandwidth)
Creates a new instance with the specified parameters.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(Platform other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(SimpleReceiver 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 |
getFilterBandwidth()
Gets the bandwidth used by the receiver's rectangular filter, in hertz.
|
double |
getGain()
Gets the gain for the amplifier (a factor that multiplies signal power) to apply to the input signal.
|
double |
getNoiseFactor()
|
double |
getNoiseTemperature()
Gets the noise temperature of the amplifier, in kelvin.
|
PolarizationSource |
getPolarizationSource()
Gets the polarization source for modeling polarization efficiency.
|
double |
getReferenceTemperature()
Gets the reference temperature for the amplifier, in kelvin.
|
double |
getTargetFrequency()
Gets the target frequency for the receiver, in hertz.
|
void |
setFilterBandwidth(double value)
Sets the bandwidth used by the receiver's rectangular filter, in hertz.
|
void |
setGain(double value)
Sets the gain for the amplifier (a factor that multiplies signal power) to apply to the input signal.
|
void |
setNoiseFactor(double value)
|
void |
setPolarizationSource(PolarizationSource value)
Sets the polarization source for modeling polarization efficiency.
|
void |
setReferenceTemperature(double value)
Sets the reference temperature for the amplifier, in kelvin.
|
void |
setTargetFrequency(double value)
Sets the target frequency for the receiver, in hertz.
|
ComplexReceiver |
toComplexReceiver()
Converts this receiver to an equivalent
ComplexReceiver. |
checkForSameDefinition, getChildren, getLocationPoint, getName, getOrientationAxes, getParent, getReferenceFrame, getService, setLocationPoint, setName, setOrientationAxescheckForSameDefinition, getExtensionsareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic SimpleReceiver()
public SimpleReceiver(String name, Point locationPoint, double gain, double noiseFactor, double targetFrequency, double filterBandwidth)
name - The name of the receiver.locationPoint - The Point defining the location of the receiver over time.gain - The gain value applied to the amplifier.noiseFactor - The noise factor applied to the amplifier.targetFrequency - The center frequency of the rectangular filter, in hertz.filterBandwidth - The total bandwidth of the rectangular filter in hertz.public SimpleReceiver(String name, Point locationPoint, Axes orientationAxes, double gain, double noiseFactor, double targetFrequency, double filterBandwidth)
Because the SimpleReceiver uses an IsotropicGainPattern, the orientation of this receiver does not affect the communications analysis.
The orientationAxes parameter in this constructor is made available to allow configuration for other analysis that may require it to be set.
name - The name of the receiver.locationPoint - The Point defining the location of the receiver over time.orientationAxes - The Axes defining the orientation of the receiver over time.gain - The gain value to be applied to the amplifier.noiseFactor - The noise factor to be applied to the amplifier.targetFrequency - The center frequency of the rectangular filter, in hertz.filterBandwidth - The total bandwidth of the rectangular filter, in hertz.public SimpleReceiver(String name, Point locationPoint, Axes orientationAxes, double gain, double noiseFactor, double targetFrequency, double filterBandwidth, PolarizationSource polarizationSource)
Because the SimpleReceiver uses an IsotropicGainPattern,
the orientation of this receiver does not affect the communications analysis.
The orientationAxes parameter in this constructor is made available
to allow configuration for other analysis that may require it to be set.
name - The name of the receiver.locationPoint - The Point defining the location of the receiver over time.orientationAxes - The Axes defining the orientation of the receiver over time.gain - The gain value to be applied to the amplifier.noiseFactor - The noise factor to be applied to the amplifier.targetFrequency - The center frequency of the rectangular filter, in Hertz.filterBandwidth - The total bandwidth of the rectangular filter, in Hertz.polarizationSource - The polarization source for modeling polarization efficiency.protected SimpleReceiver(@Nonnull SimpleReceiver existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;clone in interface ICloneWithContextclone in class Platformcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(Platform other)
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).checkForSameDefinition in class Platformother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(SimpleReceiver other)
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).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
SimpleReceiver.checkForSameDefinition(agi.foundation.platforms.Platform) method.computeCurrentDefinitionHashCode in class Platformpublic void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class Platformenumerator - The enumerator that is informed of the dependencies of this object.protected void freezeAggregatedObjects()
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.freezeAggregatedObjects in class Platformpublic final double getGain()
public final void setGain(double value)
public final double getNoiseFactor()
NoiseTemperature (get) to ReferenceTemperature (get / set) plus 1
(i.e. NoiseFactor (get / set) = NoiseTemperature (get)/ReferenceTemperature (get / set) + 1).
The NoiseFactor (get / set) defines how much noise the amplifier has.
A NoiseFactor (get / set) of 1.0 indicates the Amplifier has no noise.
A NoiseFactor (get / set) of 2 indicates a NoiseTemperature (get) equal to the ReferenceTemperature (get / set).
The default value is 1.0.
public final void setNoiseFactor(double value)
NoiseTemperature (get) to ReferenceTemperature (get / set) plus 1
(i.e. NoiseFactor (get / set) = NoiseTemperature (get)/ReferenceTemperature (get / set) + 1).
The NoiseFactor (get / set) defines how much noise the amplifier has.
A NoiseFactor (get / set) of 1.0 indicates the Amplifier has no noise.
A NoiseFactor (get / set) of 2 indicates a NoiseTemperature (get) equal to the ReferenceTemperature (get / set).
The default value is 1.0.
public final double getNoiseTemperature()
public final double getReferenceTemperature()
The default value is 290 K.
public final void setReferenceTemperature(double value)
The default value is 290 K.
public final double getTargetFrequency()
public final void setTargetFrequency(double value)
public final double getFilterBandwidth()
public final void setFilterBandwidth(double value)
public final PolarizationSource getPolarizationSource()
public final void setPolarizationSource(PolarizationSource value)
public final ComplexReceiver toComplexReceiver()
ComplexReceiver.ComplexReceiver that is equivalent to this simple receiver.