KSPlanet Class Reference

#include <ksplanet.h>

Inheritance diagram for KSPlanet:

Classes
class	OrbitData
class	OrbitDataColl
class	OrbitDataManager

Public Member Functions
	KSPlanet (const QString &s="unnamed", const QString &image_file=QString(), const QColor &c=Qt::white, double pSize=0)
	KSPlanet (int n)
virtual	~KSPlanet ()
virtual void	calcEcliptic (double jm, EclipticPosition &ret) const
virtual KSPlanet *	clone () const
virtual SkyObject::UID	getUID () const
virtual bool	loadData ()
QString	untranslatedName (void) const
Public Member Functions inherited from KSPlanetBase
	KSPlanetBase (const QString &s=i18n("unnamed"), const QString &image_file=QString(), const QColor &c=Qt::white, double pSize=0)
virtual	~KSPlanetBase ()
double	angSize () const
QColor &	color ()
const dms &	ecLat () const
void	EclipticToEquatorial (const dms *Obliquity)
const dms &	ecLong () const
void	EquatorialToEcliptic (const dms *Obliquity)
void	findPosition (const KSNumbers *num, const dms *lat=0, const dms *LST=0, const KSPlanetBase *Earth=0)
const dms &	helEcLat () const
const dms &	helEcLong () const
const QImage &	image ()
void	init (const QString &s, const QString &image_file, const QColor &c, double pSize)
bool	isMajorPlanet () const
virtual double	labelOffset () const
virtual double	pa () const
dms	phase ()
double	physicalSize () const
double	rearth () const
double	rsun () const
void	setAngularSize (double size)
void	setColor (const QColor &c)
void	setEcLat (dms elat)
void	setEcLong (dms elong)
void	setPA (double p)
void	setPhysicalSize (double size)
void	setRearth (double r)
void	setRearth (const KSPlanetBase *Earth)
void	setRsun (double r)
virtual void	updateCoords (KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute=false)
Public Member Functions inherited from TrailObject
	TrailObject (int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString())
	TrailObject (int t, double r, double d, float m=0.0, const QString &n=QString())
virtual	~TrailObject ()
void	addToTrail ()
void	clearTrail ()
void	clipTrail ()
void	drawTrail (SkyPainter *skyp) const
bool	hasTrail () const
const QList< SkyPoint > &	trail () const
void	updateTrail (dms *LST, const dms *lat)
Public Member Functions inherited from SkyObject
	SkyObject (int t=TYPE_UNKNOWN, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString())
	SkyObject (int t, double r, double d, float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &lname=QString())
virtual	~SkyObject ()
bool	hasAuxInfo ()
bool	hasLongName () const
bool	hasName () const
bool	hasName2 () const
QStringList &	ImageList ()
QStringList &	ImageTitle ()
QStringList &	InfoList ()
QStringList &	InfoTitle ()
bool	isSolarSystem () const
virtual QString	labelString () const
virtual QString	longname (void) const
float	mag (void) const
float	mag (const QString &band) const
QString	messageFromTitle (const QString &imageTitle)
virtual QString	name (void) const
QString	name2 (void) const
QString &	notes ()
SkyPoint	recomputeCoords (const KStarsDateTime &dt, const GeoLocation *geo=0)
QTime	riseSetTime (const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true)
dms	riseSetTimeAz (const KStarsDateTime &dt, const GeoLocation *geo, bool rst)
QTime	riseSetTimeUT (const KStarsDateTime &dt, const GeoLocation *geo, bool rst, bool exact=true)
void	saveUserLog (const QString &newLog)
void	setLongName (const QString &longname=QString())
void	setNotes (QString _notes)
void	setType (int t)
void	showPopupMenu (KSPopupMenu *pmenu, const QPoint &pos)
dms	transitAltitude (const KStarsDateTime &dt, const GeoLocation *geo)
QTime	transitTime (const KStarsDateTime &dt, const GeoLocation *geo)
QTime	transitTimeUT (const KStarsDateTime &dt, const GeoLocation *geo)
QString	translatedLongName () const
QString	translatedName () const
QString	translatedName2 () const
int	type (void) const
QString	typeName () const
QString &	userLog ()
Public Member Functions inherited from SkyPoint
	SkyPoint (const dms &r, const dms &d)
	SkyPoint (double r, double d)
	SkyPoint ()
virtual	~SkyPoint ()
void	aberrate (const KSNumbers *num)
void	addEterms (void)
const dms &	alt () const
dms	altRefracted () const
dms	angularDistanceTo (const SkyPoint *sp, double *const positionAngle=0) const
void	apparentCoord (long double jd0, long double jdf)
const dms &	az () const
void	B1950ToJ2000 (void)
bool	bendlight ()
bool	checkBendLight ()
bool	checkCircumpolar (const dms *gLat)
const dms &	dec () const
const dms &	dec0 () const
SkyPoint	deprecess (const KSNumbers *num, long double epoch=J2000)
void	Equatorial1950ToGalactic (dms &galLong, dms &galLat)
void	EquatorialToHorizontal (const dms *LST, const dms *lat)
SkyPoint	Eterms (void)
void	findEcliptic (const dms *Obliquity, dms &EcLong, dms &EcLat)
void	GalacticToEquatorial1950 (const dms *galLong, const dms *galLat)
void	HorizontalToEquatorial (const dms *LST, const dms *lat)
void	J2000ToB1950 (void)
SkyPoint	moveAway (const SkyPoint &from, double dist)
void	nutate (const KSNumbers *num)
bool	operator== (SkyPoint &p)
void	precessFromAnyEpoch (long double jd0, long double jdf)
const dms &	ra () const
const dms &	ra0 () const
void	set (const dms &r, const dms &d)
void	setAlt (dms alt)
void	setAlt (double alt)
void	setAz (dms az)
void	setAz (double az)
void	setDec (dms d)
void	setDec (double d)
void	setDec0 (dms d)
void	setDec0 (double d)
void	setFromEcliptic (const dms *Obliquity, const dms &EcLong, const dms &EcLat)
void	setRA (dms r)
void	setRA (double r)
void	setRA0 (dms r)
void	setRA0 (double r)
void	subtractEterms (void)
double	vGeocentric (double vhelio, long double jd)
double	vGeoToVHelio (double vgeo, long double jd)
double	vHeliocentric (double vlsr, long double jd)
double	vHelioToVlsr (double vhelio, long double jd)
double	vREarth (long double jd0)
double	vRSite (double vsite[3])
double	vRSun (long double jd)
double	vTopocentric (double vgeo, double vsite[3])
double	vTopoToVGeo (double vtopo, double vsite[3])

Protected Types
typedef QVector< OrbitData >	OBArray [6]

Protected Member Functions
virtual bool	findGeocentricPosition (const KSNumbers *num, const KSPlanetBase *Earth=NULL)
Protected Member Functions inherited from KSPlanetBase
void	findPA (const KSNumbers *num)
virtual void	findPhase ()
UID	solarsysUID (UID type) const
Protected Member Functions inherited from SkyObject
void	setMag (float m)
void	setMag (const QString &band, const double mag)
void	setName (const QString &name)
void	setName2 (const QString &name2=QString())
Protected Member Functions inherited from SkyPoint
void	precess (const KSNumbers *num)

Protected Attributes
bool	data_loaded
Protected Attributes inherited from KSPlanetBase
EclipticPosition	ep
EclipticPosition	helEcPos
QImage	m_image
double	Phase
double	Rearth
Protected Attributes inherited from TrailObject
QList< SkyPoint >	Trail
Protected Attributes inherited from SkyObject
QSharedDataPointer< AuxInfo >	info
QString	LongName
QString	Name
QString	Name2
Protected Attributes inherited from SkyPoint
long double	lastPrecessJD

Static Protected Attributes
static OrbitDataManager	odm
Static Protected Attributes inherited from KSPlanetBase
static const UID	UID_SOL_ASTEROID = 1
static const UID	UID_SOL_BIGOBJ = 0
static const UID	UID_SOL_COMET = 2
Static Protected Attributes inherited from TrailObject
static QSet< TrailObject * >	trailObjects
Static Protected Attributes inherited from SkyObject
static QString	emptyString
static QString	starString = QString("star")
static QString	unnamedObjectString = QString(I18N_NOOP("unnamed object"))
static QString	unnamedString = QString(I18N_NOOP("unnamed"))

Additional Inherited Members
Public Types inherited from KSPlanetBase
enum	Planets {   MERCURY =0, VENUS =1, MARS =2, JUPITER =3,   SATURN =4, URANUS =5, NEPTUNE =6, PLUTO =7,   SUN =8, MOON =9, UNKNOWN_PLANET }
Public Types inherited from SkyObject
enum	TYPE {   STAR =0, CATALOG_STAR =1, PLANET =2, OPEN_CLUSTER =3,   GLOBULAR_CLUSTER =4, GASEOUS_NEBULA =5, PLANETARY_NEBULA =6, SUPERNOVA_REMNANT =7,   GALAXY =8, COMET =9, ASTEROID =10, CONSTELLATION =11,   MOON =12, ASTERISM =13, GALAXY_CLUSTER =14, DARK_NEBULA =15,   QUASAR =16, MULT_STAR =17, RADIO_SOURCE =18, SATELLITE =19,   SUPERNOVA =20, TYPE_UNKNOWN }
typedef qint64	UID
Static Public Member Functions inherited from KSPlanetBase
static KSPlanetBase *	createPlanet (int n)
Static Public Member Functions inherited from TrailObject
static void	clearTrailsExcept (SkyObject *o)
Static Public Member Functions inherited from SkyObject
static QString	typeName (const int t)
Static Public Member Functions inherited from SkyPoint
static double	refract (const double alt)
static dms	refract (const dms alt)
static double	refractionCorr (double alt)
static double	unrefract (const double alt)
static dms	unrefract (const dms alt)
Static Public Attributes inherited from KSPlanetBase
static QVector< QColor >	planetColor
Static Public Attributes inherited from TrailObject
static const int	MaxTrail = 400
Static Public Attributes inherited from SkyObject
static const UID	invalidUID = ~0
static const UID	UID_DEEPSKY = 2
static const UID	UID_GALAXY = 1
static const UID	UID_SOLARSYS = 3
static const UID	UID_STAR = 0
Static Public Attributes inherited from SkyPoint
static const double	altCrit = -1.0

Detailed Description

A subclass of KSPlanetBase for seven of the major planets in the solar system (Earth and Pluto have their own specialized classes derived from KSPlanetBase).

Note

The Sun is subclassed from KSPlanet.

KSPlanet contains internal classes to manage the computations of a planet's position. The position is computed as a series of sinusoidal sums, similar to a Fourier transform. See "Astronomical Algorithms" by Jean Meeus or the file README.planetmath for details. Provides necessary information about objects in the solar system.

Author

Jason Harris

Version

1.0

Definition at line 40 of file ksplanet.h.

Member Typedef Documentation

typedef QVector<OrbitData> KSPlanet::OBArray[6]

protected

Definition at line 126 of file ksplanet.h.

Constructor & Destructor Documentation

KSPlanet::KSPlanet ( const QString &  s = "unnamed", const QString &  image_file = QString(), const QColor &  c = Qt::white, double  pSize = 0  )

explicit

Constructor.

Parameters

s	Name of planet
image_file	filename of the planet's image
c	the color for the planet
pSize	physical diameter of the planet, in km

Definition at line 115 of file ksplanet.cpp.

KSPlanet::KSPlanet ( int  n )

explicit

Simplified constructor.

Parameters

n	identifier of the planet to be created

See also

PLANET enum

Definition at line 120 of file ksplanet.cpp.

virtual KSPlanet::~KSPlanet ( )

inlinevirtual

Destructor (empty)

Definition at line 66 of file ksplanet.h.

Member Function Documentation

void KSPlanet::calcEcliptic ( double  jm, EclipticPosition &  ret  ) const

virtual

Calculate the ecliptic longitude and latitude of the planet for the given date (expressed in Julian Millenia since J2000).

A reference to the ecliptic coordinates is returned as the second object.

Parameters

jm	Julian Millenia (=jd/1000)
ret	The ecliptic coordinates are returned by reference through this argument.

Definition at line 182 of file ksplanet.cpp.

KSPlanet * KSPlanet::clone ( ) const

virtual

Create copy of object.

This method is virtual copy constructor. It allows for safe copying of objects. In other words, KSPlanet object stored in SkyObject pointer will be copied as KSPlanet. Each subclass of SkyObject MUST implement clone method.

Returns

pointer to newly allocated object. Caller takes full responsibility for deallocating it.

Reimplemented from TrailObject.

Reimplemented in KSSun.

Definition at line 151 of file ksplanet.cpp.

bool KSPlanet::findGeocentricPosition ( const KSNumbers *  num, const KSPlanetBase *  Earth = NULL  )

protectedvirtual

Calculate the geocentric RA, Dec coordinates of the Planet.

Note

reimplemented from KSPlanetBase

Parameters

num	pointer to object with time-dependent values for the desired date
Earth	pointer to the planet Earth (needed to calculate geocentric coords)

Returns

true if position was successfully calculated.

Implements KSPlanetBase.

Reimplemented in KSSun.

Definition at line 248 of file ksplanet.cpp.

SkyObject::UID KSPlanet::getUID ( ) const

virtual

Return UID for object.

This method should be reimplemented in all concrete subclasses. Implementation for SkyObject just returns invalidUID. It's required SkyObject is not an abstract class.

Reimplemented from SkyObject.

Reimplemented in KSSun.

Definition at line 365 of file ksplanet.cpp.

bool KSPlanet::loadData ( )

virtual

Preload the data used by findPosition.

Implements KSPlanetBase.

Reimplemented in KSSun.

Definition at line 177 of file ksplanet.cpp.

QString KSPlanet::untranslatedName

(

void

)

const

return the untranslated name This is a dirty way to solve a lot of localization-related trouble for the KDE 4.2 release TODO: Change the whole architecture for names later

Definition at line 157 of file ksplanet.cpp.

Member Data Documentation

bool KSPlanet::data_loaded

protected

Definition at line 88 of file ksplanet.h.

KSPlanet::OrbitDataManager KSPlanet::odm

staticprotected

Definition at line 179 of file ksplanet.h.

---

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

• ksplanet.h
• ksplanet.cpp