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

#include <Novae.hpp>

Inheritance diagram for Novae:

Collaboration diagram for Novae:

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

Public Types inherited from StelModule
enum	StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
	Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...

enum	StelModuleActionName { ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves, ActionHandleKeys }
	Define the possible action for which an order is defined. 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)

void	reloadCatalog (void)

Signals
void	updateStateChanged (Novae::UpdateState state)

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

Public Member Functions
virtual void	init ()
	Initialize itself. More...

virtual void	update (double)
	Update the module with respect to the time. More...

virtual void	draw (StelCore *core)
	Execute all the drawing functions for this module. More...

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

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	listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const
	Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...

virtual QStringList	listAllObjects (bool inEnglish) const
	List all StelObjects. More...

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...

Public Member Functions inherited from StelObjectModule
virtual QStringList	listAllObjectsByType (const QString &objType, bool inEnglish) const
	List all StelObjects by type. More...

bool	matchObjectName (const QString &objName, const QString &objPrefix, bool useStartOfWords) const
	Auxiliary method of listMatchingObjects() More...

Public Member Functions inherited from StelModule
virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...

virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

virtual void	handleMouseClicks (class QMouseEvent *)
	Handle mouse clicks. More...

virtual void	handleMouseWheel (class QWheelEvent *)
	Handle mouse wheel. More...

virtual bool	handleMouseMoves (int x, int y, Qt::MouseButtons b)
	Handle mouse moves. More...

virtual void	handleKeys (class QKeyEvent *e)
	Handle key events. More...

virtual bool	handlePinch (qreal scale, bool started)
	Handle pinch gesture events. More...

Additional Inherited Members
Protected Member Functions inherited from StelModule
class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject target, const char slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to slot) to the StelActionMgr object. More...

class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to own slot) to the StelActionMgr object. 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.

Reimplemented from StelModule.

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

slot

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

virtual void Novae::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

NovaP Novae::getByID ( const QString & id )

get a nova object by identifier

virtual double Novae::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.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations.

Parameters

actionName the name of the action for which we want the call order

Returns: the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

int Novae::getCountNovae ( void )

inline

Get count of novae from catalog.

Definition at line 164 of file Novae.hpp.

QDateTime Novae::getLastUpdate ( void )

inline

Get the date and time the novae were updated.

Definition at line 145 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 148 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 139 of file Novae.hpp.

UpdateState Novae::getUpdateState ( void )

inline

Get the current updateState.

Definition at line 155 of file Novae.hpp.

virtual void Novae::init ( )

virtual

Initialize itself.

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.

void Novae::jsonUpdateComplete ( void )

signal

Emitted after a JSON update has run.

virtual QStringList Novae::listAllObjects ( bool inEnglish ) const

virtual

List all StelObjects.

Parameters

inEnglish list names in English (true) or translated (false)

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

Implements StelObjectModule.

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

virtual

Find and return the list of at most maxNbItem objects auto-completing the passed object 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

Reimplemented from 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 142 of file Novae.hpp.

virtual void Novae::update ( double deltaTime )

inlinevirtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Definition at line 87 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:

/home/aw/devel/stellarium/0.15/plugins/Novae/src/Novae.hpp

Public Types

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation