Stellarium 0.12.3
List of all members | Public Member Functions | Static Public Member Functions | 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. More...
 
QString getNameI18n (void) const
 Return translated object's name. More...
 
Vec3f getInfoColor (void) const
 Get a color used to display info about the object. More...
 
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. 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)=0
 
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 ()
 
- Public Member Functions inherited from StelObject
 Q_FLAGS (InfoStringGroup) static const InfoStringGroupFlags AllInfo
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...
 
virtual SphericalRegionP getRegion () const
 Default implementation of the getRegion method. More...
 
virtual Vec3d getJ2000EquatorialPos (const StelCore *core) const =0
 Get observer-centered equatorial coordinates at equinox J2000. More...
 
Vec3d getEquinoxEquatorialPos (const StelCore *core) const
 Get observer-centered equatorial coordinate at the current equinox The frame has it's 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. More...
 
Vec3d getJ2000GalacticPos (const StelCore *core) const
 Get observer-centered galactic coordinates at equinox J2000. More...
 
Vec3d getSideralPosGeometric (const StelCore *core) const
 Get observer-centered hour angle + declination (at current equinox) It is the geometric position, i.e. More...
 
Vec3d getSideralPosApparent (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...
 
virtual float getVMagnitude (const StelCore *core, bool withExtinction=false) const
 Return object's apparent V magnitude as seen from observer. More...
 
virtual double getCloseViewFov (const StelCore *) const
 Return the best FOV in degree to use for a close view of the object. More...
 
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) More...
 
virtual double getParentSatellitesFov (const StelCore *) const
 

Static Public Member Functions

static TelescopeClientcreate (const QString &url)
 

Protected Member Functions

 TelescopeClient (const QString &name)
 
- Protected Member Functions inherited from StelObject
QString getPositionInfoString (const StelCore *core, const InfoStringGroup &flags) const
 Format the positional info string contain J2000/of date/altaz/hour angle positions 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 {
  Name = 0x00000001, CatalogNumber = 0x00000002, Magnitude = 0x00000004, RaDecJ2000 = 0x00000008,
  RaDecOfDate = 0x00000010, AltAzi = 0x00000020, Distance = 0x00000040, Size = 0x00000080,
  Extra1 = 0x00000100, Extra2 = 0x00000200, Extra3 = 0x00000400, PlainText = 0x00000800,
  HourAngle = 0x00001000, AbsoluteMagnitude = 0x00002000, GalCoordJ2000 = 0x00004000
}
 used as named bitfield flags as specifiers to filter results of getInfoString. More...
 
typedef QFlags
< InfoStringGroupFlags
InfoStringGroup
 
- Static Public Attributes inherited from StelObject
static const InfoStringGroupFlags ShortInfo = (InfoStringGroupFlags)(Name|CatalogNumber|Magnitude|RaDecJ2000)
 A pre-defined set of specifiers for the getInfoString flags argument to getInfoString. More...
 

Detailed Description

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

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.

Definition at line 53 of file TelescopeClient.hpp.

Member Function Documentation

virtual double TelescopeClient::getAngularSize ( const StelCore core) const
inlinevirtual

Return the angular radius of a circle containing the object as seen from the observer with the circle center assumed to be at getJ2000EquatorialPos().

Returns
radius in degree. This value is the apparent angular size of the object, and is independent of the current FOV.

Implements StelObject.

Definition at line 77 of file TelescopeClient.hpp.

QString TelescopeClient::getEnglishName ( void  ) const
inlinevirtual

Return object's name in english.

Implements StelObject.

Definition at line 61 of file TelescopeClient.hpp.

Vec3f TelescopeClient::getInfoColor ( void  ) const
inlinevirtual

Get a color used to display info about the object.

Reimplemented from StelObject.

Definition at line 63 of file TelescopeClient.hpp.

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

TelescopeClient supports the following InfoStringGroup flags:

  • Name
  • RaDecJ2000
  • RaDec
  • PlainText
    Parameters
    corethe StelCore object
    flagsa set of InfoStringGroup items to include in the return value.
    Returns
    a QString containing an HMTL encoded description of the Telescope.

Implements StelObject.

QString TelescopeClient::getNameI18n ( void  ) const
inlinevirtual

Return translated object's name.

Implements StelObject.

Definition at line 62 of file TelescopeClient.hpp.

QString TelescopeClient::getType ( void  ) const
inlinevirtual

Return object's type. It should be the name of the class.

Implements StelObject.

Definition at line 76 of file TelescopeClient.hpp.


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