orbitPlane Class Reference

#include <orbit-plane.hpp>

Inheritance diagram for orbitPlane:

[legend]Collaboration diagram for orbitPlane:

[legend]List of all members.

---

Detailed Description

An orbit plane is a collection of orbits around an central (?) object such as a star, planet or ??

See also:

sparseVector

orbitPlace

Definition at line 42 of file orbit-plane.hpp.

Public Member Functions
	orbitPlane ()
void	add (orbitPlace *op)
void	add (int ix, orbitPlace *op)
int	isEmpty (int ix)

---

Constructor & Destructor Documentation

orbitPlane::orbitPlane

(

)

Generic constructor.

Definition at line 29 of file orbit-plane.cpp.

                       : sparseVector() {
        root = new orbitPlace();
        
}

---

Member Function Documentation

void orbitPlane::add	(	int	ix,
		orbitPlace *	op
	)

Place an object into the orbit plane at the spot specified by the passed parameters. See the caveat above. The orbitPlace object passed is updated with its orbit number.

Parameters:

	ix	integer value index to where the object should be placed.
	op	pointer to an orbitPlace object to be placed.

Definition at line 39 of file orbit-plane.cpp.

References sparseVector::addAt().

                                        {
        this->addAt(ix,p);
}

Here is the call graph for this function:

void orbitPlane::add

(

orbitPlace *

op

)

Add an item to the orbit plane using the parameter to determine at what orbit the object is to be placed. If an object already occupies that spot then the existing object is replaced by the new object.

Parameters:

op

pointer to an orbitPlace object.

Definition at line 34 of file orbit-plane.cpp.

References sparseVector::addAt(), and orbitPlace::getOrbit().

                                 {
        int ix = p->getOrbit();
        this->addAt(ix,p);
}

Here is the call graph for this function:

int orbitPlane::isEmpty

(

int

ix

)

Determine if a given orbit index is occupied or not.

Parameters:

ix

integer index of the orbit we are interested in

Returns:

1 if the orbit is empty or 0 if occupied.

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

                             {
        if ( this->findAt(ix) == 0 ) 
                return 1;
        else 
                return 0;
        
}

---

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

• include/orbit-plane.hpp
• src/orbit-plane.cpp

---