From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_system.html | 2603 ++++++++++++++++++++++++++++++++++++ 1 file changed, 2603 insertions(+) create mode 100644 Doc/doxygen/html/class_system.html (limited to 'Doc/doxygen/html/class_system.html') diff --git a/Doc/doxygen/html/class_system.html b/Doc/doxygen/html/class_system.html new file mode 100644 index 0000000..d51ef09 --- /dev/null +++ b/Doc/doxygen/html/class_system.html @@ -0,0 +1,2603 @@ + + + + + +Starshatter_Open: System Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Attributes
+
+
System Class Reference
+
+
+ +

#include <System.h>

+
+Inheritance diagram for System:
+
+
+ + +Computer +Drive +Farcaster +FlightDeck +LandingGear +NavLight +NavSystem +PowerSource +QuantumDrive +Sensor +Shield +Thruster +Weapon + +
+ +

List of all members.

+ + + + + +

+Public Types

enum  CATEGORY {
+  MISC_SYSTEM = 0, +DRIVE = 1, +WEAPON, +SHIELD, +
+  SENSOR, +COMPUTER, +POWER_SOURCE, +FLIGHT_DECK, +
+  FARCASTER +
+ }
enum  STATUS {
+  DESTROYED, +CRITICAL, +DEGRADED, +NOMINAL, +
+  MAINT +
+ }
enum  POWER_FLAGS { POWER_WATTS = 1, +POWER_CRITICAL = 2 + }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 System (CATEGORY t, int s, const char *n, int maxv, double energy=0, double capacity=100, double sink_rate=1)
 System (const System &s)
virtual ~System ()
int operator== (const System &s) const
CATEGORY Type () const
int Subtype () const
const char * Name () const
const char * Abbreviation () const
void SetName (const char *n)
void SetAbbreviation (const char *a)
void SetDesign (SystemDesign *d)
virtual int Value () const
int MaxValue () const
STATUS Status () const
double Availability () const
double Safety () const
double Stability () const
virtual void CalcStatus ()
virtual void Repair ()
double NetAvail () const
void SetNetAvail (double d)
List< Component > & GetComponents ()
virtual void ApplyDamage (double damage)
virtual void ExecFrame (double seconds)
virtual void ExecMaintFrame (double seconds)
virtual void DoEMCON (int emcon)
virtual void Orient (const Physical *rep)
virtual void Mount (Point loc, float radius, float hull_factor=0.5f)
virtual void Mount (const System &system)
Point MountLocation () const
double Radius () const
double HullProtection () const
bool IsPowerCritical () const
bool UsesWatts () const
virtual double GetRequest (double seconds) const
virtual void Distribute (double delivered_energy, double seconds)
int GetSourceIndex () const
void SetSourceIndex (int i)
virtual int Charge () const
bool IsPowerOn () const
virtual void PowerOn ()
virtual void PowerOff ()
virtual double GetPowerLevel () const
virtual void SetPowerLevel (double level)
virtual void SetOverride (bool over)
virtual void DrainPower (double to_level)
void SetCapacity (double c)
double GetCapacity () const
double GetEnergy () const
double GetSinkRate () const
void SetEMCONPower (int emcon, int power_level)
int GetEMCONPower (int emcon)
int GetExplosionType () const
void SetExplosionType (int t)
Ship * GetShip () const
void SetShip (Ship *s)
int GetID () const
void SetID (int n)
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

CATEGORY type
Ship * ship
int id
int subtype
int max_value
Text name
Text abrv
STATUS status
float crit_level
float availability
float safety
float stability
float safety_overload
float net_avail
Point mount_loc
Point mount_rel
float radius
float hull_factor
float energy
float capacity
float sink_rate
float power_level
int source_index
DWORD power_flags
bool power_on
BYTE emcon_power [3]
BYTE emcon
int explosion_type
SystemDesign * design
List< Component > components
+

Detailed Description

+
+

Definition at line 33 of file System.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum System::CATEGORY
+
+
Enumerator:
+ + + + + + + + + +
MISC_SYSTEM  +
DRIVE  +
WEAPON  +
SHIELD  +
SENSOR  +
COMPUTER  +
POWER_SOURCE  +
FLIGHT_DECK  +
FARCASTER  +
+
+
+ +

Definition at line 40 of file System.h.

+ +
+
+ +
+
+ + + + +
enum System::POWER_FLAGS
+
+
Enumerator:
+ + +
POWER_WATTS  +
POWER_CRITICAL  +
+
+
+ +

Definition at line 43 of file System.h.

+ +
+
+ +
+
+ + + + +
enum System::STATUS
+
+
Enumerator:
+ + + + + +
DESTROYED  +
CRITICAL  +
DEGRADED  +
NOMINAL  +
MAINT  +
+
+
+ +

Definition at line 42 of file System.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
System::System (System::CATEGORY t,
int s,
const char * n,
int maxv,
double energy = 0,
double capacity = 100,
double sink_rate = 1 
)
+
+ +

Definition at line 25 of file System.cpp.

+ +
+
+ +
+
+ + + + + + + + +
System::System (const System & s)
+
+ +

Definition at line 46 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
System::~System ()
+ 		+virtual
+
+ +

Definition at line 74 of file System.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
const char* System::Abbreviation () const
+ 		+inline
+
+ +

Definition at line 55 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::ApplyDamage (double damage)
+ 		+virtual
+
+ +

Reimplemented in Computer.

+ +

Definition at line 269 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::Availability () const
+ 		+inline
+
+ +

Definition at line 64 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void System::CalcStatus ()
+ 		+virtual
+
+ +

Definition at line 299 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int System::Charge () const
+ 		+inlinevirtual
+
+ +

Reimplemented in PowerSource.

+ +

Definition at line 99 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void System::Distribute (double delivered_energy,
double seconds 
)
+ 		+virtual
+
+ +

Reimplemented in Weapon, Shield, NavSystem, and Computer.

+ +

Definition at line 372 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::DoEMCON (int emcon)
+ 		+virtual
+
+ +

Reimplemented in Shield, and Sensor.

+ +

Definition at line 163 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::DrainPower (double to_level)
+ 		+virtual
+
+ +

Reimplemented in PowerSource.

+ +

Definition at line 396 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::ExecFrame (double seconds)
+ 		+virtual
+
+ +

Reimplemented in FlightDeck, Weapon, Thruster, QuantumDrive, Sensor, Farcaster, LandingGear, NavSystem, Shield, NavLight, Computer, and PowerSource.

+ +

Definition at line 185 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::ExecMaintFrame (double seconds)
+ 		+virtual
+
+ +

Definition at line 254 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::GetCapacity () const
+ 		+inline
+
+ +

Definition at line 114 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Component>& System::GetComponents ()
+ 		+inline
+
+ +

Definition at line 73 of file System.h.

+ +
+
+ +
+
+ + + + + + + + +
int System::GetEMCONPower (int emcon)
+
+ +

Definition at line 153 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::GetEnergy () const
+ 		+inline
+
+ +

Definition at line 115 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int System::GetExplosionType () const
+ 		+inline
+
+ +

Definition at line 120 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int System::GetID () const
+ 		+inline
+
+ +

Definition at line 125 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double System::GetPowerLevel () const
+ 		+inlinevirtual
+
+ +

Definition at line 106 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
double System::GetRequest (double seconds) const
+ 		+virtual
+
+ +

Reimplemented in Thruster, and Drive.

+ +

Definition at line 360 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Ship* System::GetShip () const
+ 		+inline
+
+ +

Reimplemented in Farcaster, and QuantumDrive.

+ +

Definition at line 123 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::GetSinkRate () const
+ 		+inline
+
+ +

Definition at line 116 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int System::GetSourceIndex () const
+ 		+inline
+
+ +

Definition at line 96 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::HullProtection () const
+ 		+inline
+
+ +

Definition at line 87 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool System::IsPowerCritical () const
+ 		+inline
+
+ +

Definition at line 90 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool System::IsPowerOn () const
+ 		+inline
+
+ +

Definition at line 101 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int System::MaxValue () const
+ 		+inline
+
+ +

Definition at line 62 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void System::Mount (Point loc,
float radius,
float hull_factor = 0.5f 
)
+ 		+virtual
+
+ +

Definition at line 331 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::Mount (const System & system)
+ 		+virtual
+
+ +

Definition at line 339 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point System::MountLocation () const
+ 		+inline
+
+ +

Definition at line 85 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* System::Name () const
+ 		+inline
+
+ +

Definition at line 54 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::NetAvail () const
+ 		+inline
+
+ +

Definition at line 70 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int System::operator== (const System & s) const
+ 		+inline
+
+ +

Definition at line 50 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::Orient (const Physical * rep)
+ 		+virtual
+
+ +

Reimplemented in FlightDeck, Weapon, Thruster, Drive, Farcaster, NavLight, and LandingGear.

+ +

Definition at line 349 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void System::PowerOff ()
+ 		+inlinevirtual
+
+ +

Reimplemented in QuantumDrive.

+ +

Definition at line 103 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual void System::PowerOn ()
+ 		+inlinevirtual
+
+ +

Definition at line 102 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::Radius () const
+ 		+inline
+
+ +

Definition at line 86 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void System::Repair ()
+ 		+virtual
+
+ +

Definition at line 241 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::Safety () const
+ 		+inline
+
+ +

Definition at line 65 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetAbbreviation (const char * a)
+ 		+inline
+
+ +

Definition at line 58 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetCapacity (double c)
+ 		+inline
+
+ +

Definition at line 113 of file System.h.

+ +
+
+ +
+
+ + + + + + + + +
void System::SetDesign (SystemDesign * d)
+
+ +

Definition at line 82 of file System.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void System::SetEMCONPower (int emcon,
int power_level 
)
+
+ +

Definition at line 145 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetExplosionType (int t)
+ 		+inline
+
+ +

Definition at line 121 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetID (int n)
+ 		+inline
+
+ +

Definition at line 126 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetName (const char * n)
+ 		+inline
+
+ +

Definition at line 57 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetNetAvail (double d)
+ 		+inline
+
+ +

Definition at line 71 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetOverride (bool over)
+ 		+virtual
+
+ +

Reimplemented in PowerSource.

+ +

Definition at line 126 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetPowerLevel (double level)
+ 		+virtual
+
+ +

Reimplemented in Shield, and PowerSource.

+ +

Definition at line 103 of file System.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetShip (Ship * s)
+ 		+inline
+
+ +

Reimplemented in Thruster, QuantumDrive, and Farcaster.

+ +

Definition at line 124 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void System::SetSourceIndex (int i)
+ 		+inline
+
+ +

Definition at line 97 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double System::Stability () const
+ 		+inline
+
+ +

Definition at line 66 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
STATUS System::Status () const
+ 		+inline
+
+ +

Definition at line 63 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int System::Subtype () const
+ 		+inline
+
+ +

Definition at line 53 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
CATEGORY System::Type () const
+ 		+inline
+
+ +

Definition at line 52 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* System::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented in FlightDeck, Thruster, and Weapon.

+ +

Definition at line 38 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool System::UsesWatts () const
+ 		+inline
+
+ +

Definition at line 91 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int System::Value () const
+ 		+inlinevirtual
+
+ +

Definition at line 61 of file System.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Text System::abrv
+ 		+protected
+
+ +

Definition at line 138 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::availability
+ 		+protected
+
+ +

Definition at line 143 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::capacity
+ 		+protected
+
+ +

Definition at line 157 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
List<Component> System::components
+ 		+protected
+
+ +

Definition at line 170 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::crit_level
+ 		+protected
+
+ +

Definition at line 142 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
SystemDesign* System::design
+ 		+protected
+
+ +

Reimplemented in Weapon.

+ +

Definition at line 169 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
BYTE System::emcon
+ 		+protected
+
+ +

Definition at line 164 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
BYTE System::emcon_power[3]
+ 		+protected
+
+ +

Definition at line 163 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::energy
+ 		+protected
+
+ +

Definition at line 156 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int System::explosion_type
+ 		+protected
+
+ +

Definition at line 166 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::hull_factor
+ 		+protected
+
+ +

Definition at line 153 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int System::id
+ 		+protected
+
+ +

Definition at line 132 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int System::max_value
+ 		+protected
+
+ +

Definition at line 134 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point System::mount_loc
+ 		+protected
+
+ +

Definition at line 150 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Point System::mount_rel
+ 		+protected
+
+ +

Definition at line 151 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text System::name
+ 		+protected
+
+ +

Definition at line 137 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::net_avail
+ 		+protected
+
+ +

Definition at line 147 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
DWORD System::power_flags
+ 		+protected
+
+ +

Definition at line 161 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::power_level
+ 		+protected
+
+ +

Definition at line 159 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool System::power_on
+ 		+protected
+
+ +

Definition at line 162 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::radius
+ 		+protected
+
+ +

Definition at line 152 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::safety
+ 		+protected
+
+ +

Definition at line 144 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::safety_overload
+ 		+protected
+
+ +

Definition at line 146 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Ship* System::ship
+ 		+protected
+
+ +

Reimplemented in Thruster, Farcaster, and QuantumDrive.

+ +

Definition at line 131 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::sink_rate
+ 		+protected
+
+ +

Definition at line 158 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int System::source_index
+ 		+protected
+
+ +

Definition at line 160 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
float System::stability
+ 		+protected
+
+ +

Definition at line 145 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
STATUS System::status
+ 		+protected
+
+ +

Definition at line 141 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int System::subtype
+ 		+protected
+
+ +

Definition at line 133 of file System.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
CATEGORY System::type
+ 		+protected
+
+ +

Definition at line 130 of file System.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1