Supernovae Class Reference

Main class of the Historical Supernovae plugin. More...

#include <Supernovae.hpp>

Public Types
enum	UpdateState {   Updating, CompleteNoUpdates, CompleteUpdates, DownloadError,   OtherError }
	Used for keeping for track of the download/update status. More...

Public Slots
void	updateJSON (void)
	Download JSON from web recources described in the module section of the module.ini file and update the local JSON file. More...
void	displayMessage (const QString &message, const QString hexColor="#999999")
	Display a message. This is used for plugin-specific warnings and such. More...
void	messageTimeout (void)

Signals
void	updateStateChanged (Supernovae::UpdateState state)
void	jsonUpdateComplete (void)
	Emitted after a JSON update has run. More...

Public Member Functions
virtual void	init ()
	Initialize itself. More...
virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...
virtual void	update (double)
	Update the module with respect to the time. More...
virtual void	draw (StelCore *core, class StelRenderer *renderer)
	Execute all the drawing functions for this module. More...
virtual void	drawPointer (StelCore *core, class StelRenderer *renderer, StelProjectorP projector)
virtual double	getCallOrder (StelModuleActionName actionName) const
	Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...
virtual QList< StelObjectP >	searchAround (const Vec3d &v, double limitFov, const StelCore *core) const
	Used to get a list of objects which are near to some position. More...
virtual StelObjectP	searchByNameI18n (const QString &nameI18n) const
	Return the matching satellite object's pointer if exists or NULL. More...
virtual StelObjectP	searchByName (const QString &name) const
	Return the matching satellite if exists or NULL. More...
virtual QStringList	listMatchingObjectsI18n (const QString &objPrefix, int maxNbItem=5) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name. More...
virtual QStringList	listMatchingObjects (const QString &objPrefix, int maxNbItem=5) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object English name. More...
virtual QStringList	listAllObjects (bool inEnglish) const
virtual QString	getName () const
SupernovaP	getByID (const QString &id)
	get a supernova object by identifier More...
virtual bool	configureGui (bool show=true)
	Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin. More...
void	restoreDefaults (void)
	Set up the plugin with default values. More...
void	readSettingsFromConfig (void)
	Read (or re-read) settings from the main config file. More...
void	saveSettingsToConfig (void)
	Save the settings to the main configuration file. More...
bool	getUpdatesEnabled (void)
	Get whether or not the plugin will try to update catalog data from the internet. More...
void	setUpdatesEnabled (bool b)
	Set whether or not the plugin will try to update catalog data from the internet. More...
QDateTime	getLastUpdate (void)
	Get the date and time the supernovae were updated. More...
int	getUpdateFrequencyDays (void)
	Get the update frequency in days. More...
void	setUpdateFrequencyDays (int days)
int	getSecondsToUpdate (void)
	Get the number of seconds till the next update. More...
UpdateState	getUpdateState (void)
	Get the current updateState. More...
QString	getSupernovaeList ()
	Get list of supernovae. More...

Detailed Description

Main class of the Historical Supernovae plugin.

Author

Alexander Wolf

Definition at line 61 of file Supernovae.hpp.

Member Enumeration Documentation

enum Supernovae::UpdateState

Used for keeping for track of the download/update status.

Enumerator
Updating	Update in progress.
CompleteNoUpdates	Update completed, there we no updates.
CompleteUpdates	Update completed, there were updates.
DownloadError	Error during download phase.
OtherError	Other error.

Definition at line 67 of file Supernovae.hpp.

Member Function Documentation

virtual bool Supernovae::configureGui ( bool  show = true )

virtual

Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.

Reimplemented from StelModule.

virtual void Supernovae::deinit ( )

virtual

Called before the module will be deleted, and before the renderer is destroyed.

Deinitialize all textures in this method.

Reimplemented from StelModule.

void Supernovae::displayMessage ( const QString &  message, const QString  hexColor = "#999999"  )

slot

Display a message. This is used for plugin-specific warnings and such.

virtual void Supernovae::draw ( StelCore *  core, class StelRenderer *  renderer  )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing
renderer	Renderer to draw with.

Reimplemented from StelModule.

SupernovaP Supernovae::getByID

(

const QString &

id

)

get a supernova object by identifier

virtual double Supernovae::getCallOrder ( StelModuleActionName  actionName ) const

virtual

Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.c