Main class of the Pulsars plugin. More...

#include <Pulsars.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	setFlagShowPulsars (bool b)

bool	getFlagShowPulsars (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)

void	setFlagShowPulsarsButton (bool b)
	Define whether the button toggling pulsars should be visible. More...

bool	getFlagShowPulsarsButton (void)

Signals
void	updateStateChanged (Pulsars::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

PulsarP	getByID (const QString &id)
	get a Pulsar 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)

bool	getGlitchFlag (void)

void	setGlitchFlag (bool b)

QString	getMarkerColor (bool mtype=true)

void	setMarkerColor (QString c, bool mtype=true)

void	setEnableAtStartup (bool b)

bool	getEnableAtStartup (void)

QDateTime	getLastUpdate (void)
	get the date and time the pulsars 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	getCountPulsars (void)
	Get count of pulsars from catalog. More...

Detailed Description

Main class of the Pulsars plugin.

Author: Alexander Wolf

Definition at line 73 of file Pulsars.hpp.

Member Enumeration Documentation

enum Pulsars::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 80 of file Pulsars.hpp.

Member Function Documentation

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

virtual

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

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

slot

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

PulsarP Pulsars::getByID ( const QString & id )

get a Pulsar object by identifier

int Pulsars::getCountPulsars ( void )

inline

Get count of pulsars from catalog.

Definition at line 185 of file Pulsars.hpp.

QDateTime Pulsars::getLastUpdate ( void )

inline

get the date and time the pulsars were updated

Definition at line 172 of file Pulsars.hpp.

int Pulsars::getSecondsToUpdate ( void )

get the number of seconds till the next update

int Pulsars::getUpdateFrequencyDays ( void )

inline

get the update frequency in days

Definition at line 175 of file Pulsars.hpp.

bool Pulsars::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 154 of file Pulsars.hpp.

UpdateState Pulsars::getUpdateState ( void )

inline

Get the current updateState.

Definition at line 182 of file Pulsars.hpp.

void Pulsars::jsonUpdateComplete ( void )

signal

emitted after a JSON update has run.

virtual QStringList Pulsars::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 Pulsars::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 Pulsars::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 Pulsars::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 pulsars.json file from the resource embedded in the plugin lib/dll file.

void Pulsars::saveSettingsToConfig ( void )

Save the settings to the main configuration file.

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

slot

Define whether the button toggling pulsars should be visible.

void Pulsars::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 157 of file Pulsars.hpp.

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

signal

Parameters

state the new update state.

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

Pulsars.hpp

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation