DeepSkyObject Class Reference

Provides all necessary information about a deep-sky object: data inherited from SkyObject (coordinates, type, magnitude, 2 names, and URLs) and data specific to DeepSkyObjects (common name, angular size, position angle, Image, catalog). More...

#include <deepskyobject.h>

Inheritance diagram for DeepSkyObject:

[legend]

List of all members.


Public Types
enum	CATALOG { CAT_MESSIER = 0, CAT_NGC = 1, CAT_IC = 2, CAT_UNKNOWN }
Public Member Functions
float	a (void) const
float	b (void) const
QString	catalog (void) const
	DeepSkyObject (DeepSkyObject &o)
	DeepSkyObject (int t, double r, double d, float m=0.0, QString n="unnamed", QString n2="", QString lname="", QString cat="", float a=0.0, float b=0.0, double pa=0.0, int pgc=0, int ugc=0)
	DeepSkyObject (int t=SkyObject::STAR, dms r=dms(0.0), dms d=dms(0.0), float m=0.0, QString n="unnamed", QString n2="", QString lname="", QString cat="", float a=0.0, float b=0.0, double pa=0.0, int pgc=0, int ugc=0)
void	deleteImage ()
void	drawImage (QPainter &psky, int x, int y, double PositionAngle, double zoom, double scale=1.0)
void	drawSymbol (QPainter &psky, int x, int y, double PositionAngle, double zoom, double scale=1.0)
float	e (void) const
QImage *	image () const
bool	isCatalogIC () const
bool	isCatalogM () const
bool	isCatalogNGC () const
bool	isCatalogNone () const
virtual double	pa () const
int	pgc (void) const
QImage *	readImage ()
void	setCatalog (const QString &s)
virtual void	showPopupMenu (KSPopupMenu *pmenu, QPoint pos)
int	ugc (void) const
	~DeepSkyObject ()

Detailed Description

Provides all necessary information about a deep-sky object: data inherited from SkyObject (coordinates, type, magnitude, 2 names, and URLs) and data specific to DeepSkyObjects (common name, angular size, position angle, Image, catalog).

Information about a "dep-sky" object; i.e., anything that's not a solar system body or a star.

Author:: Jason Harris

Version:: 1.0

Definition at line 42 of file deepskyobject.h.

Member Enumeration Documentation

enum DeepSkyObject::CATALOG

The catalog ID of the DeepSkyObject.

Enumerator:

CAT_MESSIER
CAT_NGC
CAT_IC
CAT_UNKNOWN

Definition at line 99 of file deepskyobject.h.

Constructor & Destructor Documentation

DeepSkyObject::DeepSkyObject	(	int	t = `SkyObject::STAR`,
		dms	r = `dms(0.0)`,
		dms	d = `dms(0.0)`,
		float	m = `0.0`,
		QString	n = `"unnamed"`,
		QString	n2 = `""`,
		QString	lname = `""`,
		QString	cat = `""`,
		float	a = `0.0`,
		float	b = `0.0`,
		double	pa = `0.0`,
		int	pgc = `0`,
		int	ugc = `0`
	)

Constructor.

Create DeepSkyObject with data according to arguments.

Parameters:

	t	Type of object
	r	catalog Right Ascension
	d	catalog Declination
	m	magnitude (brightness)
	n	Primary name
	n2	Secondary name
	lname	Long name (common name)
	cat	catalog ID
	a	major axis (arcminutes)
	b	minor axis (arcminutes)
	pa	position angle (degrees)
	pgc	PGC catalog number
	ugc	UGC catalog number

Definition at line 43 of file deepskyobject.cpp.

DeepSkyObject::DeepSkyObject	(	int	t,
		double	r,
		double	d,
		float	m = `0.0`,
		QString	n = `"unnamed"`,
		QString	n2 = `""`,
		QString	lname = `""`,
		QString	cat = `""`,
		float	a = `0.0`,
		float	b = `0.0`,
		double	pa = `0.0`,
		int	pgc = `0`,
		int	ugc = `0`
	)

Constructor.

Create DeepSkyObject with data according to arguments. Differs from above function only in data type of RA and Dec.

Parameters:

	t	Type of object
	r	catalog Right Ascension
	d	catalog Declination
	m	magnitude (brightness)
	n	Primary name
	n2	Secondary name
	lname	Long name (common name)
	cat	catalog ID
	a	major axis (arcminutes)
	b	minor axis (arcminutes)
	pa	position angle (degrees)
	pgc	PGC catalog number
	ugc	UGC catalog number

Definition at line 56 of file deepskyobject.cpp.

DeepSkyObject::DeepSkyObject ( DeepSkyObject & o )

Copy constructor.

Parameters:

o

SkyObject from which to copy data

Definition at line 32 of file deepskyobject.cpp.

DeepSkyObject::~DeepSkyObject ( ) [inline]

Destructor.

Definition at line 94 of file deepskyobject.h.

Member Function Documentation

float DeepSkyObject::a ( void ) const [inline]

Returns:: the object's major axis length, in arcminute.

Definition at line 120 of file deepskyobject.h.

float DeepSkyObject::b ( void ) const [inline]

Returns:: the object's minor axis length, in arcminutes.

Definition at line 124 of file deepskyobject.h.

QString DeepSkyObject::catalog ( void ) const

Returns:: a QString identifying the object's primary catalog.

Warning:

this is only used for deep-sky objects. Possible values are:

"M" for Messier catalog
"NGC" for NGC catalog
"IC" for IC catalog
empty string is presumed to be an object in a custom catalog

Definition at line 74 of file deepskyobject.cpp.

void DeepSkyObject::deleteImage ( )

delete the Image pointer, and set it to 0.

Definition at line 102 of file deepskyobject.cpp.

void DeepSkyObject::drawImage	(	QPainter &	psky,
		int	x,
		int	y,
		double	PositionAngle,
		double	zoom,
		double	scale = `1.0`
	)

Draw the Object's image on the map.

Definition at line 226 of file deepskyobject.cpp.

void DeepSkyObject::drawSymbol	(	QPainter &	psky,
		int	x,
		int	y,
		double	PositionAngle,
		double	zoom,
		double	scale = `1.0`
	)

Draw the object's symbol on the map.

Definition at line 104 of file deepskyobject.cpp.

float DeepSkyObject::e ( void ) const

Returns:: the object's aspect ratio (MinorAxis/MajorAxis). Returns 1.0 if the object's MinorAxis=0.0.

Definition at line 69 of file deepskyobject.cpp.

QImage* DeepSkyObject::image ( ) const [inline]

Returns:: pointer to the object's inline image. If it is currently a null pointer, it loads the image from disk.

Definition at line 151 of file deepskyobject.h.

bool DeepSkyObject::isCatalogIC ( ) const [inline]

Returns:: true if the object is in the IC catalog

Definition at line 167 of file deepskyobject.h.

bool DeepSkyObject::isCatalogM ( ) const [inline]

Returns:: true if the object is in the Messier catalog

Definition at line 159 of file deepskyobject.h.

bool DeepSkyObject::isCatalogNGC ( ) const [inline]

Returns:: true if the object is in the NGC catalog

Definition at line 163 of file deepskyobject.h.

bool DeepSkyObject::isCatalogNone ( ) const [inline]

Returns:: true if the object is not in a catalog

Definition at line 171 of file deepskyobject.h.

virtual double DeepSkyObject::pa ( ) const [inline, virtual]

Returns:: the object's position angle, meausred clockwise from North.

Reimplemented from SkyObject.

Definition at line 133 of file deepskyobject.h.

int DeepSkyObject::pgc ( void ) const [inline]

Returns:: the object's PGC catalog number. Return 0 if the object is not in PGC.

Definition at line 141 of file deepskyobject.h.

QImage * DeepSkyObject::readImage ( void )

Read in this object's image from disk, unless it already exists in memory.

Returns:: pointer to newly-created image.

Definition at line 88 of file deepskyobject.cpp.

void DeepSkyObject::setCatalog ( const QString & s )

Set the internal Catalog value according to the QString argument: "M" : CAT_MESSIER "NGC" : CAT_NGC "IC" : CAT_IC.

Definition at line 81 of file deepskyobject.cpp.

virtual void DeepSkyObject::showPopupMenu	(	KSPopupMenu *	pmenu,
		QPoint	pos
	)			`[inline, virtual]`

Show Deep-sky object popup menu.

Overloaded from virtual SkyObject::showPopupMenu()

Parameters:

	pmenu	pointer to the KSPopupMenu object
	pos	QPojnt holding the x,y coordinates for the menu

Reimplemented from SkyObject.

Definition at line 186 of file deepskyobject.h.

int DeepSkyObject::ugc ( void ) const [inline]

Returns:: the object's UGC catalog number. Return 0 if the object is not in UGC.

Definition at line 137 of file deepskyobject.h.

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

kstars

DeepSkyObject Class Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kstars

API Reference