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

A node on the comm network. Used for everything, vessels, ground stations, etc. More...

Inheritance diagram for CommNet.CommNode:

Classes

class  AntennaInfo
 Holds information about the node's transceiver capabilities More...
 

Public Member Functions

 CommNode ()
 
 CommNode (Transform transform)
 
virtual double GetSignalStrengthMultiplier (CommNode b)
 Called when establishing a link between this and another CommNode. Allows each CommNode to apply a situational modifier to the link strength. More...
 
override void NetworkPostUpdate ()
 Passes on the call More...
 
override void NetworkPreUpdate ()
 Updates regular position, if a precise position is available it should be set in OnNetworkPreUpdate More...
 
override string ToString ()
 

Public Attributes

AntennaInfo antennaTransmit = new AntennaInfo()
 
double distanceOffset = 0d
 The distance offset, if any, to distance calculations More...
 
bool isControlSource = false
 
bool isControlSourceMultiHop = true
 
bool isHome
 
Func< CommNode, double > OnLinkCreateSignalModifier
 
Action OnNetworkPostUpdate
 
Action OnNetworkPreUpdate
 
DoubleCurve scienceCurve
 

Protected Attributes

string _displayname = ""
 
string _name = ""
 
Vector3d _position
 

Properties

override string displayName [get, set]
 
override string name [get, set]
 
override Vector3d position [get]
 The transform position, always up-to-date More...
 
virtual Vector3d precisePosition [get, set]
 the Vector3d position, updated only when the network updates More...
 
Transform transform [get, set]
 

Detailed Description

A node on the comm network. Used for everything, vessels, ground stations, etc.

Constructor & Destructor Documentation

CommNet.CommNode.CommNode ( )
inline
CommNet.CommNode.CommNode ( Transform  transform)
inline

Member Function Documentation

virtual double CommNet.CommNode.GetSignalStrengthMultiplier ( CommNode  b)
inlinevirtual

Called when establishing a link between this and another CommNode. Allows each CommNode to apply a situational modifier to the link strength.

Parameters
b
Returns
override void CommNet.CommNode.NetworkPostUpdate ( )
inline

Passes on the call

override void CommNet.CommNode.NetworkPreUpdate ( )
inline

Updates regular position, if a precise position is available it should be set in OnNetworkPreUpdate

override string CommNet.CommNode.ToString ( )
inline

Member Data Documentation

string CommNet.CommNode._displayname = ""
protected
string CommNet.CommNode._name = ""
protected
Vector3d CommNet.CommNode._position
protected
AntennaInfo CommNet.CommNode.antennaTransmit = new AntennaInfo()
double CommNet.CommNode.distanceOffset = 0d

The distance offset, if any, to distance calculations

bool CommNet.CommNode.isControlSource = false
bool CommNet.CommNode.isControlSourceMultiHop = true
bool CommNet.CommNode.isHome
Func<CommNode, double> CommNet.CommNode.OnLinkCreateSignalModifier
Action CommNet.CommNode.OnNetworkPostUpdate
Action CommNet.CommNode.OnNetworkPreUpdate
DoubleCurve CommNet.CommNode.scienceCurve

Property Documentation

override string CommNet.CommNode.displayName
getset
override string CommNet.CommNode.name
getset
override Vector3d CommNet.CommNode.position
get

The transform position, always up-to-date

virtual Vector3d CommNet.CommNode.precisePosition
getset

the Vector3d position, updated only when the network updates

Transform CommNet.CommNode.transform
getset

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