Network resolution by total connection cost is working now.
[AntennaRange.git] / IAntennaRelay.cs
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// AntennaRange
//
// IAntennaRelay.cs
//
// Copyright © 2014-2015, 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
{
        /// <summary>
        /// Interface defining the basic functionality of AntennaRelay modules for AntennaRange.
        /// </summary>
        public interface IAntennaRelay
        {
                /// <summary>
                /// Gets the parent Vessel.
                /// </summary>
                Vessel vessel { get; }
 
                /// <summary>
                /// Gets the target <see cref="AntennaRange.IAntennaRelay"/>relay.
                /// </summary>
                IAntennaRelay targetRelay { get; }
 
                /// <summary>
                /// Gets or sets the data capacity of a packet, in MiT/packet
                /// </summary>
                /// <value>The data capacity of a packet, in MiT/packet</value>
                float PacketSize { get; set; }
 
                /// <summary>
                /// Gets the base data capacity of a packet, in MiT/packet
                /// </summary>
                /// <value>The base data capacity of a packet, in MiT/packet</value>
                float BasePacketSize { get; }
 
                /// <summary>
                /// Gets or sets the resource cost of a packet, in EC/packet
                /// </summary>
                /// <value>The resource cost of a packet, in EC/packet</value>
                float PacketResourceCost { get; set; }
 
                /// <summary>
                /// Gets the base resource cost of a packet, in EC/packet
                /// </summary>
                /// <value>The base resource cost of a packet, in EC/packet</value>
                float BasePacketResourceCost { get; }
 
                /// <summary>
                /// Gets the packet throttle.
                /// </summary>
                /// <value>The packet throttle in range [0..100].</value>
                float PacketThrottle { get; }
 
                /// <summary>
                /// Gets the max data factor.
                /// </summary>
                /// <value>The max data factor.</value>
                float MaxDataFactor { get; }
 
                /// <summary>
                /// Gets the data resource cost in EC/MiT.
                /// </summary>
                /// <value>The data resource cost in EC/MiT.</value>
                double DataResourceCost { get; }
 
                /// <summary>
                /// Gets the current network resource rate in EC/MiT.
                /// </summary>
                /// <value>The current network resource rate in EC/MiT.</value>
                RelayDataCost CurrentNetworkLinkCost { get; }
 
                /// <summary>
                /// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating
                /// directly with Kerbin.
                /// </summary>
                bool KerbinDirect { get; }
 
                /// <summary>
                /// The link distance, in meters, at which this relay behaves nominally.
                /// </summary>
                double NominalLinkSqrDistance { get; }
 
                /// <summary>
                /// The link distance, in meters, beyond which this relay cannot operate.
                /// </summary>
                double MaximumLinkSqrDistance { get; }
 
                /// <summary>
                /// Gets the distance to the nearest relay or Kerbin, whichever is closer.
                /// </summary>
                double CurrentLinkSqrDistance { get; }
 
                /// <summary>
                /// Gets the link status.
                /// </summary>
                ConnectionStatus LinkStatus { get; }
 
                /// <summary>
                /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config.
                /// </summary>
                double nominalTransmitDistance { get; }
 
                /// <summary>
                /// The maximum distance at which this relay can operate.
                /// </summary>
                double maxTransmitDistance { get; }
 
                /// <summary>
                /// The first CelestialBody blocking line of sight to a 
                /// </summary>
                CelestialBody firstOccludingBody { get; }
 
                /// <summary>
                /// Gets the Part title.
                /// </summary>
                string Title { get; }
 
                /// <summary>
                /// Determines whether this instance can transmit.
                /// <c>true</c> if this instance can transmit; otherwise, <c>false</c>.
                /// </summary>
                bool CanTransmit();
 
                /// <summary>
                /// Recalculates the transmission rates.
                /// </summary>
                void RecalculateTransmissionRates();
 
                /// <summary>
                /// Finds the nearest relay.
                /// </summary>
                void FindNearestRelay();
 
                /// <summary>
                /// Recalculates the max range; useful for making sure we're using additive ranges when enabled.
                /// </summary>
                void RecalculateMaxRange();
 
                /// <summary>
                /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.IAntennaRelay"/>.
                /// </summary>
                string ToString();
        }
}