1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | // 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 { /// <summary> /// Gets the parent Vessel. /// </summary> /// <value>The parent Vessel.</value> Vessel vessel { get; } /// <summary> /// Gets the distance to the nearest relay or Kerbin, whichever is closer. /// </summary> /// <value>The distance to the nearest relay or Kerbin, whichever is closer.</value> double transmitDistance { get; } /// <summary> /// The maximum distance at which this relay can operate. /// </summary> /// <value>The max transmit distance.</value> float maxTransmitDistance { get; } /// <summary> /// Gets a value indicating whether this <see cref="AntennaRange.ProtoDataTransmitter"/> has been checked during /// the current relay attempt. /// </summary> /// <value><c>true</c> if relay checked; otherwise, <c>false</c>.</value> bool relayChecked { get; } /// <summary> /// Determines whether this instance can transmit. /// </summary> /// <returns><c>true</c> if this instance can transmit; otherwise, <c>false</c>.</returns> bool CanTransmit(); } } |