Dokumentacija klase KoordinatniSistem

Dvodimenzionalni koordinatni sistem. Još...

#include <KoordinatniSistem.h>

Klasni dijagram za KoordinatniSistem:

Collaboration graph
[Objašnjenje korišćenih simbola]

Spisak svih članova.

Javni članovi

virtual ~KoordinatniSistem ()
 Destruktor uništava tačke sadržane preko pokazivača.
void dodajTacku (Tacka *pp_tacka)
 Dodaje tačku u obe zbirke.
void ispisiTacke (std::ostream &os)
 Ispis tačaka sadržanih u obe zbirke.

Zajednički javni članovi

static
KoordinatniSistem
Instance ()
 Adresa tekuće jedine instance klase [Singleton DP].
static void ReleaseInstance ()
 U nekim specifičnim slučajevima je potrebno uništiti instancu klase.

Zaštićeni članovi

 KoordinatniSistem ()
 Zaštićeni podrazumevani konstruktor [Singleton DP].
void obrisiSveTacke ()
 Briše sve sadržane tačke (prazni obe zbirke).
void dodajKopijuTacke (Tacka pv_tacka)
 Dodaje kopiju tačke u zbirku tačaka.
void dodajAdresuTacke (Tacka *pp_tacka)
 Dodaje adresu tačke u zbirku adresa tačaka.

Privatni članovi

std::priority_queue
< Tacka
kopijeTacaka
 Prioritetni red za čekanje koji čuva kopije objekata.
std::priority_queue
< Tacka *,
std::vector< Tacka * >,
Tacka::TackaGreater
adreseTacaka
 Prioritetni red za čekanje koji čuva adrese objekata.

Zajednički privatni članovi

static
KoordinatniSistem
instance = 0
 Adresa tekuće jedine instance klase [Singleton DP].
static const Tacka koordinatniPocetak
 Koordinatni početak.


Opširniji opis

Dvodimenzionalni koordinatni sistem.

Pretpostavka je da je koordinatni sistem zadužen za vođenje evidencije o postojećim tačkama, i njihovo uništavanje. Postoji tačno jedan primerak koordinatnog sistema [Singleton DP].

Beleška:
Klasa čuva tačke u dve zbirke, kako bi bila naglašena razlika između zbirki koje treba čuvaju adrese objekata i zbirki koje čuvaju kopije objekata.

Definicija je u redu 21 datoteke KoordinatniSistem.h.


Dokumentacija konstruktora i destruktora

KoordinatniSistem::~KoordinatniSistem (  )  [virtual]

Destruktor uništava tačke sadržane preko pokazivača.

Definicija je u redu 16 datoteke KoordinatniSistem.cpp.

Koristi obrisiSveTacke().

Graf poziva iz ove funkcije:

KoordinatniSistem::KoordinatniSistem (  )  [protected]

Zaštićeni podrazumevani konstruktor [Singleton DP].

Definicija je u redu 65 datoteke KoordinatniSistem.cpp.

Korisnici: Instance().

Graf funkcija koje pozivaju ovu funkciju:


Dokumentacija funkcija članica

KoordinatniSistem * KoordinatniSistem::Instance (  )  [static]

Adresa tekuće jedine instance klase [Singleton DP].

Definicija je u redu 7 datoteke KoordinatniSistem.cpp.

Koristi instance i KoordinatniSistem().

Korisnici: main().

Graf poziva iz ove funkcije:

Graf funkcija koje pozivaju ovu funkciju:

void KoordinatniSistem::ReleaseInstance (  )  [static]

U nekim specifičnim slučajevima je potrebno uništiti instancu klase.

Definicija je u redu 21 datoteke KoordinatniSistem.cpp.

Koristi instance.

Korisnici: main().

Graf funkcija koje pozivaju ovu funkciju:

void KoordinatniSistem::dodajTacku ( Tacka pp_tacka  ) 

Dodaje tačku u obe zbirke.

Parametri:
[in] pp_tacka Pokazivač na tačku koju treba dodati u zbirke.

Definicija je u redu 29 datoteke KoordinatniSistem.cpp.

Koristi dodajAdresuTacke() i dodajKopijuTacke().

Korisnici: main().

Graf poziva iz ove funkcije:

Graf funkcija koje pozivaju ovu funkciju:

void KoordinatniSistem::ispisiTacke ( std::ostream &  os  ) 

Ispis tačaka sadržanih u obe zbirke.

Parametri:
[in] os Tok u koji će biti ispisani podaci o tačkama.

Definicija je u redu 35 datoteke KoordinatniSistem.cpp.

Koristi adreseTacaka i kopijeTacaka.

Korisnici: main().

Graf funkcija koje pozivaju ovu funkciju:

void KoordinatniSistem::obrisiSveTacke (  )  [protected]

Briše sve sadržane tačke (prazni obe zbirke).

Definicija je u redu 69 datoteke KoordinatniSistem.cpp.

Koristi adreseTacaka i kopijeTacaka.

Korisnici: ~KoordinatniSistem().

Graf funkcija koje pozivaju ovu funkciju:

void KoordinatniSistem::dodajKopijuTacke ( Tacka  pv_tacka  )  [protected]

Dodaje kopiju tačke u zbirku tačaka.

Parametri:
[in] pv_tacka Tačku koju treba dodati u zbirku.

Definicija je u redu 92 datoteke KoordinatniSistem.cpp.

Koristi kopijeTacaka.

Korisnici: dodajTacku().

Graf funkcija koje pozivaju ovu funkciju:

void KoordinatniSistem::dodajAdresuTacke ( Tacka pp_tacka  )  [protected]

Dodaje adresu tačke u zbirku adresa tačaka.

Parametri:
[in] pp_tacka Pokazivač na tačku koju treba dodati u zbirku.

Definicija je u redu 97 datoteke KoordinatniSistem.cpp.

Koristi adreseTacaka.

Korisnici: dodajTacku().

Graf funkcija koje pozivaju ovu funkciju:


Dokumentacija atributa

std::priority_queue<Tacka> KoordinatniSistem::kopijeTacaka [private]

Prioritetni red za čekanje koji čuva kopije objekata.

Podrazumevana zbirka u kojoj će biti čuvane kopije je std::vector. Podrazumevano uređenje reda je less<Tacka>, tj. uređenje prema operatoru <.

Definicija je u redu 66 datoteke KoordinatniSistem.h.

Korisnici: dodajKopijuTacke(), ispisiTacke() i obrisiSveTacke().

std::priority_queue<Tacka*, std::vector<Tacka*>, Tacka::TackaGreater> KoordinatniSistem::adreseTacaka [private]

Prioritetni red za čekanje koji čuva adrese objekata.

Zbirka u kojoj će biti čuvane adrese je std::vector<Tacka*>. Uređenje reda je Tacka::TackaGreater, što je pomoćna klasa za uređenje reda prema opadajućoj udalenosti od koordinatnog početka.

Definicija je u redu 73 datoteke KoordinatniSistem.h.

Korisnici: dodajAdresuTacke(), ispisiTacke() i obrisiSveTacke().

KoordinatniSistem * KoordinatniSistem::instance = 0 [static, private]

Adresa tekuće jedine instance klase [Singleton DP].

Definicija je u redu 76 datoteke KoordinatniSistem.h.

Korisnici: Instance() i ReleaseInstance().

const Tacka KoordinatniSistem::koordinatniPocetak [static, private]

Koordinatni početak.

Definicija je u redu 79 datoteke KoordinatniSistem.h.


Dokumentacija ove klase je napravljena na osnovu sledećih datoteka:
[Tue Feb 12 11:31:54 2008] Napravljeno automatski za projekat ks_i_tacke upotrebom   doxygen 1.5.3