Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
DiscoveryInfo Class Reference
Inheritance diagram for DiscoveryInfo:
IConfigNode

Public Member Functions

 DiscoveryInfo (IDiscoverable host)
 
 DiscoveryInfo (IDiscoverable host, double untrackedLifetime)
 
 DiscoveryInfo (IDiscoverable host, DiscoveryLevels level, double untrackedLifetime)
 
double GetSignalLife (double UT)
 Returns a 1-0 value representing how close the object is to being lost More...
 
double GetSignalStrength (double UT)
 Returns a 1-0 value representing how long this object will stick around, compared to others spawned in similar circumstances. More...
 
bool HaveKnowledgeAbout (DiscoveryLevels lvl)
 
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 
void SetLastObservedTime (double UT)
 
void SetLevel (DiscoveryLevels level)
 
void SetReferenceLifetime (double time)
 
void SetUnobservedLifetime (double time)
 
void SetUntrackedObjectSize (UntrackedObjectClass size)
 

Static Public Member Functions

static UntrackedObjectClass GetClassFromSize (float size, int seed)
 
static float GetClassRadius (UntrackedObjectClass sizeClass, int seed)
 Returns the average radius of the asteroid given its class. More...
 
static float GetMaxRadius (UntrackedObjectClass sizeClass, int seed)
 Returns the maximum radius for the given asteroid class More...
 
static float GetMinRadius (UntrackedObjectClass sizeClass, int seed)
 Returns the minimum radius for the given asteroid class More...
 
static UntrackedObjectClass GetObjectClass (string classString)
 Returns the object class given its volume. More...
 
static string GetSignalStrengthCaption (double signal)
 
static string GetSizeClassDescription (UntrackedObjectClass sizeClass)
 
static string GetSizeClassSizes (UntrackedObjectClass sizeClass)
 

Public Attributes

KnowledgeItem< string > displayName
 
KnowledgeItem< double > distance
 
KnowledgeItem< float > mass
 
KnowledgeItem< string > name
 
KnowledgeItem< string > signalStrengthLevel
 
KnowledgeItem< double > signalStrengthPercent
 
KnowledgeItem< string > situation
 
KnowledgeItem
< UntrackedObjectClass
size
 
KnowledgeItem< double > speed
 
KnowledgeItem< string > trackingStatus
 
KnowledgeItem< string > type
 

Properties

double fadeUT [get, set]
 Time at which the object will disappear unless observed again. More...
 
double lastObservedTime [get, set]
 When was the object last observed. More...
 
DiscoveryLevels Level [get, set]
 The level of knowledge available about this object More...
 
UntrackedObjectClass objectSize [get, set]
 The tracking signature size of the object More...
 
double referenceLifetime [get, set]
 The maximum lifetime for any untracked discoverable. Used to gauge signal strength. More...
 
double unobservedLifetime [get, set]
 The time the object can remain unobserved and still be detected again (infinite unless specified) More...
 

Constructor & Destructor Documentation

DiscoveryInfo.DiscoveryInfo ( IDiscoverable  host)
inline
DiscoveryInfo.DiscoveryInfo ( IDiscoverable  host,
double  untrackedLifetime 
)
inline
DiscoveryInfo.DiscoveryInfo ( IDiscoverable  host,
DiscoveryLevels  level,
double  untrackedLifetime 
)
inline

Member Function Documentation

static UntrackedObjectClass DiscoveryInfo.GetClassFromSize ( float  size,
int  seed 
)
inlinestatic
static float DiscoveryInfo.GetClassRadius ( UntrackedObjectClass  sizeClass,
int  seed 
)
inlinestatic

Returns the average radius of the asteroid given its class.

static float DiscoveryInfo.GetMaxRadius ( UntrackedObjectClass  sizeClass,
int  seed 
)
inlinestatic

Returns the maximum radius for the given asteroid class

static float DiscoveryInfo.GetMinRadius ( UntrackedObjectClass  sizeClass,
int  seed 
)
inlinestatic

Returns the minimum radius for the given asteroid class

static UntrackedObjectClass DiscoveryInfo.GetObjectClass ( string  classString)
inlinestatic

Returns the object class given its volume.

double DiscoveryInfo.GetSignalLife ( double  UT)
inline

Returns a 1-0 value representing how close the object is to being lost

Parameters
UT
Returns
double DiscoveryInfo.GetSignalStrength ( double  UT)
inline

Returns a 1-0 value representing how long this object will stick around, compared to others spawned in similar circumstances.

Parameters
UT
Returns
static string DiscoveryInfo.GetSignalStrengthCaption ( double  signal)
inlinestatic
static string DiscoveryInfo.GetSizeClassDescription ( UntrackedObjectClass  sizeClass)
inlinestatic
static string DiscoveryInfo.GetSizeClassSizes ( UntrackedObjectClass  sizeClass)
inlinestatic
bool DiscoveryInfo.HaveKnowledgeAbout ( DiscoveryLevels  lvl)
inline
void DiscoveryInfo.Load ( ConfigNode  node)
inline

Implements IConfigNode.

void DiscoveryInfo.Save ( ConfigNode  node)
inline

Implements IConfigNode.

void DiscoveryInfo.SetLastObservedTime ( double  UT)
inline
void DiscoveryInfo.SetLevel ( DiscoveryLevels  level)
inline
void DiscoveryInfo.SetReferenceLifetime ( double  time)
inline
void DiscoveryInfo.SetUnobservedLifetime ( double  time)
inline
void DiscoveryInfo.SetUntrackedObjectSize ( UntrackedObjectClass  size)
inline

Member Data Documentation

KnowledgeItem<string> DiscoveryInfo.displayName
KnowledgeItem<double> DiscoveryInfo.distance
KnowledgeItem<float> DiscoveryInfo.mass
KnowledgeItem<string> DiscoveryInfo.name
KnowledgeItem<string> DiscoveryInfo.signalStrengthLevel
KnowledgeItem<double> DiscoveryInfo.signalStrengthPercent
KnowledgeItem<string> DiscoveryInfo.situation
KnowledgeItem<UntrackedObjectClass> DiscoveryInfo.size
KnowledgeItem<double> DiscoveryInfo.speed
KnowledgeItem<string> DiscoveryInfo.trackingStatus
KnowledgeItem<string> DiscoveryInfo.type

Property Documentation

double DiscoveryInfo.fadeUT
getset

Time at which the object will disappear unless observed again.

double DiscoveryInfo.lastObservedTime
getset

When was the object last observed.

DiscoveryLevels DiscoveryInfo.Level
getset

The level of knowledge available about this object

UntrackedObjectClass DiscoveryInfo.objectSize
getset

The tracking signature size of the object

double DiscoveryInfo.referenceLifetime
getset

The maximum lifetime for any untracked discoverable. Used to gauge signal strength.

double DiscoveryInfo.unobservedLifetime
getset

The time the object can remain unobserved and still be detected again (infinite unless specified)


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