Main class of the Bright Novae plugin. More...

#include <Novae.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 (Novae::UpdateState state)

void	jsonUpdateComplete (void)
	Emitted after a JSON update has run. More...

Public Member Functions
virtual void	init ()

virtual void	update (double)

virtual void	draw (StelCore *core)

virtual void	drawPointer (StelCore *core, StelPainter &painter)

virtual double	getCallOrder (StelModuleActionName actionName) const

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, bool useStartOfWords=false) 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, bool useStartOfWords=false) 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 QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const

virtual QString	getName () const

NovaP	getByID (const QString &id)
	get a nova 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 novae 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	getNovaeList ()
	Get list of novae. More...

float	getLowerLimitBrightness ()
	Get lower limit of brightness for displayed novae. More...

int	getCountNovae (void)
	Get count of novae from catalog. More...

Detailed Description

Main class of the Bright Novae plugin.

Author: Alexander Wolf

Definition at line 67 of file Novae.hpp.

Member Enumeration Documentation

enum Novae::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 73 of file Novae.hpp.

Member Function Documentation

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

virtual

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

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

slot

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

NovaP Novae::getByID ( const QString & id )

get a nova object by identifier

int Novae::getCountNovae ( void )

inline

Get count of novae from catalog.

Definition at line 171 of file Novae.hpp.

QDateTime Novae::getLastUpdate ( void )

inline

Get the date and time the novae were updated.

Definition at line 152 of file Novae.hpp.

float Novae::getLowerLimitBrightness ( )

Get lower limit of brightness for displayed novae.

QString Novae::getNovaeList ( )

Get list of novae.

int Novae::getSecondsToUpdate ( void )

Get the number of seconds till the next update.

int Novae::getUpdateFrequencyDays ( void )

inline

Get the update frequency in days.

Definition at line 155 of file Novae.hpp.

bool Novae::getUpdatesEnabled ( void )

inline

Get whether or not the plugin will try to update catalog data from the internet.

Returns: true if updates are set to be done, false otherwise

Definition at line 146 of file Novae.hpp.

UpdateState Novae::getUpdateState ( void )

inline

Get the current updateState.

Definition at line 162 of file Novae.hpp.

void Novae::jsonUpdateComplete ( void )

signal

Emitted after a JSON update has run.

virtual QStringList Novae::listMatchingObjects	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`
	)		const

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object English name.

Parameters

objPrefix	the case insensitive first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	the autofill mode for returned objects names

Returns: a list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

virtual QStringList Novae::listMatchingObjectsI18n	(	const QString &	objPrefix,
		int	maxNbItem = `5`,
		bool	useStartOfWords = `false`
	)		const

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object I18n name.

Parameters

objPrefix	the case insensitive first letters of the searched object
maxNbItem	the maximum number of returned object names
useStartOfWords	the autofill mode for returned objects names

Returns: a list of matching object name by order of relevance, or an empty list if nothing match

Implements StelObjectModule.

void Novae::readSettingsFromConfig ( void )

Read (or re-read) settings from the main config file.

This will be called from init and also when restoring defaults (i.e. from the configuration dialog / restore defaults button).

void Novae::restoreDefaults ( void )

Set up the plugin with default values.

This means clearing out the Pulsars section in the main config.ini (if one already exists), and populating it with default values. It also creates the default novae.json file from the resource embedded in the plugin lib/dll file.

void Novae::saveSettingsToConfig ( void )

Save the settings to the main configuration file.

virtual QList<StelObjectP> Novae::searchAround	(	const Vec3d &	v,
		double	limitFov,
		const StelCore *	core
	)		const

virtual

Used to get a list of objects which are near to some position.

Parameters

v	a vector representing the position in th sky around which to search for nebulae.
limitFov	the field of view around the position v in which to search for satellites.
core	the StelCore to use for computations.

Returns: an list containing the satellites located inside the limitFov circle around position v.

Implements StelObjectModule.

virtual StelObjectP Novae::searchByName ( const QString & name ) const

virtual

Return the matching satellite if exists or NULL.

Parameters

name	The case in-sensistive standard program name

Implements StelObjectModule.

virtual StelObjectP Novae::searchByNameI18n ( const QString & nameI18n ) const

virtual

Return the matching satellite object's pointer if exists or NULL.

Parameters

nameI18n The case in-sensistive satellite name

Implements StelObjectModule.

void Novae::setUpdatesEnabled ( bool b )

inline

Set whether or not the plugin will try to update catalog data from the internet.

Parameters

b	if true, updates will be enabled, else they will be disabled

Definition at line 149 of file Novae.hpp.

void Novae::updateJSON ( void )

slot

Download JSON from web recources described in the module section of the module.ini file and update the local JSON file.

void Novae::updateStateChanged ( Novae::UpdateState state )

signal

Parameters

state the new update state.

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

Novae.hpp

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation