public class SimpleDigitalTransmitter extends Platform implements IIdentifiableTransmitterService
ConstantGainAmplifier, IsotropicGainPattern and DigitalModulation.| Modifier | Constructor and Description |
|---|---|
|
SimpleDigitalTransmitter()
Creates a new instance using default values.
|
protected |
SimpleDigitalTransmitter(SimpleDigitalTransmitter existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
SimpleDigitalTransmitter(String name,
Point locationPoint,
Axes orientationAxes,
double carrierFrequency,
double effectiveIsotropicRadiatedPower,
double dataRate)
Creates a new instance from the specified parameters.
|
|
SimpleDigitalTransmitter(String name,
Point locationPoint,
Axes orientationAxes,
double carrierFrequency,
double effectiveIsotropicRadiatedPower,
double dataRate,
PolarizationSource polarizationSource)
Creates a new instance from the specified parameters.
|
|
SimpleDigitalTransmitter(String name,
Point locationPoint,
double carrierFrequency,
double effectiveIsotropicRadiatedPower,
double dataRate)
Creates a new instance from 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(SimpleDigitalTransmitter 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. |
double |
getCarrierFrequency()
Gets the frequency of the signal, in hertz.
|
double |
getDataRate()
Gets the rate at which the data is modulated on the carrier, in bits per second.
|
double |
getEffectiveIsotropicRadiatedPower()
Gets the Effective Isotropic Radiated Power (EIRP), in watts.
|
TimeIntervalCollection |
getGenerationTimes()
Gets a collection of the
TimeIntervals when the
transmitter is broadcasting. |
SignalIdentifier |
getIdentifier()
Gets the identifier for this transmitter's signals.
|
DigitalModulation |
getModulation()
Gets the
DigitalModulation. |
PolarizationSource |
getPolarizationSource()
Gets the source for modeling polarization.
|
void |
setCarrierFrequency(double value)
Sets the frequency of the signal, in hertz.
|
void |
setDataRate(double value)
Sets the rate at which the data is modulated on the carrier, in bits per second.
|
void |
setEffectiveIsotropicRadiatedPower(double value)
Sets the Effective Isotropic Radiated Power (EIRP), in watts.
|
void |
setIdentifier(SignalIdentifier value)
Sets the identifier for this transmitter's signals.
|
void |
setModulation(DigitalModulation value)
Sets the
DigitalModulation. |
void |
setPolarizationSource(PolarizationSource value)
Sets the source for modeling polarization.
|
ComplexDigitalTransmitter |
toComplexDigitalTransmitter()
Converts this digital transmitter to an equivalent
ComplexDigitalTransmitter. |
checkForSameDefinition, freezeAggregatedObjects, 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 SimpleDigitalTransmitter()
public SimpleDigitalTransmitter(String name, Point locationPoint, double carrierFrequency, double effectiveIsotropicRadiatedPower, double dataRate)
name - The name of the transmitter.locationPoint - The Point defining the location of the transmitter over time.carrierFrequency - The frequency, in hertz, that this transmitter broadcasts on.effectiveIsotropicRadiatedPower - The power, in watts, that this transmitter broadcasts isotropically.dataRate - The data rate, in bits per second.public SimpleDigitalTransmitter(String name, Point locationPoint, Axes orientationAxes, double carrierFrequency, double effectiveIsotropicRadiatedPower, double dataRate)
Because the SimpleDigitalTransmitter uses an IsotropicGainPattern,
the orientation of this transmitter 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 transmitter.locationPoint - The Point defining the location of the transmitter over time.orientationAxes - The Axes defining the orientation of the transmitter over time.carrierFrequency - The frequency, in hertz, that this transmitter broadcasts on.effectiveIsotropicRadiatedPower - The power, in watts, that this transmitter broadcasts isotropically.dataRate - The data rate in bits per second.public SimpleDigitalTransmitter(String name, Point locationPoint, Axes orientationAxes, double carrierFrequency, double effectiveIsotropicRadiatedPower, double dataRate, PolarizationSource polarizationSource)
Because the SimpleDigitalTransmitter uses an IsotropicGainPattern,
the orientation of this transmitter 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 transmitter.locationPoint - The Point defining the location of the transmitter over time.orientationAxes - The Axes defining the orientation of the transmitter over time.carrierFrequency - The frequency, in hertz, that this transmitter broadcasts on.effectiveIsotropicRadiatedPower - The power, in watts, that this transmitter broadcasts isotropically.dataRate - The rate at which data is modulated, using ModulationBpsk, onto the carrier frequency in bits per second.polarizationSource - The polarization source for modeling polarization efficiency.protected SimpleDigitalTransmitter(@Nonnull SimpleDigitalTransmitter 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(SimpleDigitalTransmitter 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()
SimpleDigitalTransmitter.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.public final ComplexDigitalTransmitter toComplexDigitalTransmitter()
ComplexDigitalTransmitter.ComplexDigitalTransmitter that is equivalent to this instance.public final double getEffectiveIsotropicRadiatedPower()
public final void setEffectiveIsotropicRadiatedPower(double value)
public final double getDataRate()
public final void setDataRate(double value)
public final double getCarrierFrequency()
public final void setCarrierFrequency(double value)
public final DigitalModulation getModulation()
DigitalModulation.public final void setModulation(DigitalModulation value)
DigitalModulation.public final TimeIntervalCollection getGenerationTimes()
TimeIntervals when the
transmitter is broadcasting.public final SignalIdentifier getIdentifier()
getIdentifier in interface IIdentifiableTransmitterServicepublic final void setIdentifier(SignalIdentifier value)
public final PolarizationSource getPolarizationSource()
public final void setPolarizationSource(PolarizationSource value)