Added a configuration window to the spacecenter for the toggling of options, and cleaned up some failure reporting a bit.
[AntennaRange.git] / ModuleLimitedDataTransmitter.cs
blob:a/ModuleLimitedDataTransmitter.cs -> blob:b/ModuleLimitedDataTransmitter.cs
// AntennaRange // AntennaRange
// //
// ModuleLimitedDataTransmitter.cs // ModuleLimitedDataTransmitter.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using KSP; using KSP;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;  
using System.Text; using System.Text;
using ToadicusTools; using ToadicusTools;
using UnityEngine; using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
/* /// <summary>
* ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles range- /// <para>ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles
* finding, power scaling, and data scaling for antennas during science transmission. Its functionality varies with /// rangefinding, power scaling, and data scaling for antennas during science transmission. Its functionality
* three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files. /// varies with three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files.</para>
* ///
* In general, the scaling functions assume the following relation: /// <para>In general, the scaling functions assume the following relation:</para>
* ///
* D² α P/R, /// <para> D² α P/R,</para>
* ///
* where D is the total transmission distance, P is the transmission power, and R is the data rate. /// <para>where D is the total transmission distance, P is the transmission power, and R is the data rate.</para>
* /// </summary>
* */  
   
/*  
* Fields  
* */  
public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay
{ {
// Stores the packetResourceCost as defined in the .cfg file. // Stores the packetResourceCost as defined in the .cfg file.
protected float _basepacketResourceCost; private float _basepacketResourceCost;
   
// Stores the packetSize as defined in the .cfg file. // Stores the packetSize as defined in the .cfg file.
protected float _basepacketSize; private float _basepacketSize;
   
// Every antenna is a relay. // Every antenna is a relay.
protected AntennaRelay relay; private AntennaRelay relay;
   
// Keep track of vessels with transmitters for relay purposes.  
protected List<Vessel> _relayVessels;  
   
// Sometimes we will need to communicate errors; this is how we do it. // Sometimes we will need to communicate errors; this is how we do it.
protected ScreenMessage ErrorMsg; private ScreenMessage ErrorMsg;
   
// The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost /// <summary>
// and packetSize. /// The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost
  /// and packetSize.
  /// </summary>
[KSPField(isPersistant = false)] [KSPField(isPersistant = false)]
public float nominalRange; public double nominalRange;
   
  /// <summary>
  /// Relay status string for use in action menus.
  /// </summary>
  [KSPField(isPersistant = false, guiActive = true, guiName = "Status")]
  public string UIrelayStatus;
   
  /// <summary>
  /// Relay target string for use in action menus.
  /// </summary>
  [KSPField(isPersistant = false, guiActive = true, guiName = "Relay")]
  public string UIrelayTarget;
   
  /// <summary>
  /// Transmit distance string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")] [KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")]
public string UItransmitDistance; public string UItransmitDistance;
   
  /// <summary>
  /// Maximum distance string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Maximum Distance")] [KSPField(isPersistant = false, guiActive = true, guiName = "Maximum Distance")]
public string UImaxTransmitDistance; public string UImaxTransmitDistance;
   
  /// <summary>
  /// Packet size string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Packet Size")] [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Size")]
public string UIpacketSize; public string UIpacketSize;
   
  /// <summary>
  /// Packet cost string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Packet Cost")] [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Cost")]
public string UIpacketCost; public string UIpacketCost;
   
// The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power /// <summary>
// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail. /// The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power
  /// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail.
  /// </summary>
[KSPField(isPersistant = false)] [KSPField(isPersistant = false)]
public float maxPowerFactor; public float maxPowerFactor;
   
// The multipler on packetSize that defines the maximum data bandwidth of the antenna. /// <summary>
  /// The multipler on packetSize that defines the maximum data bandwidth of the antenna.
  /// </summary>
[KSPField(isPersistant = false)] [KSPField(isPersistant = false)]
public float maxDataFactor; public float maxDataFactor;
   
protected bool actionUIUpdate; /// <summary>
  /// The packet throttle.
  /// </summary>
  [KSPField(
  isPersistant = true,
  guiName = "Packet Throttle",
  guiUnits = "%",
  guiActive = true,
  guiActiveEditor = false
  )]
  [UI_FloatRange(maxValue = 100f, minValue = 2.5f, stepIncrement = 2.5f)]
  public float packetThrottle;
   
  private bool actionUIUpdate;
   
/* /*
* Properties * Properties
* */ * */
// Returns the parent vessel housing this antenna. /// <summary>
  /// Gets the parent Vessel.
  /// </summary>
public new Vessel vessel public new Vessel vessel
{ {
get get
{ {
return base.vessel; if (base.vessel != null)
} {
} return base.vessel;
  }
// Returns the distance to the nearest relay or Kerbin, whichever is closer. else if (this.part != null)
  {
  return this.part.vessel;
  }
   
  else
  {
  return null;
  }
  }
  }
   
  /// <summary>
  /// Gets the target <see cref="AntennaRange.IAntennaRelay"/>relay.
  /// </summary>
  public IAntennaRelay targetRelay
  {
  get
  {
  if (this.relay == null)
  {
  return null;
  }
   
  return this.relay.targetRelay;
  }
  }
   
  /// <summary>
  /// Gets the distance to the nearest relay or Kerbin, whichever is closer.
  /// </summary>
public double transmitDistance public double transmitDistance
{ {
get get
{ {
  if (this.relay == null)
  {
  return double.PositiveInfinity;
  }
   
return this.relay.transmitDistance; return this.relay.transmitDistance;
} }
} }
   
// Returns the maximum distance this module can transmit /// <summary>
public float maxTransmitDistance /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config.
{ /// </summary>
get public double nominalTransmitDistance
{ {
return Mathf.Sqrt (this.maxPowerFactor) * this.nominalRange; get
  {
  return this.nominalRange;
  }
  }
   
  /// <summary>
  /// The maximum distance at which this relay can operate.
  /// </summary>
  public double maxTransmitDistance
  {
  get
  {
  // TODO: Cache this in a way that doesn't break everything.
  return Math.Sqrt(this.maxPowerFactor) * this.nominalRange;
  }
  }
   
  /// <summary>
  /// The first CelestialBody blocking line of sight to a
  /// </summary>
  public CelestialBody firstOccludingBody
  {
  get
  {
  return this.relay.firstOccludingBody;
} }
} }
   
/* /*
* The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except * The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except
* in that they both return floats. Here's some quick justification: * in that they both return floats. Here's some quick justification:
* *
* The stock implementation of GetTransmitterScore (which I cannot override) is: * The stock implementation of GetTransmitterScore (which I cannot override) is:
* Score = (1 + DataResourceCost) / DataRate * Score = (1 + DataResourceCost) / DataRate
* *
* The stock DataRate and DataResourceCost are: * The stock DataRate and DataResourceCost are:
* DataRate = packetSize / packetInterval * DataRate = packetSize / packetInterval
* DataResourceCost = packetResourceCost / packetSize * DataResourceCost = packetResourceCost / packetSize
* *
* So, the resulting score is essentially in terms of joules per byte per baud. Rearranging that a bit, it * 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, * could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte. Either way,
* that metric is not a very reasonable one. * that metric is not a very reasonable one.
* *
* Two metrics that might make more sense are joules per byte or joules per byte per second. The latter case * Two metrics that might make more sense are joules per byte or joules per byte per second. The latter case
* would look like: * would look like:
* DataRate = packetSize / packetInterval * DataRate = packetSize / packetInterval
* DataResourceCost = packetResourceCost * DataResourceCost = packetResourceCost
* *
* The former case, which I've chosen to implement below, is: * The former case, which I've chosen to implement below, is:
* DataRate = packetSize * DataRate = packetSize
* DataResourceCost = packetResourceCost * DataResourceCost = packetResourceCost
* *
* So... hopefully that doesn't screw with anything else. * So... hopefully that doesn't screw with anything else.
* */ * */
// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in /// <summary>
// terms of joules/byte /// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in
  /// terms of joules/byte
  /// </summary>
public new float DataRate public new float DataRate
{ {
get get
{ {
this.PreTransmit_SetPacketSize(); this.PreTransmit_SetPacketSize();
   
if (this.CanTransmit()) if (this.CanTransmit())
{ {
return this.packetSize; return this.packetSize;
} }
else else
{ {
return float.Epsilon; return float.Epsilon;
} }
} }
} }
   
// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas /// <summary>
// to be scored in terms of joules/byte /// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas
public new float DataResourceCost /// to be scored in terms of joules/byte
  /// </summary>
  public new double DataResourceCost
{ {
get get
{ {
this.PreTransmit_SetPacketResourceCost(); this.PreTransmit_SetPacketResourceCost();
   
if (this.CanTransmit()) if (this.CanTransmit())
{ {
return this.packetResourceCost; return this.packetResourceCost;
} }
else else
{ {
return float.PositiveInfinity; return float.PositiveInfinity;
} }
} }
} }
   
// Reports whether this antenna has been checked as a viable relay already in the current FindNearestRelay. /// <summary>
public bool relayChecked /// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating
{ /// directly with Kerbin.
get /// </summary>
{ public bool KerbinDirect
return this.relay.relayChecked; {
  get
  {
  if (this.relay != null)
  {
  return this.relay.KerbinDirect;
  }
   
  return false;
  }
  }
   
  /// <summary>
  /// Gets the Part title.
  /// </summary>
  public string Title
  {
  get
  {
  if (this.part != null && this.part.partInfo != null)
  {
  return this.part.partInfo.title;
  }
   
  return string.Empty;
} }
} }
   
/* /*
* Methods * Methods
* */ * */
// Build ALL the objects. // Build ALL the objects.
public ModuleLimitedDataTransmitter () : base() public ModuleLimitedDataTransmitter () : base()
{ {
this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT); this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT);
} this.packetThrottle = 100f;
  }
// At least once, when the module starts with a state on the launch pad or later, go find Kerbin.  
public override void OnStart (StartState state) /// <summary>
{ /// PartModule OnAwake override; runs at Unity Awake.
base.OnStart (state); /// </summary>
  public override void OnAwake()
if (state >= StartState.PreLaunch) {
{ base.OnAwake();
this.relay = new AntennaRelay(this);  
this.relay.maxTransmitDistance = this.maxTransmitDistance;  
   
this.UImaxTransmitDistance = Tools.MuMech_ToSI(this.maxTransmitDistance) + "m";  
   
GameEvents.onPartActionUICreate.Add(this.onPartActionUICreate);  
GameEvents.onPartActionUIDismiss.Add(this.onPartActionUIDismiss);  
}  
}  
   
// 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  
// work.  
public override void OnLoad(ConfigNode node)  
{  
this.Fields.Load(node);  
base.Fields.Load(node);  
   
base.OnLoad (node);  
   
this._basepacketSize = base.packetSize; this._basepacketSize = base.packetSize;
this._basepacketResourceCost = base.packetResourceCost; this._basepacketResourceCost = base.packetResourceCost;
   
Tools.PostDebugMessage(string.Format( Tools.PostDebugMessage(string.Format(
"{0} loaded:\n" + "{0} loaded:\n" +
"packetSize: {1}\n" + "packetSize: {1}\n" +
"packetResourceCost: {2}\n" + "packetResourceCost: {2}\n" +
"nominalRange: {3}\n" + "nominalRange: {3}\n" +
"maxPowerFactor: {4}\n" + "maxPowerFactor: {4}\n" +
"maxDataFactor: {5}\n", "maxDataFactor: {5}\n",
this.name, this.name,
base.packetSize, base.packetSize,
this._basepacketResourceCost, this._basepacketResourceCost,
this.nominalRange, this.nominalRange,
this.maxPowerFactor, this.maxPowerFactor,
this.maxDataFactor this.maxDataFactor
)); ));
} }
   
  /// <summary>
  /// PartModule OnStart override; runs at Unity Start.
  /// </summary>
  /// <param name="state">State.</param>
  public override void OnStart (StartState state)
  {
  base.OnStart (state);
   
  if (state >= StartState.PreLaunch)
  {
  this.relay = new AntennaRelay(this);
  this.relay.maxTransmitDistance = this.maxTransmitDistance;
  this.relay.nominalTransmitDistance = this.nominalRange;
   
  this.UImaxTransmitDistance = Tools.MuMech_ToSI(this.maxTransmitDistance) + "m";
   
  GameEvents.onPartActionUICreate.Add(this.onPartActionUICreate);
  GameEvents.onPartActionUIDismiss.Add(this.onPartActionUIDismiss);
  }
  }
   
  /// <summary>
  /// 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
  /// work.
  /// </summary>
  /// <param name="node"><see cref="ConfigNode"/> with data for this module.</param>
  public override void OnLoad(ConfigNode node)
  {
  this.Fields.Load(node);
  base.Fields.Load(node);
   
  base.OnLoad (node);
  }
   
  /// <summary>
  /// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description.
  /// </summary>
  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;
  }
   
  /// <summary>
  /// Determines whether this instance can transmit.
  /// <c>true</c> if this instance can transmit; otherwise, <c>false</c>.
  /// </summary>
  public new bool CanTransmit()
  {
  if (this.part == null || this.relay == null)
  {
  return false;
  }
   
  switch (this.part.State)
  {
  case PartStates.DEAD:
  case PartStates.DEACTIVATED:
  Tools.PostDebugMessage(string.Format(
  "{0}: {1} on {2} cannot transmit: {3}",
  this.GetType().Name,
  this.part.partInfo.title,
  this.vessel.vesselName,
  Enum.GetName(typeof(PartStates), this.part.State)
  ));
  return false;
  default:
  break;
  }
   
  return this.relay.CanTransmit();
  }
   
  /// <summary>
  /// Finds the nearest relay.
  /// </summary>
  public void FindNearestRelay()
  {
  if (this.relay != null)
  {
  this.relay.FindNearestRelay();
  }
  }
   
  /// <summary>
  /// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit
  /// returns false.
  /// </summary>
  /// <param name="dataQueue">List of <see cref="ScienceData"/> to transmit.</param>
  /// <param name="callback">Callback function</param>
  public new void TransmitData(List<ScienceData> dataQueue, Callback callback)
  {
  this.LogDebug(
  "TransmitData(List<ScienceData> dataQueue, Callback callback) called. dataQueue.Count={0}",
  dataQueue.Count
  );
   
  this.FindNearestRelay();
   
  this.PreTransmit_SetPacketSize();
  this.PreTransmit_SetPacketResourceCost();
   
  if (this.CanTransmit())
  {
  ScreenMessages.PostScreenMessage(this.buildTransmitMessage(), 4f, ScreenMessageStyle.UPPER_LEFT);
   
  this.LogDebug(
  "CanTransmit in TransmitData, calling base.TransmitData with dataQueue=[{0}] and callback={1}",
  dataQueue.SPrint(),
  callback == null ? "null" : callback.ToString()
  );
   
  if (callback == null)
  {
  base.TransmitData(dataQueue);
  }
  else
  {
  base.TransmitData(dataQueue, callback);
  }
  }
  else
  {
  Tools.PostDebugMessage(this, "{0} unable to transmit during TransmitData.", this.part.partInfo.title);
   
  var logger = Tools.DebugLogger.New(this);
   
  IList<ModuleScienceContainer> vesselContainers = this.vessel.getModulesOfType<ModuleScienceContainer>();
  ModuleScienceContainer scienceContainer;
  for (int cIdx = 0; cIdx < vesselContainers.Count; cIdx++)
  {
  scienceContainer = vesselContainers[cIdx];
   
  logger.AppendFormat("Checking ModuleScienceContainer in {0}\n",
  scienceContainer.part.partInfo.title);
   
  if (
  scienceContainer.capacity != 0 &&
  scienceContainer.GetScienceCount() >= scienceContainer.capacity
  )
  {
  logger.Append("\tInsufficient capacity, skipping.\n");
  continue;
  }
   
  List<ScienceData> dataStored = new List<ScienceData>();
   
  ScienceData data;
  for (int dIdx = 0; dIdx < dataQueue.Count; dIdx++)
  {
  data = dataQueue[dIdx];
  if (!scienceContainer.allowRepeatedSubjects && scienceContainer.HasData(data))
  {
  logger.Append("\tAlready contains subject and repeated subjects not allowed, skipping.\n");
  continue;
  }
   
  logger.AppendFormat("\tAcceptable, adding data on subject {0}... ", data.subjectID);
  if (scienceContainer.AddData(data))
  {
  logger.Append("done, removing from queue.\n");
   
  dataStored.Add(data);
  }
  #if DEBUG
  else
  {
  logger.Append("failed.\n");
  }
  #endif
  }
   
  dataQueue.RemoveAll(i => dataStored.Contains(i));
   
  logger.AppendFormat("\t{0} data left in queue.", dataQueue.Count);
  }
   
  logger.Print();
   
  if (dataQueue.Count > 0)
  {
  StringBuilder sb = Tools.GetStringBuilder();
   
  sb.Append('[');
  sb.Append(this.part.partInfo.title);
  sb.AppendFormat("]: {0} data items could not be saved: no space available in data containers.\n");
  sb.Append("Data to be discarded:\n");
   
  ScienceData data;
  for (int dIdx = 0; dIdx < dataQueue.Count; dIdx++)
  {
  data = dataQueue[dIdx];
  sb.AppendFormat("\t{0}\n", data.title);
  }
   
  ScreenMessages.PostScreenMessage(sb.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);
   
  Tools.PostDebugMessage(sb.ToString());
   
  Tools.PutStringBuilder(sb);
  }
   
  this.PostCannotTransmitError();
  }
   
  Tools.PostDebugMessage (
  "distance: " + this.transmitDistance
  + " packetSize: " + this.packetSize
  + " packetResourceCost: " + this.packetResourceCost
  );
  }
   
  /// <summary>
  /// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit
  /// returns false.
  /// </summary>
  /// <param name="dataQueue">List of <see cref="ScienceData"/> to transmit.</param>
  public new void TransmitData(List<ScienceData> dataQueue)
  {
  this.LogDebug(
  "TransmitData(List<ScienceData> dataQueue) called, dataQueue.Count={0}",
  dataQueue.Count
  );
   
  this.TransmitData(dataQueue, null);
  }
   
  /// <summary>
  /// Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit
  /// returns false.
  /// </summary>
  public new void StartTransmission()
  {
  this.FindNearestRelay();
   
  PreTransmit_SetPacketSize ();
  PreTransmit_SetPacketResourceCost ();
   
  Tools.PostDebugMessage (
  "distance: " + this.transmitDistance
  + " packetSize: " + this.packetSize
  + " packetResourceCost: " + this.packetResourceCost
  );
   
  if (this.CanTransmit())
  {
  ScreenMessages.PostScreenMessage(this.buildTransmitMessage(), 4f, ScreenMessageStyle.UPPER_LEFT);
   
  base.StartTransmission();
  }
  else
  {
  this.PostCannotTransmitError ();
  }
  }
   
  /// <summary>
  /// MonoBehaviour Update
  /// </summary>
  public void Update()
  {
  if (this.actionUIUpdate)
  {
  if (this.CanTransmit())
  {
  this.UIrelayStatus = "Connected";
  this.UItransmitDistance = Tools.MuMech_ToSI(this.transmitDistance) + "m";
  this.UIpacketSize = Tools.MuMech_ToSI(this.DataRate) + "MiT";
  this.UIpacketCost = Tools.MuMech_ToSI(this.DataResourceCost) + "E";
  }
  else
  {
  if (this.relay.firstOccludingBody == null)
  {
  this.UIrelayStatus = "Out of range";
  }
  else
  {
  this.UIrelayStatus = string.Format("Blocked by {0}", this.relay.firstOccludingBody.bodyName);
  }
  this.UImaxTransmitDistance = "N/A";
  this.UIpacketSize = "N/A";
  this.UIpacketCost = "N/A";
  }
   
  if (this.KerbinDirect)
  {
  this.UIrelayTarget = AntennaRelay.Kerbin.bodyName;
  }
  else
  {
  this.UIrelayTarget = this.targetRelay.ToString();
  }
  }
  }
   
  /// <summary>
  /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.ModuleLimitedDataTransmitter"/>.
  /// </summary>
  /// <returns>A <see cref="System.String"/> that represents the current <see cref="AntennaRange.ModuleLimitedDataTransmitter"/>.</returns>
  public override string ToString()
  {
  StringBuilder sb = Tools.GetStringBuilder();
  string msg;
   
  sb.Append(this.part.partInfo.title);
   
  if (vessel != null)
  {
  sb.Append(" on ");
  sb.Append(vessel.vesselName);
  }
  else if (
  this.part != null &&
  this.part.protoPartSnapshot != null &&
  this.part.protoPartSnapshot != null &&
  this.part.protoPartSnapshot.pVesselRef != null
  )
  {
  sb.Append(" on ");
  sb.Append(this.part.protoPartSnapshot.pVesselRef.vesselName);
  }
   
  msg = sb.ToString();
   
  Tools.PutStringBuilder(sb);
   
  return msg;
  }
   
  // When we catch an onPartActionUICreate event for our part, go ahead and update every frame to look pretty.
  private void onPartActionUICreate(Part eventPart)
  {
  if (eventPart == base.part)
  {
  this.actionUIUpdate = true;
  }
  }
   
  // When we catch an onPartActionUIDismiss event for our part, stop updating every frame to look pretty.
  private void onPartActionUIDismiss(Part eventPart)
  {
  if (eventPart == base.part)
  {
  this.actionUIUpdate = false;
  }
  }
   
// Post an error in the communication messages describing the reason transmission has failed. Currently there // Post an error in the communication messages describing the reason transmission has failed. Currently there
// is only one reason for this. // is only one reason for this.
protected void PostCannotTransmitError() private void PostCannotTransmitError()
{ {
string ErrorText = string.Intern("Unable to transmit: no visible receivers in range!"); string ErrorText = string.Intern("Unable to transmit: no visible receivers in range!");
   
this.ErrorMsg.message = string.Format( this.ErrorMsg.message = string.Format(
"<color='#{0}{1}{2}{3}'><b>{4}</b></color>", "<color='#{0}{1}{2}{3}'><b>{4}</b></color>",
((int)(XKCDColors.OrangeRed.r * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.r * 255f)).ToString("x2"),
((int)(XKCDColors.OrangeRed.g * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.g * 255f)).ToString("x2"),
((int)(XKCDColors.OrangeRed.b * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.b * 255f)).ToString("x2"),
((int)(XKCDColors.OrangeRed.a * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.a * 255f)).ToString("x2"),
ErrorText ErrorText
); );
   
Tools.PostDebugMessage(this.GetType().Name + ": " + this.ErrorMsg.message); Tools.PostDebugMessage(this.GetType().Name + ": " + this.ErrorMsg.message);
   
ScreenMessages.PostScreenMessage(this.ErrorMsg, false); ScreenMessages.PostScreenMessage(this.ErrorMsg, false);
} }
   
// Before transmission, set packetResourceCost. Per above, packet cost increases with the square of // Before transmission, set packetResourceCost. Per above, packet cost increases with the square of
// distance. packetResourceCost maxes out at _basepacketResourceCost * maxPowerFactor, at which point // distance. packetResourceCost maxes out at _basepacketResourceCost * maxPowerFactor, at which point
// transmission fails (see CanTransmit). // transmission fails (see CanTransmit).
protected void PreTransmit_SetPacketResourceCost() private void PreTransmit_SetPacketResourceCost()
{ {
if (this.transmitDistance <= this.nominalRange) if (ARConfiguration.FixedPowerCost || this.transmitDistance <= this.nominalRange)
{ {
base.packetResourceCost = this._basepacketResourceCost; base.packetResourceCost = this._basepacketResourceCost;
} }
else else
{ {
  float rangeFactor = (float)(this.transmitDistance / this.nominalRange);
  rangeFactor *= rangeFactor;
   
base.packetResourceCost = this._basepacketResourceCost base.packetResourceCost = this._basepacketResourceCost
* (float)Math.Pow (this.transmitDistance / this.nominalRange, 2); * rangeFactor;
} }
   
  base.packetResourceCost *= this.packetThrottle / 100f;
} }
   
// Before transmission, set packetSize. Per above, packet size increases with the inverse square of // Before transmission, set packetSize. Per above, packet size increases with the inverse square of
// distance. packetSize maxes out at _basepacketSize * maxDataFactor. // distance. packetSize maxes out at _basepacketSize * maxDataFactor.
protected void PreTransmit_SetPacketSize() private void PreTransmit_SetPacketSize()
{ {
if (this.transmitDistance >= this.nominalRange) if (!ARConfiguration.FixedPowerCost && this.transmitDistance >= this.nominalRange)
{ {
base.packetSize = this._basepacketSize; base.packetSize = this._basepacketSize;
} }
else else
{ {
base.packetSize = Math.Min( float rangeFactor = (float)(this.nominalRange / this.transmitDistance);
this._basepacketSize * (float)Math.Pow (this.nominalRange / this.transmitDistance, 2), rangeFactor *= rangeFactor;
   
  base.packetSize = Mathf.Min(
  this._basepacketSize * rangeFactor,
this._basepacketSize * this.maxDataFactor); this._basepacketSize * this.maxDataFactor);
} }
}  
  base.packetSize *= this.packetThrottle / 100f;
// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description. }
public override string GetInfo()  
{ private string buildTransmitMessage()
string text = base.GetInfo(); {
text += "Nominal Range: " + Tools.MuMech_ToSI((double)this.nominalRange, 2) + "m\n"; StringBuilder sb = Tools.GetStringBuilder();
text += "Maximum Range: " + Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2) + "m\n"; string msg;
return text;  
} sb.Append("[");
  sb.Append(base.part.partInfo.title);
// Override ModuleDataTransmitter.CanTransmit to return false when transmission is not possible. sb.Append("]: ");
public new bool CanTransmit()  
{ sb.Append("Beginning transmission ");
PartStates partState = this.part.State;  
if (partState == PartStates.DEAD || partState == PartStates.DEACTIVATED) if (this.KerbinDirect)
{ {
Tools.PostDebugMessage(string.Format( sb.Append("directly to Kerbin.");
"{0}: {1} on {2} cannot transmit: {3}",  
this.GetType().Name,  
this.part.partInfo.title,  
this.vessel.vesselName,  
Enum.GetName(typeof(PartStates), partState)  
));  
return false;  
}  
return this.relay.CanTransmit();  
}  
   
// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit  
// returns false.  
public new void TransmitData(List<ScienceData> dataQueue)  
{  
this.PreTransmit_SetPacketSize();  
this.PreTransmit_SetPacketResourceCost();  
   
if (this.CanTransmit())  
{  
StringBuilder message = new StringBuilder();  
   
message.Append("[");  
message.Append(base.part.partInfo.title);  
message.Append("]: ");  
   
message.Append("Beginning transmission ");  
   
if (this.relay.nearestRelay == null)  
{  
message.Append("directly to Kerbin.");  
}  
else  
{  
message.Append("via ");  
message.Append(this.relay.nearestRelay);  
}  
   
ScreenMessages.PostScreenMessage(message.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);  
   
base.TransmitData(dataQueue);  
} }
else else
{ {
this.PostCannotTransmitError (); sb.Append("via ");
} sb.Append(this.relay.targetRelay);
  }
Tools.PostDebugMessage (  
"distance: " + this.transmitDistance msg = sb.ToString();
+ " packetSize: " + this.packetSize  
+ " packetResourceCost: " + this.packetResourceCost Tools.PutStringBuilder(sb);
);  
} return msg;
  }
// Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit  
// returns false. #if DEBUG
public new void StartTransmission() // When debugging, it's nice to have a button that just tells you everything.
  [KSPEvent (guiName = "Show Debug Info", active = true, guiActive = true)]
  public void DebugInfo()
{ {
PreTransmit_SetPacketSize (); PreTransmit_SetPacketSize ();
PreTransmit_SetPacketResourceCost (); PreTransmit_SetPacketResourceCost ();
   
Tools.PostDebugMessage ( DebugPartModule.DumpClassObject(this);
"distance: " + this.transmitDistance  
+ " packetSize: " + this.packetSize  
+ " packetResourceCost: " + this.packetResourceCost  
);  
   
if (this.CanTransmit())  
{  
StringBuilder message = new StringBuilder();  
   
message.Append("[");  
message.Append(base.part.partInfo.title);  
message.Append("]: ");  
   
message.Append("Beginning transmission ");  
   
if (this.relay.nearestRelay == null)  
{  
message.Append("directly to Kerbin.");  
}  
else  
{  
message.Append("via ");  
message.Append(this.relay.nearestRelay);  
}  
   
ScreenMessages.PostScreenMessage(message.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);  
   
base.StartTransmission();  
}  
else  
{  
this.PostCannotTransmitError ();  
}  
}  
   
public void Update()  
{  
if (this.actionUIUpdate)  
{  
this.UItransmitDistance = Tools.MuMech_ToSI(this.transmitDistance) + "m";  
this.UIpacketSize = this.CanTransmit() ? Tools.MuMech_ToSI(this.DataRate) + "MiT" : "N/A";  
this.UIpacketCost = this.CanTransmit() ? Tools.MuMech_ToSI(this.DataResourceCost) + "E" : "N/A";  
}  
}  
   
public void onPartActionUICreate(Part eventPart)  
{  
if (eventPart == base.part)  
{  
this.actionUIUpdate = true;  
}  
}  
   
public void onPartActionUIDismiss(Part eventPart)  
{  
if (eventPart == base.part)  
{  
this.actionUIUpdate = false;  
}  
}  
   
public override string ToString()  
{  
StringBuilder msg = new StringBuilder();  
   
msg.Append(this.part.partInfo.title);  
   
if (vessel != null)  
{  
msg.Append(" on ");  
msg.Append(vessel.vesselName);  
}  
   
return msg.ToString();  
}  
   
// 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}\n" +  
"NearestRelay: {12}\n" +  
"Vessel ID: {13}",  
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),  
this.relay.FindNearestRelay(),  
this.vessel.id  
);  
Tools.PostDebugMessage(msg);  
} }
   
[KSPEvent (guiName = "Dump Vessels", active = true, guiActive = true)] [KSPEvent (guiName = "Dump Vessels", active = true, guiActive = true)]
public void PrintAllVessels() public void PrintAllVessels()
{ {
StringBuilder sb = new StringBuilder(); StringBuilder sb = Tools.GetStringBuilder();
   
sb.Append("Dumping FlightGlobals.Vessels:"); sb.Append("Dumping FlightGlobals.Vessels:");
   
foreach (Vessel vessel in FlightGlobals.Vessels) Vessel vessel;
{ for (int i = 0; i < FlightGlobals.Vessels.Count; i++)
  {
  vessel = FlightGlobals.Vessels[i];
sb.AppendFormat("\n'{0} ({1})'", vessel.vesselName, vessel.id); sb.AppendFormat("\n'{0} ({1})'", vessel.vesselName, vessel.id);
} }
   
Tools.PostDebugMessage(sb.ToString()); Tools.PostDebugMessage(sb.ToString());
}  
  Tools.PutStringBuilder(sb);
  }
   
[KSPEvent (guiName = "Dump RelayDB", active = true, guiActive = true)] [KSPEvent (guiName = "Dump RelayDB", active = true, guiActive = true)]
public void DumpRelayDB() public void DumpRelayDB()
{ {
RelayDatabase.Instance.Dump(); RelayDatabase.Instance.Dump();
} }
#endif #endif
} }
} }