org.gjt.universe.scheme001
Class Planet_001

java.lang.Object
  |
  +--org.gjt.universe.DBItem
        |
        +--org.gjt.universe.PlanetBase
              |
              +--org.gjt.universe.scheme001.Planet_001

All Implemented Interfaces:

java.io.Serializable

final class Planet_001

extends PlanetBase

Planet definition for Scheme 001.

Field Summary

private float	habitation
private static Distribution	habitationDistribution
private static float	homePlanetHabitation
private static float	homePlanetMining
private float	mining
private static Distribution	miningDistribution

Fields inherited from class org.gjt.universe.PlanetBase

Constructor Summary

private

Planet_001(SystemID in_sysID, int starIndex, java.lang.String in_name) Private constructor - called by new Planet()

Method Summary

void	drawInfoPanelOne(GUIFactoryOne gui, javax.swing.JPanel panel)
(package private) float	getHabitation()
(package private) float	getMining()
void	getSpecificTableInfo(CivID AID, DisplayReturn DR) This function allows additional values to be presented in the planet table.
(package private) static PlanetID	newPlanet(SystemID SID, int starIndex, java.lang.String in_name) This factory class method returns a newly created planet in the given system, orbiting the given star, and having the given name.
(package private) static void	setHabitationDistribution(Distribution habDis)
(package private) static void	setHomePlanetValues(java.lang.String str)
(package private) static void	setMiningDistribution(Distribution minDis)
void	setToHomePlanetValues()
VectorDisplayReturn	specificDisplay() This method returns the ID of the receiving instance
VectorDisplayReturn	specificDisplayDebug() Method used for getting debugging information.

Methods inherited from class org.gjt.universe.PlanetBase

addGroundStation, fleetArrived, fleetDeparted, getFleetsInOrbit, getGravityString, getGroundStationList, getID, getID, getIndex, getLocation, getName, getOwner, getPlanetaryPrimaryID, getPlanetMakeup, getPlanetType, getRadiusString, getStarIndex, getSystemID, getTemperatureString, isInhabited, isInhabitedByAnotherCiv, isInhabitedByCiv, isMoon, setName, setOwner, setPlanetaryPrimaryID, setPlanetMakeup, setStarIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

miningDistribution

private static Distribution miningDistribution

habitationDistribution

private static Distribution habitationDistribution

homePlanetMining

private static float homePlanetMining

homePlanetHabitation

private static float homePlanetHabitation

mining

private float mining

habitation

private float habitation

Constructor Detail

Planet_001

private Planet_001(SystemID in_sysID,
                   int starIndex,
                   java.lang.String in_name)

Private constructor - called by new Planet()

Parameters:

in_sysID - The system to which the planet is to be added.

starIndex - The index of the star in the system which the planet is orbiting.

in_name - The name of the planet.

Method Detail

newPlanet

static PlanetID newPlanet(SystemID SID,
                          int starIndex,
                          java.lang.String in_name)

This factory class method returns a newly created planet in the given system, orbiting the given star, and having the given name. As well, the planet will be given a default planetary make-up.

Parameters:

SID - The unique ID of the star syste to which the planet is being added.

starIndex - The index of the star within that system which the planet is orbiting.

in_name - The name to be assigned to the planet.

setMiningDistribution

static void setMiningDistribution(Distribution minDis)

setHabitationDistribution

static void setHabitationDistribution(Distribution habDis)

setHomePlanetValues

static void setHomePlanetValues(java.lang.String str)

setToHomePlanetValues

public void setToHomePlanetValues()

Specified by:

setToHomePlanetValues in class PlanetBase

getMining

float getMining()

getHabitation

float getHabitation()

getSpecificTableInfo

public void getSpecificTableInfo(CivID AID,
                                 DisplayReturn DR)

Description copied from class: PlanetBase

This function allows additional values to be presented in the planet table.

Specified by:

getSpecificTableInfo in class PlanetBase

specificDisplay

public VectorDisplayReturn specificDisplay()

Description copied from class: PlanetBase

This method returns the ID of the receiving instance

Specified by:

specificDisplay in class PlanetBase

specificDisplayDebug

public VectorDisplayReturn specificDisplayDebug()

Method used for getting debugging information.

Specified by:

specificDisplayDebug in class DBItem

drawInfoPanelOne

public void drawInfoPanelOne(GUIFactoryOne gui,
                             javax.swing.JPanel panel)

Specified by:

drawInfoPanelOne in class PlanetBase