Package org.seamcat.model.plugin.antenna
Interface AntennaGainFactory
-
public interface AntennaGainFactory
Factory for instantiating antenna gain plugins.
Get an instance of this factory by calling
Factory.antennaGainFactory()
- See Also:
Factory
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AntennaGain<BeamFormingElementInput>
getBeamFormingElementAntenna()
AntennaGain<BeamFormingElementInput>
getBeamFormingElementAntenna(BeamFormingElementInput input, double peakGain)
<T> AntennaGain<T>
getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz)
<T> AntennaGain<T>
getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz, T input, double peakGain)
<T> AntennaGain<T>
getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz, T input, double peakGain, double azimuthOffset)
<T> AntennaGain<T>
getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz, T input, double peakGain, java.lang.String name, java.lang.String notes)
<T> AntennaGain<T>
getByConfiguration(Configuration<AntennaGainPlugin<T>,T> configuration)
AntennaGain<HorizontalVerticalInput>
getHorizontalVerticalAntenna()
HorizontalVerticalAntenna -using default configuration, i.e.AntennaGain<HorizontalVerticalInput>
getHorizontalVerticalAntenna(HorizontalVerticalInput input, double peakGain)
HorizontalVerticalAntenna horizontal pattern only selected: direct evaluation of the azimuth gain vertical pattern only selected: direct evaluation of the elevation angle if both horizontal and vertical pattern selected, then compute the combined gainif (Math.abs(horiGain - vertiGain) < 3){
  gain = G_max * sqrt(((G_horiz^2) + (G_vert^2))/2)
}else{
  gain = G_max * min(G_horiz,G_vert)
}
AntennaGain<ITU_R_F1245Input>
getITU_R_F1245Antenna()
AntennaGain<ITU_R_F1245Input>
getITU_R_F1245Antenna(ITU_R_F1245Input input, double peakGain)
AntennaGain<ITU_R_F1336_4_rec_2_Input>
getITU_R_F1336_4_rec_2Antenna()
AntennaGain<ITU_R_F1336_4_rec_2_Input>
getITU_R_F1336_4_rec_2Antenna(ITU_R_F1336_4_rec_2_Input input, double peakGain)
AntennaGain<ITU_R_F1336_4_rec_3_Input>
getITU_R_F1336_4_rec_3Antenna()
AntennaGain<ITU_R_F1336_4_rec_3_Input>
getITU_R_F1336_4_rec_3Antenna(ITU_R_F1336_4_rec_3_Input input, double peakGain)
AntennaGain<ITU_R_F699Input>
getITU_R_F699Antenna()
AntennaGain<ITU_R_F699Input>
getITU_R_F699Antenna(ITU_R_F699Input input, double peakGain)
AntennaGain<VoidInput>
getPeakGainAntenna()
Peak gain antenna Regardless of the direction this always returns the peak gain value specifiedAntennaGain<VoidInput>
getPeakGainAntenna(double peakGain)
Peak gain antenna Regardless of the direction this always returns the peak gain value specifiedAntennaGain<SphericalInput>
getSphericalAntenna()
Spherical Antenna - using default values The antenna gain is calculated using a spherical antenna patternAntennaGain<SphericalInput>
getSphericalAntenna(SphericalInput input, double peakGain)
Spherical Antenna The antenna gain is calculated using a spherical antenna pattern
-
-
-
Method Detail
-
getPeakGainAntenna
AntennaGain<VoidInput> getPeakGainAntenna()
Peak gain antenna Regardless of the direction this always returns the peak gain value specified
-
getPeakGainAntenna
AntennaGain<VoidInput> getPeakGainAntenna(double peakGain)
Peak gain antenna Regardless of the direction this always returns the peak gain value specified
-
getHorizontalVerticalAntenna
AntennaGain<HorizontalVerticalInput> getHorizontalVerticalAntenna()
HorizontalVerticalAntenna -using default configuration, i.e. only peak gain- horizontal pattern only selected: direct evaluation of the azimuth gain
- vertical pattern only selected: direct evaluation of the elevation angle
- if both horizontal and vertical pattern selected, then compute the combined gain
if (Math.abs(horiGain - vertiGain) < 3){
  gain = G_max * sqrt(((G_horiz^2) + (G_vert^2))/2)
}else{
  gain = G_max * min(G_horiz,G_vert)
}
-
getHorizontalVerticalAntenna
AntennaGain<HorizontalVerticalInput> getHorizontalVerticalAntenna(HorizontalVerticalInput input, double peakGain)
HorizontalVerticalAntenna- horizontal pattern only selected: direct evaluation of the azimuth gain
- vertical pattern only selected: direct evaluation of the elevation angle
- if both horizontal and vertical pattern selected, then compute the combined gain
if (Math.abs(horiGain - vertiGain) < 3){
  gain = G_max * sqrt(((G_horiz^2) + (G_vert^2))/2)
}else{
  gain = G_max * min(G_horiz,G_vert)
}
-
getSphericalAntenna
AntennaGain<SphericalInput> getSphericalAntenna()
Spherical Antenna - using default values The antenna gain is calculated using a spherical antenna pattern
-
getSphericalAntenna
AntennaGain<SphericalInput> getSphericalAntenna(SphericalInput input, double peakGain)
Spherical Antenna The antenna gain is calculated using a spherical antenna pattern
-
getITU_R_F699Antenna
AntennaGain<ITU_R_F699Input> getITU_R_F699Antenna()
-
getITU_R_F699Antenna
AntennaGain<ITU_R_F699Input> getITU_R_F699Antenna(ITU_R_F699Input input, double peakGain)
-
getITU_R_F1245Antenna
AntennaGain<ITU_R_F1245Input> getITU_R_F1245Antenna()
-
getITU_R_F1245Antenna
AntennaGain<ITU_R_F1245Input> getITU_R_F1245Antenna(ITU_R_F1245Input input, double peakGain)
-
getITU_R_F1336_4_rec_2Antenna
AntennaGain<ITU_R_F1336_4_rec_2_Input> getITU_R_F1336_4_rec_2Antenna()
-
getITU_R_F1336_4_rec_2Antenna
AntennaGain<ITU_R_F1336_4_rec_2_Input> getITU_R_F1336_4_rec_2Antenna(ITU_R_F1336_4_rec_2_Input input, double peakGain)
-
getITU_R_F1336_4_rec_3Antenna
AntennaGain<ITU_R_F1336_4_rec_3_Input> getITU_R_F1336_4_rec_3Antenna()
-
getITU_R_F1336_4_rec_3Antenna
AntennaGain<ITU_R_F1336_4_rec_3_Input> getITU_R_F1336_4_rec_3Antenna(ITU_R_F1336_4_rec_3_Input input, double peakGain)
-
getBeamFormingElementAntenna
AntennaGain<BeamFormingElementInput> getBeamFormingElementAntenna()
-
getBeamFormingElementAntenna
AntennaGain<BeamFormingElementInput> getBeamFormingElementAntenna(BeamFormingElementInput input, double peakGain)
-
getByConfiguration
<T> AntennaGain<T> getByConfiguration(Configuration<AntennaGainPlugin<T>,T> configuration)
-
getByClass
<T> AntennaGain<T> getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz)
-
getByClass
<T> AntennaGain<T> getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz, T input, double peakGain)
-
getByClass
<T> AntennaGain<T> getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz, T input, double peakGain, double azimuthOffset)
-
getByClass
<T> AntennaGain<T> getByClass(java.lang.Class<? extends AntennaGainPlugin<T>> clazz, T input, double peakGain, java.lang.String name, java.lang.String notes)
-
-