A MeteorShower object represents one meteor shower on the sky. More...

#include <MeteorShower.hpp>

Inheritance diagram for MeteorShower:

Collaboration diagram for MeteorShower:

Classes
struct	Activity

Public Types
enum	Status { INVALID, UNDEFINED, INACTIVE, ACTIVE_CONFIRMED, ACTIVE_GENERIC }

Public Types inherited from StelObject
enum	InfoStringGroupFlags { Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004, RaDecJ2000 = 0x00000008, RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040, Size = 0x00000080, Extra = 0x00000100, HourAngle = 0x00000200, AbsoluteMagnitude = 0x00000400, GalacticCoord = 0x00000800, SupergalacticCoord = 0x00001000, ObjectType = 0x00002000, EclipticCoordJ2000 = 0x00004000, EclipticCoordOfDate = 0x00008000, IAUConstellation = 0x00010000, SiderealTime = 0x00020000, NoFont = 0x00040000, PlainText = 0x00080000 }
	Used as named bitfield flags as specifiers to filter results of getInfoString. More...

Public Member Functions
	MeteorShower (MeteorShowersMgr *mgr, const QVariantMap &map)
	Constructor. More...

	~MeteorShower ()
	Destructor. More...

void	update (StelCore *core, double deltaTime)
	Update. More...

void	draw (StelCore *core)
	Draw. More...

Activity	hasGenericShower (QDate date, bool &found) const
	Checks if we have generic data for a given date. More...

Activity	hasConfirmedShower (QDate date, bool &found) const
	Checks if we have confirmed data for a given date. More...

bool	enabled () const
	Checks if this meteor shower is being displayed or not. More...

QString	getDesignation () const
	Gets the meteor shower id //! More...

Status	getStatus ()
	Gets the current meteor shower status. More...

QDate	getPeak ()
	Gets the peak. More...

int	getZHR ()
	Gets the current ZHR. More...

virtual QString	getInfoString (const StelCore *core, const InfoStringGroup &flags) const
	Write I18n information about the object in QString. More...

virtual QVariantMap	getInfoMap (const StelCore *core) const
	Return a map like StelObject, but with a few extra tags: More...

virtual QString	getType (void) const
	Return object's type. It should be the name of the class. More...

virtual QString	getID (void) const
	Returns a unique identifier for this object. More...

virtual QString	getEnglishName (void) const
	Return object's name in english. More...

virtual QString	getNameI18n (void) const
	Return translated object's name. More...

virtual Vec3d	getJ2000EquatorialPos (const StelCore *) const
	Get observer-centered equatorial coordinates at equinox J2000. More...

virtual float	getSelectPriority (const StelCore *) const
	Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority. More...

virtual Vec3f	getInfoColor (void) const
	Get a color used to display info about the object. More...

virtual double	getAngularSize (const StelCore *) const
	Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos(). More...

Public Member Functions inherited from StelObject
virtual SphericalRegionP	getRegion () const
	Default implementation of the getRegion method. More...

virtual Vec3d	getPointInRegion () const
	Default implementation of the getPointInRegion method. More...

Vec3d	getEquinoxEquatorialPos (const StelCore *core) const
	Get observer-centered equatorial coordinate at the current equinox The frame has its Z axis at the planet's current rotation axis At time 2000-01-01 this frame is almost the same as J2000, but ONLY if the observer is on earth. More...

Vec3d	getEquinoxEquatorialPosApparent (const StelCore *core) const
	Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position. More...

Vec3d	getEquinoxEquatorialPosAuto (const StelCore *core) const
	Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active. More...

Vec3d	getGalacticPos (const StelCore *core) const
	Get observer-centered galactic coordinates. More...

Vec3d	getSupergalacticPos (const StelCore *core) const
	Get observer-centered supergalactic coordinates. More...

Vec3d	getSiderealPosGeometric (const StelCore *core) const
	Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e. More...

Vec3d	getSiderealPosApparent (const StelCore *core) const
	Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e. More...

Vec3d	getAltAzPosGeometric (const StelCore *core) const
	Get observer-centered alt/az position It is the geometric position, i.e. More...

Vec3d	getAltAzPosApparent (const StelCore *core) const
	Get observer-centered alt/az position It is the apparent position, i.e. More...

Vec3d	getAltAzPosAuto (const StelCore *core) const
	Get observer-centered alt/az position It is the automatic position, i.e. More...

bool	isAboveHorizon (const StelCore *core) const
	Checking position an object above mathematical horizon for current location. More...

bool	isAboveRealHorizon (const StelCore *core) const
	Checking position an object above real horizon for current location. More...

virtual float	getVMagnitude (const StelCore *core) const
	Return object's apparent V magnitude as seen from observer, without including extinction. More...

float	getVMagnitudeWithExtinction (const StelCore *core) const
	Return object's apparent V magnitude as seen from observer including extinction. More...

virtual double	getCloseViewFov (const StelCore *) const
	Return the best FOV in degree to use for a close view of the object. More...

virtual double	getSatellitesFov (const StelCore *) const
	Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites) More...

virtual double	getParentSatellitesFov (const StelCore *) const

Static Public Attributes
static const QString	METEORSHOWER_TYPE

Static Public Attributes inherited from StelObject
static const InfoStringGroupFlags	AllInfo
	A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...

static const InfoStringGroupFlags	ShortInfo = (InfoStringGroupFlags)(Name\|CatalogNumber\|Magnitude\|RaDecJ2000)
	A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...

Additional Inherited Members
Protected Member Functions inherited from StelObject
QString	getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const
	Format the positional info string contain J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. for the object. More...

void	postProcessInfoString (QString &str, const InfoStringGroup &flags) const
	Apply post processing on the info string. More...

Detailed Description

A MeteorShower object represents one meteor shower on the sky.

Details about the meteor showers are passed using a QVariant which contains a map of data from the json file.

Definition at line 37 of file MeteorShower.hpp.

Constructor & Destructor Documentation

MeteorShower::MeteorShower	(	MeteorShowersMgr *	mgr,
		const QVariantMap &	map
	)

Constructor.

Parameters

map	QVariantMap containing all the data about a Meteor Shower.

MeteorShower::~MeteorShower ( )

Destructor.

Member Function Documentation

void MeteorShower::draw ( StelCore * core )

Draw.

bool MeteorShower::enabled ( ) const

Checks if this meteor shower is being displayed or not.

Returns: true if it's being displayed

virtual double MeteorShower::getAngularSize ( const StelCore * core ) const

inlinevirtual

Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos().

Returns: radius in degree. This value is the apparent angular size of the object, and is independent of the current FOV.

Implements StelObject.

Definition at line 128 of file MeteorShower.hpp.

QString MeteorShower::getDesignation ( ) const

Gets the meteor shower id //!

Returns: designation

virtual QString MeteorShower::getEnglishName ( void ) const

inlinevirtual

Return object's name in english.

Implements StelObject.

Definition at line 123 of file MeteorShower.hpp.

virtual QString MeteorShower::getID ( void ) const

inlinevirtual

Returns a unique identifier for this object.

The ID should be unique for all objects of the same type, but may freely conflict with IDs of other types, so getType() must also be tested.

With this it should be possible to at least identify the same object in a different instance of Stellarium running the same version, but it would even be better if the ID provides some degree of forward-compatibility. For some object types (e.g. planets) this may simply return getEnglishName(), but better candidates may be official designations or at least (stable) internal IDs.

An object may have multiple IDs (different catalog numbers, etc). StelObjectMgr::searchByID() should search through all ID variants, but this method only returns one of them.

Implements StelObject.

Definition at line 122 of file MeteorShower.hpp.

virtual Vec3f MeteorShower::getInfoColor ( void ) const

virtual

Get a color used to display info about the object.

Reimplemented from StelObject.

virtual QVariantMap MeteorShower::getInfoMap ( const StelCore * core ) const

virtual

Return a map like StelObject, but with a few extra tags:

status
id
type (translated string "meteor shower")
speed (km/s)
pop-idx (population index)
parent
zhr-max (information string)

Reimplemented from StelObject.

virtual QString MeteorShower::getInfoString	(	const StelCore *	core,
		const InfoStringGroup &	flags
	)		const

virtual

Write I18n information about the object in QString.

Parameters

core	the StelCore object to use
flags	a set of InfoStringGroup flags which are used to filter the return value - including specified types of information and altering the output format.

Returns: an HTML string containing information about the StelObject.

Implements StelObject.

virtual Vec3d MeteorShower::getJ2000EquatorialPos ( const StelCore * core ) const

inlinevirtual

Get observer-centered equatorial coordinates at equinox J2000.

Implements StelObject.

Definition at line 125 of file MeteorShower.hpp.

virtual QString MeteorShower::getNameI18n ( void ) const

inlinevirtual

Return translated object's name.

Implements StelObject.

Definition at line 124 of file MeteorShower.hpp.

QDate MeteorShower::getPeak ( )

inline

Gets the peak.

Returns: peak

Definition at line 100 of file MeteorShower.hpp.

virtual float MeteorShower::getSelectPriority ( const StelCore * ) const

inlinevirtual

Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority.

Reimplemented from StelObject.

Definition at line 126 of file MeteorShower.hpp.

Status MeteorShower::getStatus ( )

inline

Gets the current meteor shower status.

Returns: status

Definition at line 96 of file MeteorShower.hpp.

virtual QString MeteorShower::getType ( void ) const

inlinevirtual

Return object's type. It should be the name of the class.

Implements StelObject.

Definition at line 121 of file MeteorShower.hpp.

int MeteorShower::getZHR ( )

inline

Gets the current ZHR.

Returns: ZHR

Definition at line 104 of file MeteorShower.hpp.

Activity MeteorShower::hasConfirmedShower	(	QDate	date,
		bool &	found
	)		const

Checks if we have confirmed data for a given date.

Parameters

date QDate

Returns: Activity

Activity MeteorShower::hasGenericShower	(	QDate	date,
		bool &	found
	)		const

Checks if we have generic data for a given date.

Parameters

date QDate

Returns: Activity

void MeteorShower::update	(	StelCore *	core,
		double	deltaTime
	)

Update.

Parameters

deltaTime the time increment in seconds since the last call.

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

/home/aw/devel/stellarium/0.16/plugins/MeteorShowers/src/MeteorShower.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation