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_star.html | 564 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 564 insertions(+) create mode 100644 Doc/doxygen/html/class_star.html (limited to 'Doc/doxygen/html/class_star.html') diff --git a/Doc/doxygen/html/class_star.html b/Doc/doxygen/html/class_star.html new file mode 100644 index 0000000..5de350e --- /dev/null +++ b/Doc/doxygen/html/class_star.html @@ -0,0 +1,564 @@ + + + + + +Starshatter_Open: Star Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Attributes
+
+
Star Class Reference
+
+
+ +

#include <StarSystem.h>

+ +

List of all members.

+ + + +

+Public Types

enum  SPECTRAL_CLASS {
+  BLACK_HOLE, +WHITE_DWARF, +RED_GIANT, +O, +
+  B, +A, +F, +G, +
+  K, +M +
+ }
+ + + + + + + + + +

+Public Member Functions

 Star (const char *n, const Point &l, int s)
virtual ~Star ()
int operator== (const Star &s) const
const char * Name () const
const Point & Location () const
int Sequence () const
Color GetColor () const
int GetSize () const
+ + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static Color GetColor (int spectral_class)
static int GetSize (int spectral_class)
+ + + + +

+Protected Attributes

Text name
Point loc
int seq
+

Detailed Description

+
+

Definition at line 147 of file StarSystem.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum Star::SPECTRAL_CLASS
+
+
Enumerator:
+ + + + + + + + + + +
BLACK_HOLE  +
WHITE_DWARF  +
RED_GIANT  +
O  +
B  +
A  +
F  +
G  +
K  +
M  +
+
+
+ +

Definition at line 155 of file StarSystem.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Star::Star (const char * n,
const Point & l,
int s 
)
+ 		+inline
+
+ +

Definition at line 152 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Star::~Star ()
+ 		+inlinevirtual
+
+ +

Definition at line 153 of file StarSystem.h.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
Color Star::GetColor () const
+
+ +

Definition at line 1783 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Color Star::GetColor (int spectral_class)
+ 		+static
+
+ +

Definition at line 1795 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + + + +
int Star::GetSize () const
+
+ +

Definition at line 1789 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Star::GetSize (int spectral_class)
+ 		+static
+
+ +

Definition at line 1815 of file StarSystem.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const Point& Star::Location () const
+ 		+inline
+
+ +

Definition at line 162 of file StarSystem.h.

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

Definition at line 161 of file StarSystem.h.

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

Definition at line 158 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Star::Sequence () const
+ 		+inline
+
+ +

Definition at line 163 of file StarSystem.h.

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

Definition at line 150 of file StarSystem.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Point Star::loc
+ 		+protected
+
+ +

Definition at line 172 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text Star::name
+ 		+protected
+
+ +

Definition at line 171 of file StarSystem.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Star::seq
+ 		+protected
+
+ +

Definition at line 173 of file StarSystem.h.

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