StarObject Class Reference

#include <starobject.h>

Inheritance diagram for StarObject:

Public Member Functions
	StarObject (dms r=dms(0.0), dms d=dms(0.0), float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &sptype="--", double pmra=0.0, double pmdec=0.0, double par=0.0, bool mult=false, bool var=false, int hd=0)
	StarObject (double r, double d, float m=0.0, const QString &n=QString(), const QString &n2=QString(), const QString &sptype="--", double pmra=0.0, double pmdec=0.0, double par=0.0, bool mult=false, bool var=false, int hd=0)
	StarObject (const StarObject &o)
	~StarObject ()
virtual StarObject *	clone () const
QString	constell (void) const
double	distance () const
float	getBMag () const
float	getBVIndex () const
int	getHDIndex () const
void	getIndexCoords (KSNumbers *num, double *ra, double *dec)
virtual UID	getUID () const
float	getVMag () const
QString	gname (bool useGreekChars=true) const
QString	greekLetter (bool useGreekChars=true) const
bool	hasName () const
void	init (const starData *stardata)
void	init (const deepStarData *stardata)
bool	isMultiple () const
bool	isVariable () const
void	JITupdate ()
virtual double	labelOffset () const
virtual QString	labelString () const
virtual QString	longname (void) const
virtual QString	name (void) const
QString	nameLabel (bool drawName, bool drawMag) const
double	parallax () const
double	pmDec () const
double	pmMagnitude ()
double	pmMagnitudeSquared ()
double	pmRA () const
void	setMultiple (bool m)
void	setNames (QString name, QString name2)
void	setParallax (double plx)
void	setProperMotion (double pmra, double pmdec)
void	setVariable (bool v)
char	spchar () const
QString	sptype (void) const
virtual void	updateCoords (KSNumbers *num, bool includePlanets=true, const dms *lat=0, const dms *LST=0, bool forceRecompute=false)
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
float	mag (void) const
float	mag (const QString &band) const
QString	messageFromTitle (const QString &imageTitle)
QString	name2 (void) const
QString &	notes ()
virtual double	pa () const
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])

Static Public Member Functions
static double	reindexInterval (double pm)
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)

Public Attributes
quint64	updateID
quint64	updateNumID

Additional Inherited Members
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 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
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 inherited from SkyObject
QSharedDataPointer< AuxInfo >	info
QString	LongName
QString	Name
QString	Name2
Protected Attributes inherited from SkyPoint
long double	lastPrecessJD
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"))

Detailed Description

This is a subclass of SkyObject.

It adds the Spectral type, and flags for variability and multiplicity. For stars, the primary name (n) is the latin name (e.g., "Betelgeuse"). The secondary name (n2) is the genetive name (e.g., "alpha Orionis"). subclass of SkyObject specialized for stars.

Author

Thomas Kabelmann

Version

1.0

Definition at line 41 of file starobject.h.

Constructor & Destructor Documentation

StarObject::StarObject ( dms  r = dms(0.0), dms  d = dms(0.0), float  m = 0.0, const QString &  n = QString(), const QString &  n2 = QString(), const QString &  sptype = "--", double  pmra = 0.0, double  pmdec = 0.0, double  par = 0.0, bool  mult = false, bool  var = false, int  hd = 0  )

explicit

Constructor.

Sets sky coordinates, magnitude, latin name, genetive name, and spectral type.

Parameters

r	Right Ascension
d	Declination
m	magnitude
n	common name
n2	genetive name
sptype	Spectral Type
pmra	Proper motion in RA direction [mas/yr]
pmdec	Proper motion in Dec direction [mas/yr]
par	Parallax angle [mas]
mult	Multiplicity flag (false=dingle star; true=multiple star)
var	Variability flag (true if star is a known periodic variable)
hd	Henry Draper Number

Definition at line 59 of file starobject.cpp.

StarObject::StarObject	(	double	r,
		double	d,
		float	m = 0.0,
		const QString &	n = QString(),
		const QString &	n2 = QString(),
		const QString &	sptype = "--",
		double	pmra = 0.0,
		double	pmdec = 0.0,
		double	par = 0.0,
		bool	mult = false,
		bool	var = false,
		int	hd = 0
	)

Constructor.

Sets sky coordinates, magnitude, latin name, genetive name, and spectral type. Differs from above function only in data type of RA and Dec.

Parameters

r	Right Ascension
d	Declination
m	magnitude
n	common name
n2	genetive name
sptype	Spectral Type
pmra	Proper motion in RA direction [mas/yr]
pmdec	Proper motion in Dec direction [mas/yr]
par	Parallax angle [mas]
mult	Multiplicity flag (false=dingle star; true=multiple star)
var	Variability flag (true if star is a known periodic variable)
hd	Henry Draper Number

Definition at line 86 of file starobject.cpp.

StarObject::StarObject

(

const StarObject &

o

)

Copy constructor.

Definition at line 114 of file starobject.cpp.

StarObject::~StarObject ( )

inline

Destructor.

(Empty)

Definition at line 97 of file starobject.h.

Member Function Documentation

StarObject * StarObject::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 SkyObject.

Definition at line 128 of file starobject.cpp.

QString StarObject::constell

(

void

)

const

Returns

the genitive form of the star's constellation.

Definition at line 394 of file starobject.cpp.

double StarObject::distance ( ) const

inline

Returns

the star's distance from the Sun in parsecs, as computed from the parallax.

Definition at line 216 of file starobject.h.

float StarObject::getBMag ( ) const

inline

Returns

the blue magnitude of the star

Definition at line 257 of file starobject.h.

float StarObject::getBVIndex ( ) const

inline

Returns

the B - V color index of the star, or a nonsense number larger than 30 if it's not well defined

Definition at line 263 of file starobject.h.

int StarObject::getHDIndex ( ) const

inline

Returns

the star's HD index

Definition at line 226 of file starobject.h.

void StarObject::getIndexCoords	(	KSNumbers *	num,
		double *	ra,
		double *	dec
	)

Definition at line 268 of file starobject.cpp.

SkyObject::UID StarObject::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.

Definition at line 522 of file starobject.cpp.

float StarObject::getVMag ( ) const

inline

Returns

the Visual magnitude of the star

Definition at line 252 of file starobject.h.

QString StarObject::gname

(

bool

useGreekChars = true

)

const

Returns the genetive name of the star.

Returns

genetive name of the star

Definition at line 349 of file starobject.cpp.

QString StarObject::greekLetter

(

bool

useGreekChars = true

)

const

Returns the greek letter portion of the star's genetive name.

Returns empty string if star has no genetive name defined.

Returns

greek letter portion of genetive name

Definition at line 356 of file starobject.cpp.

bool StarObject::hasName ( ) const

inline

Returns

true if the star has a name ("star" doesn't count)

Definition at line 128 of file starobject.h.

void StarObject::init

(

const starData *

stardata

)

Initializes a StarObject to given data.

This is almost like the StarObject constructor itself, but it avoids setting up name, gname etc for unnamed stars. If called instead of the constructor, this method will be much faster for unnamed stars

Parameters

stardata

Pointer to starData object containing required data (except name and gname)

Returns

Nothing

Definition at line 133 of file starobject.cpp.

void StarObject::init

(

const deepStarData *

stardata

)

Initializes a StarObject to given data.

Parameters

stardata

Pointer to deepStarData object containing the available data

Returns

Nothing

Definition at line 182 of file starobject.cpp.

bool StarObject::isMultiple ( ) const

inline

Returns

whether the star is a binary or multiple starobject

Definition at line 223 of file starobject.h.

bool StarObject::isVariable ( ) const

inline

Returns

whether the star is a binary or multiple starobject

Definition at line 235 of file starobject.h.

void StarObject::JITupdate

(

)

added for JIT updates from both StarComponent and ConstellationLines

Definition at line 317 of file starobject.cpp.

double StarObject::labelOffset ( ) const

virtual

Returns

the pixel distance for offseting the star's name label This takes the zoom level and the star's brightness into account.

Reimplemented from SkyObject.

Definition at line 518 of file starobject.cpp.

QString StarObject::labelString ( ) const

virtual

Returns

the string used to label the object on the map In the default implementation, this just returns translatedName() Overridden by StarObject.

Reimplemented from SkyObject.

Definition at line 514 of file starobject.cpp.

virtual QString StarObject::longname ( void  ) const

inlinevirtual

If star is unnamed return "star" otherwise return the longname.

Reimplemented from SkyObject.

Definition at line 134 of file starobject.h.

virtual QString StarObject::name ( void  ) const

inlinevirtual

If star is unnamed return "star" otherwise return the name.

Reimplemented from SkyObject.

Definition at line 131 of file starobject.h.

QString StarObject::nameLabel	(	bool	drawName,
		bool	drawMag
	)		const

Definition at line 493 of file starobject.cpp.

double StarObject::parallax ( ) const

inline

Returns

the star's parallax angle, in milliarcsec

Definition at line 213 of file starobject.h.

double StarObject::pmDec ( ) const

inline

Returns

the Dec component of the star's proper motion, in mas/yr

Definition at line 207 of file starobject.h.

double StarObject::pmMagnitude ( )

inline

returns the magnitude of the proper motion correction in milliarcsec/year

Definition at line 180 of file starobject.h.

double StarObject::pmMagnitudeSquared ( )

inline

returns the square of the magnitude of the proper motion correction in (milliarcsec/year)^2

Note

This method is faster when the square root need not be taken

Definition at line 190 of file starobject.h.

double StarObject::pmRA ( ) const

inline

Returns

the RA component of the star's proper motion, in mas/yr (multiplied by cos(dec))

Definition at line 204 of file starobject.h.

double StarObject::reindexInterval ( double  pm )

static

returns the reindex interval (in centuries!) for the given magnitude of proper motion (in milliarcsec/year).

ASSUMING a 25 arc-minute margin for proper motion.

Definition at line 49 of file starobject.cpp.

void StarObject::setMultiple ( bool  m )

inline

set the star's multiplicity flag (i.e., is it a binary or multiple star?)

Parameters

m	true if binary/multiple star system

Definition at line 220 of file starobject.h.

void StarObject::setNames	(	QString	name,
		QString	name2
	)

Sets the name, genetive name, and long name.

Parameters

name	Common name
name2	Genetive name

Definition at line 225 of file starobject.cpp.

void StarObject::setParallax ( double  plx )

inline

set the star's parallax angle, in milliarcsec

Definition at line 210 of file starobject.h.

void StarObject::setProperMotion ( double  pmra, double  pmdec  )

inline

Set the Ra and Dec components of the star's proper motion, in milliarcsec/year.

Note that the RA component is multiplied by cos(dec).

Parameters

pmra	the new RA propoer motion
pmdec	the new Dec proper motion

Definition at line 201 of file starobject.h.

void StarObject::setVariable ( bool  v )

inline

set the star's variability flag

Parameters

v	true if star is variable

Definition at line 231 of file starobject.h.

char StarObject::spchar

(

)

const

Returns just the first character of the spectral type string.

Definition at line 344 of file starobject.cpp.

QString StarObject::sptype

(

void

)

const

Returns entire spectral type string.

Returns

Spectral Type string

Definition at line 340 of file starobject.cpp.

void StarObject::updateCoords ( KSNumbers *  num, bool  includePlanets = true, const dms *  lat = 0, const dms *  LST = 0, bool  forceRecompute = false  )

virtual

Determine the current coordinates (RA, Dec) from the catalog coordinates (RA0, Dec0), accounting for both precession and nutation.

Parameters

num	pointer to KSNumbers object containing current values of time-dependent variables.
includePlanets	does nothing in this implementation (see KSPlanetBase::updateCoords()).
lat	does nothing in this implementation (see KSPlanetBase::updateCoords()).
LST	does nothing in this implementation (see KSPlanetBase::updateCoords()).

Reimplemented from SkyPoint.

Definition at line 244 of file starobject.cpp.

Member Data Documentation

quint64 StarObject::updateID

Definition at line 265 of file starobject.h.

quint64 StarObject::updateNumID

Definition at line 266 of file starobject.h.

---

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

• starobject.h
• starobject.cpp