orbitPlace Class Reference

#include <orbit-place.hpp>

Inheritance diagram for orbitPlace:

Inheritance graph
[legend]
Collaboration diagram for orbitPlace:

Collaboration graph
[legend]
List of all members.

Detailed Description

An orbitPlace is a spot within an orbitPlane occupied by one of many objects that are derived from this class.
See also:
sparseVectorNode

orbitPlane

Definition at line 39 of file orbit-place.hpp.

Public Member Functions

 orbitPlace ()
char * dumpAsXML ()
void setOrbit (int o)
int getOrbit ()
char * nodeSignature ()


Constructor & Destructor Documentation

orbitPlace::orbitPlace (  ) 

Generic constructor.

Definition at line 38 of file orbit-place.cpp.

00038                        : sparseVectorNode(){
00039         
00040 }


Member Function Documentation

char* orbitPlace::dumpAsXML (  ) 

Overloaded method to be overloaded further by derived objects of this class.

Returns:
pointer to a character string of (hopefully) well formed XML

Reimplemented from sparseVectorNode.

int orbitPlace::getOrbit (  ) 

Get the orbit number for this instance.

Returns:
integer value of the orbit number for this instance.

Reimplemented in star.

Definition at line 43 of file orbit-place.cpp.

References sparseVectorNode::getIndex().

Referenced by orbitPlane::add().

00043                         {
00044         return this->getIndex();
00045 }

Here is the call graph for this function:

Here is the caller graph for this function:

char * orbitPlace::nodeSignature (  ) 

The signature of this instance. In this case "orbitPlace"

Returns:
pointer to a character string "orbitPlace"

Reimplemented from sparseVectorNode.

Reimplemented in star.

Definition at line 52 of file orbit-place.cpp.

00052                                {
00053         return "orbitPlace";
00054 }

void orbitPlace::setOrbit ( int  o  ) 

Set the orbit number for this instance.

Parameters:
o integer value for the orbit to set this to.

Reimplemented in star.

Definition at line 47 of file orbit-place.cpp.

References sparseVectorNode::setIndex().

00047                                {
00048         this->setIndex(ix);
00049 }

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Generated on Fri Mar 7 16:42:11 2008 for frpuniverse by  doxygen 1.4.7