SkyObjItem Class Reference

#include <skyobjitem.h>

Public Types
enum	SkyObjectRoles { DispNameRole = Qt::UserRole + 1, CategoryRole, CategoryNameRole }
enum	Type {   Planet, Star, Constellation, Galaxy,   Cluster, Nebula }

Public Member Functions
	SkyObjItem (SkyObject *so=0)
QVariant	data (int role)
QString	getDesc () const
QString	getDescSource ()
QString	getLongName () const
float	getMagnitude () const
QString	getName () const
QString	getPosition () const
QString	getSize () const
SkyObject *	getSkyObject ()
QString	getSurfaceBrightness () const
int	getType () const
QString	getTypeName () const
QHash< int, QByteArray >	roleNames () const
void	setPosition (SkyObject *so)

Detailed Description

Represents an item in the list of interesting sky-objects.

Author

Samikshan Bairagya

Definition at line 29 of file skyobjitem.h.

Member Enumeration Documentation

enum SkyObjItem::SkyObjectRoles

User-defined role for the SkyObjItem.

Enumerator
DispNameRole
CategoryRole
CategoryNameRole

Definition at line 36 of file skyobjitem.h.

enum SkyObjItem::Type

The type classification for the SkyObjItem.

Enumerator
Planet
Star
Constellation
Galaxy
Cluster
Nebula

Definition at line 42 of file skyobjitem.h.

Constructor & Destructor Documentation

SkyObjItem::SkyObjItem

(

SkyObject *

so = 0

)

Constructor.

Parameters

so	Pointer to the SkyObject which the SkyObjItem represents.

Definition at line 25 of file skyobjitem.cpp.

Member Function Documentation

QVariant SkyObjItem::data

(

int

role

)

Get data associated with a particular role for the SkyObjItem.

Parameters

role	User-defined role for which data is required

Returns

QVariant data associated with role

Definition at line 56 of file skyobjitem.cpp.

QString SkyObjItem::getDesc

(

)

const

Get description for the SkyObjItem.

Returns

Description for the SkyObjItem as a QString.

Definition at line 93 of file skyobjitem.cpp.

QString SkyObjItem::getDescSource

(

)

Get source of description for the SkyObjItem.

Returns

Source of description for the SkyObjItem as a QString.

Definition at line 127 of file skyobjitem.cpp.

QString SkyObjItem::getLongName ( ) const

inline

Get longname of sky-object associated with the SkyObjItem.

Returns

Longname of sky-object associated with the SkyObjItem as a QString

Definition at line 73 of file skyobjitem.h.

float SkyObjItem::getMagnitude ( ) const

inline

Get magnitude of sky-object associated with the SkyObjItem.

Returns

Magnitude of sky-object associated with the SkyObjItem.

Definition at line 115 of file skyobjitem.h.

QString SkyObjItem::getName ( ) const

inline

Get name of sky-object associated with the SkyObjItem.

Returns

Name of sky-object associated with the SkyObjItem as a QString

Definition at line 67 of file skyobjitem.h.

QString SkyObjItem::getPosition ( ) const

inline

Get current position of sky-object associated with the SkyObjItem.

Returns

Current position of sky-object associated with the SkyObjItem.

Definition at line 91 of file skyobjitem.h.

QString SkyObjItem::getSize

(

)

const

Get size of sky-object associated with the SkyObjItem as a QString to be displayed on the details-view.

Returns

Size of sky-object associated with the SkyObjItem as a QString.

Definition at line 159 of file skyobjitem.cpp.

SkyObject* SkyObjItem::getSkyObject ( )

inline

Get sky-object associated with the SkyObjItem.

Returns

Pointer to SkyObject associated with the SkyObjItem.

Definition at line 97 of file skyobjitem.h.

QString SkyObjItem::getSurfaceBrightness

(

)

const

Get surface-brightness of sky-object associated with the SkyObjItem as a QString to be displayed on the details-view.

Returns

Surface-brightness of sky-object associated with the SkyObjItem as a QString.

Surface Brightness is applicable only for extended light sources like Deep-Sky Objects. Here we use the formula SB = m + log10(a*b/4) where m is the magnitude of the sky-object. a and b are the major and minor axis lengths of the objects respectively in arcminutes. SB is the surface brightness obtained in mag * arcminutes^-2

Definition at line 137 of file skyobjitem.cpp.

int SkyObjItem::getType ( ) const

inline

Get category of sky-object associated with the SkyObjItem as an integer.

Returns

Category of sky-object associated with the SkyObjItem as a QString as an integer.

Definition at line 85 of file skyobjitem.h.

QString SkyObjItem::getTypeName ( ) const

inline

Get category of sky-object associated with the SkyObjItem as a QString.

Returns

Category of sky-object associated with the SkyObjItem as a QString.

Definition at line 79 of file skyobjitem.h.

QHash< int, QByteArray > SkyObjItem::roleNames

(

)

const

Create and return a QHash<int, QByteArray> of rolenames for the SkyObjItem.

Returns

QHash<int, QByteArray> of rolenames for the SkyObjItem.

Definition at line 71 of file skyobjitem.cpp.

void SkyObjItem::setPosition

(

SkyObject *

so

)

Set current position of the sky-object in the sky.

Parameters

so	Pointer to SkyObject for which position information is required.

Definition at line 80 of file skyobjitem.cpp.

---

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

• skyobjitem.h
• skyobjitem.cpp