StarBlockList Class Reference

#include <starblocklist.h>

Public Member Functions
	StarBlockList (Trixel trixel)
	StarBlockList (Trixel trixel, DeepStarComponent *parent)
	~StarBlockList ()
StarBlock *	block (unsigned int i)
bool	fillToMag (float maglim)
int	getBlockCount ()
float	getFaintMag ()
long	getStarCount ()
Trixel	getTrixel ()
int	releaseBlock (StarBlock *block)
void	setStaticBlock (StarBlock *block)

Detailed Description

Maintains a list of StarBlocks that contain the stars lying in a single trixel.

Takes care of the dynamic loading of stars

Author

Akarsh Simha

Version

0.1

Definition at line 36 of file starblocklist.h.

Constructor & Destructor Documentation

StarBlockList::StarBlockList ( Trixel  trixel )

explicit

Constructor.

StarBlockList::StarBlockList	(	Trixel	trixel,
		DeepStarComponent *	parent
	)

Constructor for deep star catalogs.

Parameters

trixel	The trixel ID
parent	Pointer to the parent DeepStarComponent

Definition at line 27 of file starblocklist.cpp.

StarBlockList::~StarBlockList

(

)

Destructor.

Definition at line 37 of file starblocklist.cpp.

Member Function Documentation

StarBlock* StarBlockList::block ( unsigned int  i )

inline

Returns the i-th block in this StarBlockList.

Parameters

Index

of the required block

Returns

The StarBlock requested for, NULL if index out of bounds

Definition at line 88 of file starblocklist.h.

bool StarBlockList::fillToMag

(

float

maglim

)

Ensures that the list is loaded with stars to given magnitude limit.

Parameters

Magnitude

limit to load stars upto

Returns

true on success, false on failure (data file not found, bad seek etc)

Definition at line 66 of file starblocklist.cpp.

int StarBlockList::getBlockCount ( )

inline

Returns the total number of blocks in theis StarBlockList.

Returns

Number of blocks in this StarBlockList

Definition at line 100 of file starblocklist.h.

float StarBlockList::getFaintMag ( )

inline

Returns the magnitude of the faintest star currently stored.

Returns

Magnitude of faintest star stored in this StarBlockList

Definition at line 106 of file starblocklist.h.

long StarBlockList::getStarCount ( )

inline

Returns the total number of stars in this StarBlockList.

Returns

Total number of stars in this StarBlockList

Definition at line 94 of file starblocklist.h.

Trixel StarBlockList::getTrixel ( )

inline

Returns the trixel that this SBL is meant for.

Returns

The value of trixel

Definition at line 112 of file starblocklist.h.

int StarBlockList::releaseBlock

(

StarBlock *

block

)

Drops the StarBlock with the given pointer from the list.

Parameters

Pointer

to the StarBlock to remove

Returns

Number of entries removed from the QList

Definition at line 43 of file starblocklist.cpp.

void StarBlockList::setStaticBlock

(

StarBlock *

block

)

Sets the first StarBlock in the list to point to the given StarBlock.

This function must ideally be used only once. Also, it does not make a copy of the StarBlock supplied, but uses the pointer directly. StarBlockList will take care of deleting the StarBlock when it is destroyed

Parameters

Pointer

to the StarBlock

Definition at line 151 of file starblocklist.cpp.

---

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

• starblocklist.h
• starblocklist.cpp