Stellarium  0.21.1
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
TelescopeClient Class Referenceabstract

An abstract base class that should never be used directly, only inherited. More...

#include <TelescopeClient.hpp>

Public Member Functions

QString getEnglishName (void) const
 Return object's name in english.
QString getNameI18n (void) const
 Return translated object's name.
Vec3f getInfoColor (void) const
 Get a color used to display info about the object.
QString getInfoString (const StelCore *core, const InfoStringGroup &flags) const
 TelescopeClient supports the following InfoStringGroup flags: More...
QString getType (void) const
 Return object's type. It should be the name of the class.
QString getID () const
 Returns a unique identifier for this object. More...
virtual double getAngularSize (const StelCore *) 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 void telescopeGoto (const Vec3d &j2000Pos, StelObjectP selectObject)=0
virtual void telescopeSync (const Vec3d &j2000Pos, StelObjectP selectObject)=0
virtual void telescopeAbortSlew ()
virtual void move (double angle, double speed)
 move More...
virtual bool isConnected (void) const =0
virtual bool hasKnownPosition (void) const =0
void addOcular (double fov)
const QList< double > & getOculars (void) const
virtual bool prepareCommunication ()
virtual void performCommunication ()
virtual QWidget * createControlWidget (QSharedPointer< TelescopeClient > telescope, QWidget *parent=Q_NULLPTR) const
- Public Member Functions inherited from StelObject
virtual SphericalRegionP getRegion () const
 Default implementation of the getRegion method. More...
virtual Vec3d getPointInRegion () const
 Default implementation of the getPointInRegion method. More...
virtual QVariantMap getInfoMap (const StelCore *core) const
 Return a key/value map with data about an object's position, magnitude and so on. More...
virtual Vec3d getJ2000EquatorialPos (const StelCore *core) const =0
 Get observer-centered equatorial coordinates at equinox J2000.
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...
Vec3f getRTSTime (StelCore *core) const
 Get today's time of rise, transit and set for celestial object for current location. More...
virtual float getVMagnitude (const StelCore *core) const
 Return object's apparent V magnitude as seen from observer, without including extinction.
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 float getAirmass (const StelCore *core) const
 Return airmass value for the object (for atmosphere-dependent calculations) More...

Static Public Member Functions

static TelescopeClientcreate (const QString &url)

Static Public Attributes

- Static Public Attributes inherited from StelObject
static const InfoStringGroupFlags AllInfo
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...
static const InfoStringGroupFlags ShortInfo = static_cast<InfoStringGroupFlags>(Name|CatalogNumber|Magnitude|RaDecJ2000)
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString.

Protected Member Functions

 TelescopeClient (const QString &name)
virtual QString getTelescopeInfoString (const StelCore *core, const InfoStringGroup &flags) const
- 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...
void postProcessInfoString (QString &str, const InfoStringGroup &flags) const
 Apply post processing on the info string. More...

Protected Attributes

QString nameI18n
const QString name

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,
  Script = 0x00800000, DebugAid = 0x01000000, NoFont = 0x02000000, PlainText = 0x04000000
 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...

Detailed Description

This class used to be called Telescope, but it has been renamed to TelescopeClient in order to resolve a compiler/linker conflict with the identically named Telescope class in Stellarium's main code.

Member Function Documentation

◆ getAngularSize()

virtual double TelescopeClient::getAngularSize ( const StelCore core) const
radius in degree. This value is the apparent angular size of the object, and is independent of the current FOV.

Implements StelObject.

◆ getID()

QString TelescopeClient::getID ( ) const

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

QString TelescopeClient::getInfoString ( const StelCore core,
const InfoStringGroup &  flags 
) const
  • Name
  • RaDecJ2000
  • RaDec
  • PlainText
    corethe StelCore object
    flagsa set of InfoStringGroup items to include in the return value.
    a QString containing an HMTL encoded description of the Telescope.

Implements StelObject.

◆ move()

virtual void TelescopeClient::move ( double  angle,
double  speed 

Reimplemented in TelescopeClientASCOM, and TelescopeClientINDI.