// AntennaRange // // IAntennaRelay.cs // // Copyright © 2014, toadicus // All rights reserved. // // Redistribution and use in source and binary forms, with or without modification, // are permitted provided that the following conditions are met: // // 1. Redistributions of source code must retain the above copyright notice, // this list of conditions and the following disclaimer. // // 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 // materials provided with the distribution. // // 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. // // 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 // 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 // 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 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. using KSP; using System; namespace AntennaRange { /// /// Interface defining the basic functionality of AntennaRelay modules for AntennaRange. /// public interface IAntennaRelay { /// /// Gets the parent Vessel. /// Vessel vessel { get; } /// /// Gets the target relay. /// IAntennaRelay targetRelay { get; } /// /// Gets the distance to the nearest relay or Kerbin, whichever is closer. /// double transmitDistance { get; } /// /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config. /// double nominalTransmitDistance { get; } /// /// The maximum distance at which this relay can operate. /// double maxTransmitDistance { get; } /// /// The first CelestialBody blocking line of sight to a /// CelestialBody firstOccludingBody { get; } /// /// Gets a value indicating whether this Relay is communicating /// directly with Kerbin. /// bool KerbinDirect { get; } /// /// Gets the Part title. /// string Title { get; } /// /// Determines whether this instance can transmit. /// true if this instance can transmit; otherwise, false. /// bool CanTransmit(); /// /// Finds the nearest relay. /// void FindNearestRelay(); /// /// Returns a that represents the current . /// string ToString(); } }