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_nav_system.html | 480 +++++++++++++++++++++++++++++++++ 1 file changed, 480 insertions(+) create mode 100644 Doc/doxygen/html/class_nav_system.html (limited to 'Doc/doxygen/html/class_nav_system.html') diff --git a/Doc/doxygen/html/class_nav_system.html b/Doc/doxygen/html/class_nav_system.html new file mode 100644 index 0000000..dbf8df6 --- /dev/null +++ b/Doc/doxygen/html/class_nav_system.html @@ -0,0 +1,480 @@ + + + + + +Starshatter_Open: NavSystem Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Protected Attributes
+
+
NavSystem Class Reference
+
+
+ +

#include <NavSystem.h>

+
+Inheritance diagram for NavSystem:
+
+
+ + +System + +
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NavSystem ()
 NavSystem (const NavSystem &rhs)
virtual ~NavSystem ()
virtual void ExecFrame (double seconds)
virtual void Distribute (double delivered_energy, double seconds)
bool AutoNavEngaged ()
void EngageAutoNav ()
void DisengageAutoNav ()
- Public Member Functions inherited from System
 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 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
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)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

bool autonav
- Protected Attributes inherited from System
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
+ + + + + + + +

+Additional Inherited Members

- Public Types inherited from System
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 + }
- Static Public Member Functions inherited from System
static const char * TYPENAME ()
+

Detailed Description

+
+

Definition at line 32 of file NavSystem.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
NavSystem::NavSystem ()
+
+ +

Definition at line 25 of file NavSystem.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NavSystem::NavSystem (const NavSystem & rhs)
+
+ +

Definition at line 37 of file NavSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
NavSystem::~NavSystem ()
+ 		+virtual
+
+ +

Definition at line 47 of file NavSystem.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
bool NavSystem::AutoNavEngaged ()
+
+ +

Definition at line 65 of file NavSystem.cpp.

+ +
+
+ +
+
+ + + + + + + +
void NavSystem::DisengageAutoNav ()
+
+ +

Definition at line 85 of file NavSystem.cpp.

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

Reimplemented from System.

+ +

Definition at line 96 of file NavSystem.cpp.

+ +
+
+ +
+
+ + + + + + + +
void NavSystem::EngageAutoNav ()
+
+ +

Definition at line 71 of file NavSystem.cpp.

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

Reimplemented from System.

+ +

Definition at line 53 of file NavSystem.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
bool NavSystem::autonav
+ 		+protected
+
+ +

Definition at line 48 of file NavSystem.h.

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