| Package | Description | 
|---|---|
| agi.foundation.communications | 
 Contains types for representing electromagnetic signals and propagating them along communication links. 
 | 
| agi.foundation.communications.antennas | 
 Contains types for representing antennas, defining gain patterns, and processing electromagnetic signals. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
OpticalGainPattern | 
OpticalTransmitter.getAntennaGainPattern()
Gets the  
OpticalGainPattern which represents the transmitter's optics. | 
OpticalGainPattern | 
OpticalReceiver.getAntennaGainPattern()
Gets the gain pattern for the receive optics. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
OpticalTransmitter.setAntennaGainPattern(OpticalGainPattern value)
Sets the  
OpticalGainPattern which represents the transmitter's optics. | 
void | 
OpticalReceiver.setAntennaGainPattern(OpticalGainPattern value)
Sets the gain pattern for the receive optics. 
 | 
| Constructor and Description | 
|---|
OpticalReceiver(String name,
               Point location,
               Axes orientation,
               Photodetector photodetector,
               OpticalGainPattern gainPattern)
Creates a new instance specifying all parameters. 
 | 
OpticalReceiver(String name,
               Point location,
               Axes orientation,
               Photodetector photodetector,
               OpticalGainPattern gainPattern,
               PolarizationSource polarizationSource)
Creates a new instance specifying all parameters. 
 | 
OpticalReceiver(String name,
               Point location,
               Photodetector photodetector,
               OpticalGainPattern gainPattern)
Creates a new instance using the specified name, location, photodetector, and optical gain pattern. 
 | 
OpticalTransmitter(String name,
                  Point locationPoint,
                  Axes orientation,
                  DigitalModulation modulation,
                  OpticalGainPattern antennaGainPattern,
                  double wavelength,
                  double power,
                  double dataRate,
                  SignalDataCollection signalData)
Creates a new instance specifying all parameters. 
 | 
OpticalTransmitter(String name,
                  Point locationPoint,
                  Axes orientation,
                  DigitalModulation modulation,
                  OpticalGainPattern antennaGainPattern,
                  double wavelength,
                  double power,
                  double dataRate,
                  SignalDataCollection signalData,
                  PolarizationSource polarizationSource)
Creates a new instance specifying all parameters. 
 | 
OpticalTransmitter(String name,
                  Point locationPoint,
                  DigitalModulation modulation,
                  OpticalGainPattern antennaGainPattern,
                  double wavelength,
                  double power,
                  double dataRate,
                  SignalDataCollection signalData)
Creates a new instance specifying all parameters except the Axes. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
GaussianOpticalGainPattern
A static gain pattern for an optical antenna with a gaussian profile. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected abstract boolean | 
OpticalGainPattern.checkForSameDefinition(OpticalGainPattern other)
Checks to determine if another instance has the same definition as this instance and
    returns  
true if it does. | 
protected boolean | 
GaussianOpticalGainPattern.checkForSameDefinition(OpticalGainPattern other)
Checks to determine if another instance has the same definition as this instance and
    returns  
true if it does. | 
| Modifier and Type | Method and Description | 
|---|---|
protected boolean | 
OpticalAntennaSignalProcessor.checkForSameDefinition(AntennaSignalProcessor<OpticalGainPattern> other)  | 
protected boolean | 
OpticalReceivingAntennaExtension.checkForSameDefinition(BaseReceivingAntennaExtension<OpticalGainPattern,OpticalAntennaSignalProcessor> other)  | 
protected boolean | 
OpticalTransmittingAntennaExtension.checkForSameDefinition(BaseTransmittingAntennaExtension<OpticalGainPattern> other)  | 
| Constructor and Description | 
|---|
OpticalGainPattern(OpticalGainPattern existingInstance,
                  CopyContext context)
Initializes a new instance as a copy of an existing instance. 
 | 
OpticalReceivingAntennaExtension(OpticalGainPattern antennaGainPattern)
Initialize a new instance based on the given gain pattern and antenna noise. 
 | 
OpticalReceivingAntennaExtension(OpticalGainPattern antennaGainPattern,
                                PolarizationSource polarizationSource)
Initialize a new instance based on the given gain pattern and polarization source. 
 | 
OpticalTransmittingAntennaExtension(SignalProcessor inputSignalProcessor,
                                   OpticalGainPattern antennaGainPattern)
Initialize a new instance based on the given gain pattern and a signal processor which produces the
    set of signals to transmit. 
 | 
OpticalTransmittingAntennaExtension(SignalProcessor input,
                                   OpticalGainPattern antennaGainPattern,
                                   PolarizationSource polarizationSource)
Initialize a new instance based on the given gain pattern, a signal processor which produces the
    set of signals to transmit, and a polarization source which generates the transmit polarization. 
 | 
| Constructor and Description | 
|---|
OpticalAntennaSignalProcessor(IReceivingAntennaExtension<OpticalGainPattern> receivingAntennaExtension)
Initializes a new instance with a given parent receiving antenna extension. 
 | 
OpticalAntennaSignalProcessor(IReceivingAntennaExtension<OpticalGainPattern> receivingAntennaExtension,
                             PolarizationSource polarizationSource)
Initializes a new instance with a given parent receiving antenna extension. 
 |