SkyObjItem Class Reference

#include <skyobjitem.h>

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

Public Member Functions
	SkyObjItem (SkyObject *so=nullptr)
QVariant	data (int role)
QString	getAltAz () const
QString	getDescName () const
QString	getImageURL (bool preferThumb) const
QString	getLongName () const
float	getMagnitude () const
QString	getName () const
QString	getPosition () const
QString	getRADE () const
QString	getSize () const
SkyObject *	getSkyObject ()
QString	getSummary (bool includeDescription) const
QString	getSurfaceBrightness () const
int	getType () const
QString	getTypeName () const
QString	loadObjectDescription () const
void	setPosition (SkyObject *so)

Detailed Description

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

Author

Samikshan Bairagya

Definition at line 20 of file skyobjitem.h.

Member Enumeration Documentation

SkyObjectRoles

enum SkyObjItem::SkyObjectRoles

User-defined role for the SkyObjItem.

Definition at line 27 of file skyobjitem.h.

Type

enum SkyObjItem::Type

The type classification for the SkyObjItem.

Definition at line 40 of file skyobjitem.h.

Constructor & Destructor Documentation

SkyObjItem()

SkyObjItem::SkyObjItem ( SkyObject * so = nullptr )

explicit

Constructor.

Parameters

so	Pointer to the SkyObject which the SkyObjItem represents.

Definition at line 18 of file skyobjitem.cpp.

Member Function Documentation

data()

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 57 of file skyobjitem.cpp.

getAltAz()

QString SkyObjItem::getAltAz

(

)

const

Get current Altitude and Azimuth of sky-object associated with the SkyObjItem.

Returns

Current Altitude and Azimuth of sky-object associated with the SkyObjItem.

Definition at line 255 of file skyobjitem.cpp.

getDescName()

QString SkyObjItem::getDescName ( ) 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 75 of file skyobjitem.h.

getImageURL()

QString SkyObjItem::getImageURL

(

bool

preferThumb

)

const

Definition at line 135 of file skyobjitem.cpp.

getLongName()

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 87 of file skyobjitem.h.

getMagnitude()

float SkyObjItem::getMagnitude

(

)

const

Get magnitude of sky-object associated with the SkyObjItem.

Returns

Magnitude of sky-object associated with the SkyObjItem.

Definition at line 261 of file skyobjitem.cpp.

getName()

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 69 of file skyobjitem.h.

getPosition()

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 105 of file skyobjitem.h.

getRADE()

QString SkyObjItem::getRADE

(

)

const

Get current RA/DE of sky-object associated with the SkyObjItem.

Returns

Current RA/DE of sky-object associated with the SkyObjItem.

Definition at line 250 of file skyobjitem.cpp.

getSize()

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 214 of file skyobjitem.cpp.

getSkyObject()

SkyObject * SkyObjItem::getSkyObject ( )

inline

Get sky-object associated with the SkyObjItem.

Returns

Pointer to SkyObject associated with the SkyObjItem.

Definition at line 123 of file skyobjitem.h.

getSummary()

QString SkyObjItem::getSummary

(

bool

includeDescription

)

const

Get Summary Description for the SkyObjItem.

Returns

Summary Description for the SkyObjItem as a QString.

Definition at line 175 of file skyobjitem.cpp.

getSurfaceBrightness()

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 189 of file skyobjitem.cpp.

getType()

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 99 of file skyobjitem.h.

getTypeName()

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 93 of file skyobjitem.h.

loadObjectDescription()

QString SkyObjItem::loadObjectDescription ( ) const

inline

Definition at line 229 of file skyobjitem.cpp.

setPosition()

void SkyObjItem::setPosition

(

SkyObject *

so

)

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

Moved to skyobjlistmodel.cpp.

Parameters

so	Pointer to SkyObject for which position information is required.

Definition at line 88 of file skyobjitem.cpp.

---

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

• skyobjitem.h
• skyobjitem.cpp