Stellarium  23.4
Data Structures | Typedefs
Pulsars Plug-in

Data Structures

class  PulsarsDialog
 
class  Pulsar
 A Pulsar object represents one pulsar on the sky. More...
 
class  Pulsars
 Main class of the Pulsars plugin. More...
 

Typedefs

typedef QSharedPointer< PulsarPulsarP
 

Detailed Description

The Pulsars plugin plots the position of various pulsars, with object information about each one. Pulsar data is derived from Catalog of Pulsars (Taylor+ 1995) for 0.1.x series and derived from The ATNF Pulsar Catalogue (Manchester, R. N., Hobbs, G. B., Teoh, A. & Hobbs, M., Astron. J., 129, 1993-2006 (2005) (astro-ph/0412641)) for series 0.2.x.

Pulsars Catalog

The pulsars catalog is stored on the disk in JSON format, in a file named "pulsars.json". A default copy is embedded in the plug-in at compile time. A working copy is kept in the user data directory.

Configuration

The plug-ins' configuration data is stored in Stellarium's main configuration file (section [Pulsars]).


Data Structure Documentation

◆ PulsarsDialog

class PulsarsDialog

Public Slots

void retranslate () Q_DECL_OVERRIDE
 
void refreshUpdateValues (void)
 
- Public Slots inherited from StelDialog
virtual void styleChanged (const QString &style)
 Apply application style change.
 
virtual void retranslate ()=0
 Retranslate the content of the dialog. More...
 
virtual void setVisible (bool)
 On the first call with "true" populates the window contents.
 
virtual void close ()
 Closes the window (the window widget is not deleted, just not visible).
 
void handleMovedTo (QPoint newPos)
 Adds dialog location to config.ini; should be connected in createDialogContent()
 
virtual void handleDialogSizeChanged (QSizeF size)
 Stores dialog sizes into config.ini; should be connected from the proxy. More...
 

Protected Member Functions

void createDialogContent () Q_DECL_OVERRIDE
 Initialize the dialog widgets and connect the signals/slots.
 

Additional Inherited Members

- Signals inherited from StelDialog
void visibleChanged (bool)
 
- Public Member Functions inherited from StelDialog
 StelDialog (const QString &dialogName=QString("Default"), QObject *parent=nullptr)
 
bool visible () const
 Returns true if the dialog contents have been constructed and are currently shown.
 
QString getDialogName () const
 
- Protected Slots inherited from StelDialog
bool askConfirmation (const QString &message=q_("Are you sure? This will delete your customized data."))
 
void messageBox (const QString &title, const QString &message)
 
void enableKineticScrolling (bool b)
 enable kinetic scrolling. This should be connected to StelApp's StelGui signal flagUseKineticScrollingChanged.
 
void handleFontChanged ()
 connect from StelApp to handle font and font size changes.
 
void handleColorSchemeChanged ()
 connect from StelApp to handle CSS style changes
 
virtual void updateNightModeProperty (bool n)
 
- Static Protected Member Functions inherited from StelDialog
static void connectCheckBox (QAbstractButton *checkBox, const QString &actionName)
 Helper function to connect a checkbox to the StelAction with the specified name.
 
static void connectCheckBox (QAbstractButton *checkBox, StelAction *action)
 Helper function to connect a checkbox to the given StelAction.
 
static void connectIntProperty (QLineEdit *lineEdit, const QString &propName)
 Helper function to connect a QLineEdit to an integer StelProperty. More...
 
static void connectIntProperty (QSpinBox *spinBox, const QString &propName)
 Helper function to connect a QSpinBox to an integer StelProperty. More...
 
static void connectIntProperty (QComboBox *comboBox, const QString &propName)
 Helper function to connect a QComboBox to an integer StelProperty. More...
 
static void connectIntProperty (QSlider *slider, const QString &propName, int minValue, int maxValue)
 Helper function to connect a QSlider to an double or float StelProperty. More...
 
static void connectDoubleProperty (QDoubleSpinBox *spinBox, const QString &propName)
 Helper function to connect a QDoubleSpinBox to an double or float StelProperty. More...
 
static void connectDoubleProperty (AngleSpinBox *spinBox, const QString &propName)
 Helper function to connect an AngleSpinBox to a double or float StelProperty representing decimal degrees. More...
 
static void connectDoubleProperty (QSlider *slider, const QString &propName, double minValue, double maxValue)
 Helper function to connect a QSlider to an double or float StelProperty. More...
 
static void connectStringProperty (QComboBox *comboBox, const QString &propName)
 Helper function to connect a QComboBox to a QString StelProperty. More...
 
static void connectStringProperty (QLineEdit *lineEdit, const QString &propName)
 Helper function to connect a QLineEdit to a QString StelProperty. More...
 
static void connectBoolProperty (QAbstractButton *checkBox, const QString &propName)
 Helper function to connect a checkbox to a bool StelProperty. More...
 
static void connectBoolProperty (QGroupBox *checkBox, const QString &propName)
 Helper function to connect a groupbox to a bool StelProperty. More...
 
- Protected Attributes inherited from StelDialog
QWidget * dialog
 The main dialog.
 
class CustomProxyproxy
 
QString dialogName
 The name should be set in derived classes' constructors and can be used to store and retrieve the panel locations.
 
QList< QWidget * > kineticScrollingList
 A list of widgets where kinetic scrolling can be activated or deactivated The list must be filled once, in the constructor or init() of fillDialog() etc. More...
 
- Properties inherited from StelDialog
bool visible
 

◆ Pulsar

class Pulsar

A Pulsar object represents one pulsar on the sky.

Details about the Pulsars are passed using a QVariant which contains a map of data from the json file.

Public Member Functions

 Pulsar (const QVariantMap &map)
 
QVariantMap getMap (void) const
 Get a QVariantMap which describes the pulsar. More...
 
virtual QString getType (void) const Q_DECL_OVERRIDE
 Get the type of object.
 
virtual QString getObjectType (void) const Q_DECL_OVERRIDE
 Get the type of object.
 
virtual QString getObjectTypeI18n (void) const Q_DECL_OVERRIDE
 Return object's type. It should be translated lowercase name of the type of the object.
 
virtual QString getID (void) const Q_DECL_OVERRIDE
 Returns a unique identifier for this object. More...
 
virtual float getSelectPriority (const StelCore *core) const Q_DECL_OVERRIDE
 Return a priority value which is used to discriminate objects by priority As for magnitudes, the lower is the higher priority.
 
virtual QString getInfoString (const StelCore *core, const InfoStringGroup &flags) const Q_DECL_OVERRIDE
 Get an HTML string to describe the object. More...
 
virtual QVariantMap getInfoMap (const StelCore *core) const Q_DECL_OVERRIDE
 Return a map like StelObject::getInfoMap(), but with a few extra tags also available in getMap(), except for designation, RA and DE fields.
 
virtual Vec3f getInfoColor (void) const Q_DECL_OVERRIDE
 Get a color used to display info about the object.
 
virtual Vec3d getJ2000EquatorialPos (const StelCore *core) const Q_DECL_OVERRIDE
 Get observer-centered equatorial coordinates at equinox J2000, including aberration.
 
virtual float getVMagnitude (const StelCore *core) const Q_DECL_OVERRIDE
 Get the visual magnitude of pulsar.
 
virtual float getVMagnitudeWithExtinction (const StelCore *core) const
 
virtual QString getNameI18n (void) const Q_DECL_OVERRIDE
 Get the localized name of pulsar.
 
virtual QString getEnglishName (void) const Q_DECL_OVERRIDE
 Get the english name of pulsar.
 
QString getDesignation (void) const
 Get the designation of pulsar (based on J2000 coordinates)
 
QString getBDesignation (void) const
 Get the designation of pulsar (based on B1950 coordinates)
 
- Public Member Functions inherited from StelObject
virtual SphericalRegionP getRegion () const Q_DECL_OVERRIDE
 Default implementation of the getRegion method. More...
 
virtual Vec3d getPointInRegion () const Q_DECL_OVERRIDE
 Default implementation of the getPointInRegion method. More...
 
Vec3d getEquinoxEquatorialPos (const StelCore *core) const
 Get observer-centered equatorial coordinate at the current equinox The frame has its Z axis at the planet's current rotation axis At time 2000-01-01 this frame is almost the same as J2000, but ONLY if the observer is on earth.
 
Vec3d getEquinoxEquatorialPosApparent (const StelCore *core) const
 Like getEquinoxEquatorialPos(core), but always adds refraction correction to the position.
 
Vec3d getEquinoxEquatorialPosAuto (const StelCore *core) const
 Like getEquinoxEquatorialPos(core), but adds refraction correction to the position if atmosphere is active.
 
Vec3d getGalacticPos (const StelCore *core) const
 Get observer-centered galactic coordinates.
 
Vec3d getSupergalacticPos (const StelCore *core) const
 Get observer-centered supergalactic coordinates.
 
Vec3d getSiderealPosGeometric (const StelCore *core) const
 Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e. More...
 
Vec3d getSiderealPosApparent (const StelCore *core) const
 Get observer-centered hour angle + declination (at current equinox) It is the apparent position, i.e. More...
 
Vec3d getAltAzPosGeometric (const StelCore *core) const
 Get observer-centered alt/az position It is the geometric position, i.e. More...
 
Vec3d getAltAzPosApparent (const StelCore *core) const
 Get observer-centered alt/az position It is the apparent position, i.e. More...
 
Vec3d getAltAzPosAuto (const StelCore *core) const
 Get observer-centered alt/az position It is the automatic position, i.e. More...
 
float getParallacticAngle (const StelCore *core) const
 Get parallactic angle, which is the deviation between zenith angle and north angle. [radians].
 
bool isAboveHorizon (const StelCore *core) const
 Checking position an object above mathematical horizon for current location. More...
 
bool isAboveRealHorizon (const StelCore *core) const
 Checking position an object above real horizon for current location. More...
 
virtual Vec4d getRTSTime (const StelCore *core, const double altitude=0.) const
 Compute time of rise, transit and set for celestial object for current location. More...
 
float getVMagnitudeWithExtinction (const StelCore *core) const
 Return object's apparent V magnitude as seen from observer including extinction. More...
 
virtual double getCloseViewFov (const StelCore *) const
 Return the best FOV in degree to use for a close view of the object.
 
virtual double getSatellitesFov (const StelCore *) const
 Return the best FOV in degree to use for a global view of the object satellite system (if there are satellites)
 
virtual double getParentSatellitesFov (const StelCore *) const
 
virtual double getAngularRadius (const StelCore *core) const
 Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos(). More...
 
virtual float getAirmass (const StelCore *core) const
 Return airmass value for the object (for atmosphere-dependent calculations) More...
 

Static Public Attributes

static const QString PULSAR_TYPE
 
- Static Public Attributes inherited from StelObject
static constexpr InfoStringGroup AllInfo
 A pre-defined "all available" set of specifiers for the getInfoString flags argument to getInfoString. More...
 
static constexpr InfoStringGroup DefaultInfo
 A pre-defined "default" set of specifiers for the getInfoString flags argument to getInfoString It appears useful to propose this set as post-install settings and let users configure more on demand. More...
 
static constexpr InfoStringGroup ShortInfo = static_cast<InfoStringGroup>(Name|CatalogNumber|Magnitude|RaDecJ2000)
 A pre-defined "shortest useful" set of specifiers for the getInfoString flags argument to getInfoString.
 

Friends

class Pulsars
 

Additional Inherited Members

- Public Types inherited from StelObject
enum  InfoStringGroupFlags {
  None = 0x00000000 , Name = 0x00000001 , CatalogNumber = 0x00000002 , Magnitude = 0x00000004 ,
  RaDecJ2000 = 0x00000008 , RaDecOfDate = 0x00000010 , AltAzi = 0x00000020 , Distance = 0x00000040 ,
  Elongation = 0x00000080 , Size = 0x00000100 , Velocity = 0x00000200 , ProperMotion = 0x00000400 ,
  Extra = 0x00000800 , HourAngle = 0x00001000 , AbsoluteMagnitude = 0x00002000 , GalacticCoord = 0x00004000 ,
  SupergalacticCoord = 0x00008000 , OtherCoord = 0x00010000 , ObjectType = 0x00020000 , EclipticCoordJ2000 = 0x00040000 ,
  EclipticCoordOfDate = 0x00080000 , IAUConstellation = 0x00100000 , SiderealTime = 0x00200000 , RTSTime = 0x00400000 ,
  SolarLunarPosition = 0x00800000 , Script = 0x01000000 , DebugAid = 0x02000000 , NoFont = 0x04000000 ,
  PlainText = 0x08000000
}
 Used as named bitfield flags as specifiers to filter results of getInfoString. More...
 
- Public Slots inherited from StelObject
virtual void setExtraInfoString (const InfoStringGroup &flags, const QString &str)
 Allow additions to the Info String. More...
 
virtual void addToExtraInfoString (const StelObject::InfoStringGroup &flags, const QString &str)
 Add str to the extra string. More...
 
QStringList getExtraInfoStrings (const InfoStringGroup &flags) const
 Retrieve an (unsorted) QStringList of all extra info strings that match flags. More...
 
void removeExtraInfoStrings (const InfoStringGroup &flags)
 Remove the extraInfoStrings with the given flags. More...
 
- Protected Member Functions inherited from StelObject
QString getCommonInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Format the positional info string containing J2000/of date/altaz/hour angle positions and constellation, sidereal time, etc. More...
 
virtual QString getMagnitudeInfoString (const StelCore *core, const InfoStringGroup &flags, const int decimals=1) const
 Format the magnitude info string for the object. More...
 
QString getSolarLunarInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Add a section to the InfoString with just horizontal data for the Sun and Moon, when observed from Earth. More...
 
void postProcessInfoString (QString &str, const InfoStringGroup &flags) const
 Apply post processing on the info string. More...
 

Constructor & Destructor Documentation

◆ Pulsar()

Pulsar::Pulsar ( const QVariantMap &  map)
Parameters
idThe official designation for a pulsar, e.g. "PSR J1919+21"

Member Function Documentation

◆ getID()

virtual QString Pulsar::getID ( void  ) const
inlinevirtual

Returns a unique identifier for this object.

The ID should be unique for all objects of the same type, but may freely conflict with IDs of other types, so getType() must also be tested.

With this it should be possible to at least identify the same object in a different instance of Stellarium running the same version, but it would even be better if the ID provides some degree of forward-compatibility. For some object types (e.g. planets) this may simply return getEnglishName(), but better candidates may be official designations or at least (stable) internal IDs.

An object may have multiple IDs (different catalog numbers, etc). StelObjectMgr::searchByID() should search through all ID variants, but this method only returns one of them.

Implements StelObject.

◆ getInfoString()

virtual QString Pulsar::getInfoString ( const StelCore core,
const InfoStringGroup &  flags 
) const
virtual

Get an HTML string to describe the object.

Parameters
coreA pointer to the core @flags a set of flags with information types to include.

Implements StelObject.

◆ getMap()

QVariantMap Pulsar::getMap ( void  ) const

Get a QVariantMap which describes the pulsar.

Could be used to create a duplicate.

  • designation: pulsar name based on J2000 coordinates
  • bdesignation: pulsar name based on B1950 coordinates
  • parallax: annual parallax (mas)
  • bperiod: binary period of pulsar (days)
  • frequency: barycentric rotation frequency (Hz)
  • pfrequency: time derivative of barycentric rotation frequency (s^-2)
  • pderivative: time derivative of barcycentric period (dimensionless)
  • dmeasure: dispersion measure (pc/cm^3)
  • eccentricity
  • RA: right ascension (J2000) (hh:mm:ss.s)
  • DE: declination (J2000) (+dd:mm:ss)
  • pmRA: proper motion in the right ascension direction (mas/yr)
  • pmDE: proper motion in declination (mas/yr)
  • period: barycentric period of the pulsar (s)
  • w50: width of pulse at 50% of peak (ms). Note, pulse widths are a function of both observing frequency and observational time resolution, so quoted widths are indicative only.
  • s400: mean flux density at 400 MHz (mJy)
  • s600: mean flux density at 1400 MHz (mJy)
  • s1400: mean flux density at 2000 MHz (mJy)
  • distance: best estimate of the pulsar distance using the YMW16 DM-based distance as default (kpc)
  • glitch: number of glitches
  • notes: pulsar types

◆ Pulsars

class Pulsars

Main class of the Pulsars plugin.

Author
Alexander Wolf

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 setFlagShowPulsarsButton (bool b)
 Define whether the button toggling pulsars should be visible.
 
bool getFlagShowPulsarsButton (void)
 
void setFlagShowPulsars (bool b)
 Enable/disable display of markers of pulsars. More...
 
bool getFlagShowPulsars (void)
 Get status to display of markers of pulsars. More...
 
void setFilteredMode (bool b)
 Enable/disable display filter of pulsars. More...
 
bool getFilteredMode (void) const
 Get status to usage display filter of pulsars. More...
 
void setFilterValue (float v)
 Set value for filter. More...
 
float getFilterValue (void) const
 Get value for filter. More...
 
bool getDisplayMode (void) const
 Get status to display of distribution of pulsars. More...
 
void setDisplayMode (bool b)
 Enable/disable display of distribution of pulsars. More...
 
bool getGlitchFlag (void) const
 Get status for usage of separate color for pulsars with glitches. More...
 
void setGlitchFlag (bool b)
 Enable/disable the use of a separate color for pulsars with glitches. More...
 
Vec3f getMarkerColor () const
 Get color for pulsars markers. More...
 
void setMarkerColor (const Vec3f &c)
 Set color for pulsars markers. More...
 
Vec3f getGlitchColor () const
 Get marker color for pulsars with glitches. More...
 
void setGlitchColor (const Vec3f &c)
 Set markers color for pulsars with glitches. More...
 
int getCountPulsars (void) const
 Get count of pulsars from catalog. More...
 
void updateJSON (void)
 Download JSON from web resources described in the module section of the module.ini file and update the local JSON file.
 
void setFontSize (int s)
 Connect this to StelApp font size.
 

Signals

void updateStateChanged (Pulsars::UpdateState state)
 
void jsonUpdateComplete (void)
 emitted after a JSON update has run.
 
void flagPulsarsVisibilityChanged (bool b)
 
void flagUsingFilterChanged (bool b)
 
void markerColorChanged (Vec3f)
 
void glitchColorChanged (Vec3f)
 

Public Member Functions

virtual void init () Q_DECL_OVERRIDE
 Initialize itself. More...
 
virtual void deinit () Q_DECL_OVERRIDE
 Called before the module will be deleted, and before the OpenGL context is suppressed. More...
 
virtual void draw (StelCore *core) Q_DECL_OVERRIDE
 Execute all the drawing functions for this module. More...
 
virtual void drawPointer (StelCore *core, StelPainter &painter)
 
virtual double getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE
 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< StelObjectPsearchAround (const Vec3d &v, double limitFov, const StelCore *core) const Q_DECL_OVERRIDE
 Used to get a list of objects which are near to some position. More...
 
virtual StelObjectP searchByNameI18n (const QString &nameI18n) const Q_DECL_OVERRIDE
 Return the matching Pulsar object's pointer if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByName (const QString &name) const Q_DECL_OVERRIDE
 Return the matching Pulsar if exists or Q_NULLPTR. More...
 
virtual StelObjectP searchByID (const QString &id) const Q_DECL_OVERRIDE
 Return the matching Pulsar if exists or Q_NULLPTR. More...
 
virtual QStringList listMatchingObjects (const QString &objPrefix, int maxNbItem=5, bool useStartOfWords=false) const Q_DECL_OVERRIDE
 Find and return the list of at most maxNbItem objects auto-completing the passed object name. More...
 
virtual QStringList listAllObjects (bool inEnglish) const Q_DECL_OVERRIDE
 List all StelObjects. More...
 
virtual QString getName () const Q_DECL_OVERRIDE
 Gets a user-displayable name of the object category.
 
virtual QString getStelObjectType () const Q_DECL_OVERRIDE
 Returns the name that will be returned by StelObject::getType() for the objects this module manages.
 
PulsarP getByID (const QString &id) const
 get a Pulsar object by identifier
 
virtual bool configureGui (bool show=true) Q_DECL_OVERRIDE
 Implement this to tell the main Stellarium GUI that there is a GUI element to configure this plugin.
 
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.
 
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...
 
void setEnableAtStartup (bool b)
 
bool getEnableAtStartup (void)
 
QDateTime getLastUpdate (void)
 get the date and time the pulsars were updated
 
int getUpdateFrequencyDays (void)
 get the update frequency in days
 
void setUpdateFrequencyDays (int days)
 
int getSecondsToUpdate (void)
 get the number of seconds till the next update
 
UpdateState getUpdateState (void)
 Get the current updateState.
 
const QList< PulsarP > & getAllPulsars () const
 Get the list of all pulsars.
 
- 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
 StelModule ()
 Constructor. Every derived class MUST call setObjectName(className) in its constructor.
 
virtual QSettings * getSettings ()
 Return module-specific settings. More...
 
virtual void update (double deltaTime)
 Update the module with respect to the time. More...
 
virtual QString getModuleVersion () const
 Get the version of the module, default is stellarium main version.
 
virtual QString getAuthorName () const
 Get the name of the module author.
 
virtual QString getAuthorEmail () const
 Get the email address of the module author.
 
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...
 

Properties

bool pulsarsVisible
 
Vec3f markerColor
 
Vec3f glitchColor
 

Additional Inherited Members

- Protected Member Functions inherited from StelModule
class StelActionaddAction (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 StelActionaddAction (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...
 
StelActionaddAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="")
 convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More...
 

Member Enumeration Documentation

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

Member Function Documentation

◆ deinit()

virtual void Pulsars::deinit ( )
virtual

Called before the module will be deleted, and before the OpenGL context is suppressed.

Deinitialize all OpenGL texture in this method.

Reimplemented from StelModule.

◆ draw()

virtual void Pulsars::draw ( StelCore core)
virtual

Execute all the drawing functions for this module.

Parameters
corethe core to use for the drawing

Reimplemented from StelModule.

◆ getCallOrder()

virtual double Pulsars::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
actionNamethe 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.

◆ getCountPulsars

int Pulsars::getCountPulsars ( void  ) const
inlineslot

Get count of pulsars from catalog.

Returns
count of pulsars

◆ getDisplayMode

bool Pulsars::getDisplayMode ( void  ) const
slot

Get status to display of distribution of pulsars.

Returns
true if distribution of pulsars is enabled

◆ getFilteredMode

bool Pulsars::getFilteredMode ( void  ) const
slot

Get status to usage display filter of pulsars.

Returns
true if it's visible

◆ getFilterValue

float Pulsars::getFilterValue ( void  ) const
slot

Get value for filter.

Returns
value

◆ getFlagShowPulsars

bool Pulsars::getFlagShowPulsars ( void  )
inlineslot

Get status to display of markers of pulsars.

Returns
true if it's visible

◆ getGlitchColor

Vec3f Pulsars::getGlitchColor ( ) const
slot

Get marker color for pulsars with glitches.

Parameters
mtypeset false if you want get color of pulsars with glitches
Returns
color

◆ getGlitchFlag

bool Pulsars::getGlitchFlag ( void  ) const
slot

Get status for usage of separate color for pulsars with glitches.

Returns
true if separate color is used for pulsars with glitches

◆ getMarkerColor

Vec3f Pulsars::getMarkerColor ( ) const
slot

Get color for pulsars markers.

Parameters
mtypeset false if you want get color of pulsars with glitches
Returns
color

◆ getUpdatesEnabled()

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

◆ init()

virtual void Pulsars::init ( )
virtual

Initialize itself.

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

Implements StelModule.

◆ listAllObjects()

virtual QStringList Pulsars::listAllObjects ( bool  inEnglish) const
virtual

List all StelObjects.

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

◆ listMatchingObjects()

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

Parameters
objPrefixthe case insensitive first letters of the searched object
maxNbItemthe maximum number of returned object names
useStartOfWordsthe 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.

◆ readSettingsFromConfig()

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

◆ restoreDefaults()

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.

◆ searchAround()

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
va vector representing the position in th sky around which to search for pulsars.
limitFovthe field of view around the position v in which to search for pulsars.
corethe StelCore to use for computations.
Returns
a list containing the pulsars located inside the limitFov circle around position v.

Implements StelObjectModule.

◆ searchByID()

virtual StelObjectP Pulsars::searchByID ( const QString &  id) const
inlinevirtual

Return the matching Pulsar if exists or Q_NULLPTR.

Parameters
idThe Pulsar id

Implements StelObjectModule.

◆ searchByName()

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

Return the matching Pulsar if exists or Q_NULLPTR.

Parameters
nameThe case in-sensitive english Pulsar name

Implements StelObjectModule.

◆ searchByNameI18n()

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

Return the matching Pulsar object's pointer if exists or Q_NULLPTR.

Parameters
nameI18nThe case in-sensitive localized Pulsar name

Implements StelObjectModule.

◆ setDisplayMode

void Pulsars::setDisplayMode ( bool  b)
slot

Enable/disable display of distribution of pulsars.

Parameters
b

◆ setFilteredMode

void Pulsars::setFilteredMode ( bool  b)
slot

Enable/disable display filter of pulsars.

Parameters
bboolean flag

◆ setFilterValue

void Pulsars::setFilterValue ( float  v)
slot

Set value for filter.

Parameters
vfloat value

◆ setFlagShowPulsars

void Pulsars::setFlagShowPulsars ( bool  b)
slot

Enable/disable display of markers of pulsars.

Parameters
bboolean flag

◆ setGlitchColor

void Pulsars::setGlitchColor ( const Vec3f c)
slot

Set markers color for pulsars with glitches.

Parameters
ccolor
// example of usage in scripts

◆ setGlitchFlag

void Pulsars::setGlitchFlag ( bool  b)
slot

Enable/disable the use of a separate color for pulsars with glitches.

Parameters
booleanflag

◆ setMarkerColor

void Pulsars::setMarkerColor ( const Vec3f c)
slot

Set color for pulsars markers.

Parameters
ccolor
mtypeset false if you want set color for pulsars with glitches
// example of usage in scripts
Pulsars.setMarkerColor(Vec3f(1.0,0.0,0.0), true);

◆ setUpdatesEnabled()

void Pulsars::setUpdatesEnabled ( bool  b)
inline

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

Parameters
bif true, updates will be enabled, else they will be disabled

◆ updateStateChanged

void Pulsars::updateStateChanged ( Pulsars::UpdateState  state)
signal
Parameters
statethe new update state.