Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | List of all members
RnDCommsStream Class Reference

Comms Streams are buffers that hold data from transmitter modules for a while, in order to get the full science value of submitting all the experiment data in one go. If the stream times out, however much data was stored gets submitted to R&D, which devaluates the subject more quickly than sending all the data at once. The xmitIncomplete flag can help avoid this by harmlessly terminating the stream if it times out prematurely. More...

Public Member Functions

 RnDCommsStream (ScienceSubject subject, float fileSize, float timeout, float xmitValue, bool xmitIncomplete, ResearchAndDevelopment RDInstance)
 
 RnDCommsStream (ScienceSubject subject, float fileSize, float timeout, float xmitValue, float scienceValueRatio, bool xmitIncomplete, ResearchAndDevelopment RDInstance)
 
void StreamData (float dataAmount, ProtoVessel source)
 

Public Attributes

float fileSize
 
float scienceValueRatio
 
ScienceSubject subject
 
float timeout
 
bool xmitIncomplete
 
float xmitValue
 

Detailed Description

Comms Streams are buffers that hold data from transmitter modules for a while, in order to get the full science value of submitting all the experiment data in one go. If the stream times out, however much data was stored gets submitted to R&D, which devaluates the subject more quickly than sending all the data at once. The xmitIncomplete flag can help avoid this by harmlessly terminating the stream if it times out prematurely.

Constructor & Destructor Documentation

RnDCommsStream.RnDCommsStream ( ScienceSubject  subject,
float  fileSize,
float  timeout,
float  xmitValue,
bool  xmitIncomplete,
ResearchAndDevelopment  RDInstance 
)
inline
RnDCommsStream.RnDCommsStream ( ScienceSubject  subject,
float  fileSize,
float  timeout,
float  xmitValue,
float  scienceValueRatio,
bool  xmitIncomplete,
ResearchAndDevelopment  RDInstance 
)
inline

< start timedOut as true so it kicks off the coroutine on the first data in

Member Function Documentation

void RnDCommsStream.StreamData ( float  dataAmount,
ProtoVessel  source 
)
inline

Member Data Documentation

float RnDCommsStream.fileSize
float RnDCommsStream.scienceValueRatio
ScienceSubject RnDCommsStream.subject
float RnDCommsStream.timeout
bool RnDCommsStream.xmitIncomplete
float RnDCommsStream.xmitValue

The documentation for this class was generated from the following file: