Made the CannotTransmit error a little prettier/more obvious.
Made the CannotTransmit error a little prettier/more obvious.
A little bit of reorganizing to fit the fields, properties, methods arrangement of the Squad files.

/* /*
* AntennaRange © 2013 toadicus * AntennaRange © 2013 toadicus
* *
* AntennaRange provides incentive and requirements for the use of the various antenna parts. * AntennaRange provides incentive and requirements for the use of the various antenna parts.
* Nominally, the breakdown is as follows: * Nominally, the breakdown is as follows:
* *
* Communotron 16 - Suitable up to Kerbalsynchronous Orbit * Communotron 16 - Suitable up to Kerbalsynchronous Orbit
* Comms DTS-M1 - Suitable throughout the Kerbin subsystem * Comms DTS-M1 - Suitable throughout the Kerbin subsystem
* Communotron 88-88 - Suitable throughout the Kerbol system. * Communotron 88-88 - Suitable throughout the Kerbol system.
* *
* This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a * This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a
* copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ * copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/
* *
* This software uses the ModuleManager library © 2013 ialdabaoth, used under a Creative Commons Attribution-ShareAlike 3.0 Uported License. * This software uses the ModuleManager library © 2013 ialdabaoth, used under a Creative Commons Attribution-ShareAlike 3.0 Uported License.
* *
*/ * This software uses code from the MuMechLib library, © 2013 r4m0n, used under the GNU GPL version 3.
  *
using System; */
using System.Collections.Generic;  
using KSP; using System;
  using System.Collections.Generic;
namespace AntennaRange using KSP;
{  
/* namespace AntennaRange
* ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles range- {
* finding, power scaling, and data scaling for antennas during science transmission. Its functionality varies with /*
* three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files. * ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles range-
* * finding, power scaling, and data scaling for antennas during science transmission. Its functionality varies with
* In general, the scaling functions assume the following relation: * three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files.
* *
* D² α P/R, * In general, the scaling functions assume the following relation:
* *
* where D is the total transmission distance, P is the transmission power, and R is the data rate. * D² α P/R,
* *
* */ * where D is the total transmission distance, P is the transmission power, and R is the data rate.
public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter *
{ * */
// Stores the packetResourceCost as defined in the .cfg file.  
protected float _basepacketResourceCost; /*
  * Fields
// Stores the packetSize as defined in the .cfg file. * */
protected float _basepacketSize; public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter
  {
// We don't have a Bard, so we're hiding Kerbin here. // Stores the packetResourceCost as defined in the .cfg file.
protected CelestialBody _Kerbin; protected float _basepacketResourceCost;
   
// Returns the current distance to the center of Kerbin, which is totally where the Kerbals keep their radioes. // Stores the packetSize as defined in the .cfg file.
protected double transmitDistance protected float _basepacketSize;
{  
get // We don't have a Bard, so we're hiding Kerbin here.
{ protected CelestialBody _Kerbin;
Vector3d KerbinPos = this._Kerbin.position;  
Vector3d ActivePos = base.vessel.GetWorldPos3D(); // Let's make the error text pretty!
  protected UnityEngine.GUIStyle ErrorStyle;
return (ActivePos - KerbinPos).magnitude;  
} // The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost
} // and packetSize.
  [KSPField(isPersistant = false)]
// Returns the maximum distance this module can transmit public float nominalRange;
public double maxTransmitDistance  
{ // The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power
get // cost exceeds packetResourceCost * maxPowerFactor, transmission will fail.
{ [KSPField(isPersistant = false)]
return Math.Sqrt (this.maxPowerFactor) * this.nominalRange; public float maxPowerFactor;
}  
} // The multipler on packetSize that defines the maximum data bandwidth of the antenna.
  [KSPField(isPersistant = false)]
// The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost public float maxDataFactor;
// and packetSize.  
[KSPField(isPersistant = false)] /*
public double nominalRange = 1500000d; * Properties
  * */
// The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power // Returns the current distance to the center of Kerbin, which is totally where the Kerbals keep their radioes.
// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail. protected double transmitDistance
[KSPField(isPersistant = false)] {
public float maxPowerFactor = 8f; get
  {
// The multipler on packetSize that defines the maximum data bandwidth of the antenna. Vector3d KerbinPos = this._Kerbin.position;
[KSPField(isPersistant = false)] Vector3d ActivePos = base.vessel.GetWorldPos3D();
public float maxDataFactor = 4f;  
  return (ActivePos - KerbinPos).magnitude;
// Override ModuleDataTransmitter.packetSize. Below the nominal range, scales up packetSize to }
// packetSize * maxDataFactor }
[KSPField(isPersistant = false)]  
public new float packetSize // Returns the maximum distance this module can transmit
{ public double maxTransmitDistance
get {
{ get
if (this.transmitDistance >= this.nominalRange) {
{ return Math.Sqrt (this.maxPowerFactor) * this.nominalRange;
return this._basepacketSize; }
} }
else  
{ /*
// From above, data rate increases with the inverse square of the distance. * The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except
return Math.Min(this._basepacketSize * (float)Math.Pow(this.nominalRange / this.transmitDistance, 2), * in that they both return floats. Here's some quick justification:
this._basepacketSize * this.maxDataFactor); *
} * The stock implementation of GetTransmitterScore (which I cannot override) is:
} * Score = (1 + DataResourceCost) / DataRate
set *
{ * The stock DataRate and DataResourceCost are:
this._basepacketSize = value; * DataRate = packetSize / packetInterval
} * DataResourceCost = packetResourceCost / packetSize
  *
} * So, the resulting score is essentially in terms of joules per byte per baud. Rearranging that a bit, it
  * could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte. Either way,
// Override ModuleDataTransmitter.packetResourceCost. Above the nominal range, scales up packetResourceCost to * that metric is not a very reasonable one.
// packetResourceCost * maxPowerFactor. *
[KSPField(isPersistant = false)] * Two metrics that might make more sense are joules per byte or joules per byte per second. The latter case
public new float packetResourceCost * would look like:
{ * DataRate = packetSize / packetInterval
get * DataResourceCost = packetResourceCost
{ *
if (this.transmitDistance <= this.nominalRange) * The former case, which I've chosen to implement below, is:
{ * DataRate = packetSize
return this._basepacketResourceCost; * DataResourceCost = packetResourceCost
} *
else * So... hopefully that doesn't screw with anything else.
{ * */
// From above, power increases with the square of the distance. // Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in
return this._basepacketResourceCost * (float)Math.Pow (this.transmitDistance / this.nominalRange, 2); // terms of joules/byte
} public new float DataRate
} {
set get
{ {
this._basepacketResourceCost = value; this.PreTransmit_SetPacketSize();
} return this.packetSize;
  }
} }
   
// Build ALL the objects. // Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas
public ModuleLimitedDataTransmitter () : base() // to be scored in terms of joules/byte
{ public new float DataResourceCost
// Go fetch Kerbin, because it is tricksy and hides from us. {
List<CelestialBody> bodies = FlightGlobals.Bodies; get
  {
foreach (CelestialBody body in bodies) this.PreTransmit_SetPacketResourceCost();
{ return this.packetResourceCost;
if (body.name == "Kerbin") }
{ }
this._Kerbin = body;  
break; /*
} * Methods
} * */
} // Build ALL the objects.
  public ModuleLimitedDataTransmitter () : base()
// Post an error in the communication messages describing the reason transmission has failed. Currently there {
// is only one reason for this. // Make the error posting prettier.
protected void PostCannotTransmitError() this.ErrorStyle = new UnityEngine.GUIStyle();
{ this.ErrorStyle.normal.textColor = (UnityEngine.Color)XKCDColors.OrangeRed;
string ErrorText = String.Format ("Unable to transmit: out of range! Maximum range = {0}; Current range = {1}.", this.maxTransmitDistance, this.transmitDistance); this.ErrorStyle.active.textColor = (UnityEngine.Color)XKCDColors.OrangeRed;
ScreenMessages.PostScreenMessage (new ScreenMessage (ErrorText, 4f, ScreenMessageStyle.UPPER_LEFT)); this.ErrorStyle.hover.textColor = (UnityEngine.Color)XKCDColors.OrangeRed;
} this.ErrorStyle.fontStyle = UnityEngine.FontStyle.Bold;
  this.ErrorStyle.padding.top = 32;
// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description. }
public override string GetInfo()  
{ // At least once, when the module starts with a state on the launch pad or later, go find Kerbin.
string text = base.GetInfo(); public override void OnStart (StartState state)
text += "Nominal Range: " + this.nominalRange.ToString() + "\n"; {
text += "Maximum Range: " + this.maxTransmitDistance.ToString() + "\n"; base.OnStart (state);
return text;  
} if (state >= StartState.PreLaunch && this._Kerbin == null)
  {
// Override ModuleDataTransmitter.CanTransmit to return false when transmission is not possible. // Go fetch Kerbin, because it is tricksy and hides from us.
public new bool CanTransmit() List<CelestialBody> bodies = FlightGlobals.Bodies;
{  
if (this.transmitDistance > this.maxTransmitDistance) foreach (CelestialBody body in bodies)
{ {
return false; if (body.name == "Kerbin")
} {
return true; this._Kerbin = body;
} break;
  }
// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit }
// returns false. }
public new void TransmitData(List<ScienceData> dataQueue) }
{  
if (this.CanTransmit()) // When the module loads, fetch the Squad KSPFields from the base. This is necessary in part because
{ // overloading packetSize and packetResourceCostinto a property in ModuleLimitedDataTransmitter didn't
base.TransmitData(dataQueue); // work.
} public override void OnLoad(ConfigNode node)
else {
{ this.Fields.Load(node);
this.PostCannotTransmitError (); base.Fields.Load(node);
}  
} base.OnLoad (node);
   
// Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit this._basepacketSize = base.packetSize;
// returns false. this._basepacketResourceCost = base.packetResourceCost;
public new void StartTransmission()  
{ Tools.PostDebugMessage(string.Format(
if (this.CanTransmit()) "{0} loaded:\n" +
{ "packetSize: {1}\n" +
base.StartTransmission(); "packetResourceCost: {2}\n" +
} "nominalRange: {3}\n" +
else "maxPowerFactor: {4}\n" +
{ "maxDataFactor: {5}\n",
this.PostCannotTransmitError (); this.name,
} base.packetSize,
} this._basepacketResourceCost,
} this.nominalRange,
} this.maxPowerFactor,
  this.maxDataFactor
  ));
  }
   
  // Post an error in the communication messages describing the reason transmission has failed. Currently there
  // is only one reason for this.
  protected void PostCannotTransmitError()
  {
  string ErrorText = string.Format (
  "Unable to transmit: out of range! Maximum range = {0}m; Current range = {1}m.",
  Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2),
  Tools.MuMech_ToSI((double)this.transmitDistance, 2)
  );
  ScreenMessages.PostScreenMessage(
  new ScreenMessage(
  ErrorText,
  4f,
  ScreenMessageStyle.UPPER_LEFT,
  this.ErrorStyle
  ));
  }
   
  // Before transmission, set packetResourceCost. Per above, packet cost increases with the square of
  // distance. packetResourceCost maxes out at _basepacketResourceCost * maxPowerFactor, at which point
  // transmission fails (see CanTransmit).
  protected void PreTransmit_SetPacketResourceCost()
  {
  if (this.transmitDistance <= this.nominalRange)
  {
  base.packetResourceCost = this._basepacketResourceCost;
  }
  else
  {
  base.packetResourceCost = this._basepacketResourceCost
  * (float)Math.Pow (this.transmitDistance / this.nominalRange, 2);
  }
  }
   
  // Before transmission, set packetSize. Per above, packet size increases with the inverse square of
  // distance. packetSize maxes out at _basepacketSize * maxDataFactor.
  protected void PreTransmit_SetPacketSize()
  {
  if (this.transmitDistance >= this.nominalRange)
  {
  base.packetSize = this._basepacketSize;
  }
  else
  {
  base.packetSize = Math.Min(
  this._basepacketSize * (float)Math.Pow (this.nominalRange / this.transmitDistance, 2),
  this._basepacketSize * this.maxDataFactor);
  }
  }
   
  // Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description.
  public override string GetInfo()
  {
  string text = base.GetInfo();
  text += "Nominal Range: " + Tools.MuMech_ToSI((double)this.nominalRange, 2) + "m\n";
  text += "Maximum Range: " + Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2) + "m\n";
  return text;
  }
   
  // Override ModuleDataTransmitter.CanTransmit to return false when transmission is not possible.
  public new bool CanTransmit()
  {
  if (this.transmitDistance > this.maxTransmitDistance)
  {
  return false;
  }
  return true;
  }
   
  // Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit
  // returns false.
  public new void TransmitData(List<ScienceData> dataQueue)
  {
  PreTransmit_SetPacketSize ();
  PreTransmit_SetPacketResourceCost ();
   
  Tools.PostDebugMessage (
  "distance: " + this.transmitDistance
  + " packetSize: " + this.packetSize
  + " packetResourceCost: " + this.packetResourceCost
  );
  if (this.CanTransmit())
  {
  base.TransmitData(dataQueue);
  }
  else
  {
  this.PostCannotTransmitError ();
  }
  }
   
  // Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit
  // returns false.
  public new void StartTransmission()
  {
  PreTransmit_SetPacketSize ();
  PreTransmit_SetPacketResourceCost ();
   
  Tools.PostDebugMessage (
  "distance: " + this.transmitDistance
  + " packetSize: " + this.packetSize
  + " packetResourceCost: " + this.packetResourceCost
  );
  if (this.CanTransmit())
  {
  base.StartTransmission();
  }
  else
  {
  this.PostCannotTransmitError ();
  }
  }
   
  // When debugging, it's nice to have a button that just tells you everything.
  #if DEBUG
  [KSPEvent (guiName = "Show Debug Info", active = true, guiActive = true)]
  public void DebugInfo()
  {
  PreTransmit_SetPacketSize ();
  PreTransmit_SetPacketResourceCost ();
   
  string msg = string.Format(
  "'{0}'\n" +
  "_basepacketSize: {1}\n" +
  "packetSize: {2}\n" +
  "_basepacketResourceCost: {3}\n" +
  "packetResourceCost: {4}\n" +
  "maxTransmitDistance: {5}\n" +
  "transmitDistance: {6}\n" +
  "nominalRange: {7}\n" +
  "CanTransmit: {8}\n" +
  "DataRate: {9}\n" +
  "DataResourceCost: {10}\n" +
  "TransmitterScore: {11}",
  this.name,
  this._basepacketSize,
  base.packetSize,
  this._basepacketResourceCost,
  base.packetResourceCost,
  this.maxTransmitDistance,
  this.transmitDistance,
  this.nominalRange,
  this.CanTransmit(),
  this.DataRate,
  this.DataResourceCost,
  ScienceUtil.GetTransmitterScore(this)
  );
  ScreenMessages.PostScreenMessage (new ScreenMessage (msg, 4f, ScreenMessageStyle.UPPER_RIGHT));
  }
  #endif
  }
   
  public static class Tools
  {
  // When debugging, be verbose. The Conditional attribute prevents this from firing when not DEBUGging.
  [System.Diagnostics.Conditional("DEBUG")]
  public static void PostDebugMessage(string Msg)
  {
  if (HighLogic.LoadedScene > GameScenes.SPACECENTER)
  {
  ScreenMessage Message = new ScreenMessage(Msg, 4f, ScreenMessageStyle.LOWER_CENTER);
  ScreenMessages.PostScreenMessage(Message);
  }
  else
  {
  KSPLog.print(Msg);
  }
  }
   
  /*
  * MuMech_ToSI is a part of the MuMechLib library, © 2013 r4m0n, used under the GNU GPL version 3.
  * */
  public static string MuMech_ToSI(double d, int digits = 3, int MinMagnitude = 0, int MaxMagnitude = int.MaxValue)
  {
  float exponent = (float)Math.Log10(Math.Abs(d));
  exponent = UnityEngine.Mathf.Clamp(exponent, (float)MinMagnitude, (float)MaxMagnitude);
   
  if (exponent >= 0)
  {
  switch ((int)Math.Floor(exponent))
  {
  case 0:
  case 1:
  case 2:
  return d.ToString("F" + digits);
  case 3:
  case 4:
  case 5:
  return (d / 1e3).ToString("F" + digits) + "k";
  case 6:
  case 7:
  case 8:
  return (d / 1e6).ToString("F" + digits) + "M";
  case 9:
  case 10:
  case 11:
  return (d / 1e9).ToString("F" + digits) + "G";
  case 12:
  case 13:
  case 14:
  return (d / 1e12).ToString("F" + digits) + "T";
  case 15:
  case 16:
  case 17:
  return (d / 1e15).ToString("F" + digits) + "P";
  case 18:
  case 19:
  case 20:
  return (d / 1e18).ToString("F" + digits) + "E";
  case 21:
  case 22:
  case 23:
  return (d / 1e21).ToString("F" + digits) + "Z";
  default:
  return (d / 1e24).ToString("F" + digits) + "Y";
  }
  }
  else if (exponent < 0)
  {
  switch ((int)Math.Floor(exponent))
  {
  case -1:
  case -2:
  case -3:
  return (d * 1e3).ToString("F" + digits) + "m";
  case -4:
  case -5:
  case -6:
  return (d * 1e6).ToString("F" + digits) + "μ";
  case -7:
  case -8:
  case -9:
  return (d * 1e9).ToString("F" + digits) + "n";
  case -10:
  case -11:
  case -12:
  return (d * 1e12).ToString("F" + digits) + "p";
  case -13:
  case -14:
  case -15:
  return (d * 1e15).ToString("F" + digits) + "f";
  case -16:
  case -17:
  case -18:
  return (d * 1e18).ToString("F" + digits) + "a";
  case -19:
  case -20:
  case -21:
  return (d * 1e21).ToString("F" + digits) + "z";
  default:
  return (d * 1e24).ToString("F" + digits) + "y";
  }
  }
  else
  {
  return "0";
  }
  }
  }
  }