Main class of the Quasars plugin. More...

#include <Quasars.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	setFlagShowQuasars (bool b)

bool	getFlagShowQuasars (void)

void	setFlagShowQuasarsButton (bool b)
	Define whether the button toggling quasars should be visible. More...

bool	getFlagShowQuasarsButton (void)

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 (Quasars::UpdateState state)

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

Public Member Functions
virtual void	init ()

virtual void	deinit ()

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

QuasarP	getByID (const QString &id)
	get a Quasar 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...

bool	getDisplayMode (void)

void	setDisplayMode (bool b)

QString	getMarkerColor (void)

void	setMarkerColor (QString c)

void	setEnableAtStartup (bool b)

bool	getEnableAtStartup (void)

QDateTime	getLastUpdate (void)
	get the date and time the TLE elements 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...

int	getCountQuasars (void)
	Get count of quasars from catalog. More...

Detailed Description

Main class of the Quasars plugin.

Author: Alexander Wolf

Definition at line 69 of file Quasars.hpp.

Member Enumeration Documentation

enum Quasars::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 76 of file Quasars.hpp.

Member Function Documentation

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

virtual

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

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

slot

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

QuasarP Quasars::getByID ( const QString & id )

get a Quasar object by identifier

int Quasars::getCountQuasars ( void )

inline

Get count of quasars from catalog.

Definition at line 179 of file Quasars.hpp.

QDateTime Quasars::getLastUpdate ( void )

inline

get the date and time the TLE elements were updated

Definition at line 166 of file Quasars.hpp.

int Quasars::getSecondsToUpdate ( void )

get the number of seconds till the next update

int Quasars::getUpdateFrequencyDays ( void )

inline

get the update frequency in days

Definition at line 169 of file Quasars.hpp.

bool Quasars::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 153 of file Quasars.hpp.

UpdateState Quasars::getUpdateState ( void )

inline

Get the current updateState.

Definition at line 176 of file Quasars.hpp.

void Quasars::jsonUpdateComplete ( void )

signal

emitted after a JSON update has run.

virtual QStringList Quasars::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 Quasars::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 Quasars::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 Quasars::restoreDefaults ( void )

Set up the plugin with default values.

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

void Quasars::saveSettingsToConfig ( void )

Save the settings to the main configuration file.

virtual QList<StelObjectP> Quasars::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 Quasars::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 Quasars::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 Quasars::setFlagShowQuasarsButton ( bool b )

slot

Define whether the button toggling quasars should be visible.

void Quasars::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 156 of file Quasars.hpp.

void Quasars::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 Quasars::updateStateChanged ( Quasars::UpdateState state )

signal

Parameters

state the new update state.

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

Quasars.hpp

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation