Naptar osztályreferencia

A naptár osztály tárolja azoknak a napoknak a dátumát,amely napok foglaltak már. Ha az osztály kap egy dátumot, akkor el kell tudnia dönteni,hogy az adott nap szabad-e. Fontos, hogy egy dátum csak egyszer szerepelhet. Ha egy adott dátumot egynél többször szeretnénk felvenni, a program hibát dob. Részletek...

`#include <Naptar.h>`

A Naptar osztály együttműködési diagramja:

## Osztályok

class | iterator

## Publikus tagfüggvények

size_t | size () const
| A tömb aktuális mérete. Részletek...
| Naptar ()
| Paraméter nélkül hívható konstruktor.
| Naptar (Datum *n)
| Konstruktor első elemmel. Részletek...
| Naptar (const char *filename)
bool | foglalt (const Datum nap)
| Megnézi, hogy egy adott dátum foglalt-e. Részletek...
bool | foglalt (int ev, int honap, int nap)
| Megnézi, hogy egy adott dátum foglalt-e. Részletek...
void | felszabadit (const Datum &nap)
| Kivesz egy Datum osztályt a tömbből. Részletek...
void | felszabadit (int ev, int honap, int nap)
| Kivesz egy Datum osztályt a tömbből. Részletek...
void | urit ()
| Kiüríti a tömböt.
void | hozzaad (Datum *n)
| Hozzáad egy új elemet a listához. Részletek...
void | hozzaad (int ev, int honap, int nap)
| Hozzáad egy új elemet a listához. Részletek...
void | printTable (int ev)
| Kiirja a megadott évre tervezett eseményeket. Részletek...
void | printTable (int ev, int honap)
| Kiirja a megadott hónapra tervezett eseményeket. Részletek...
void | exportCSV (const char *path)
| A naptár tartalmát kimenti egy CSV fájlba. Részletek...
virtual | ~Naptar ()
| Destruktor. Itt törlődik az összes elem.
iterator | begin ()
| Bejáró kezdete. Részletek...
iterator | end ()
| Bejáró vége. Részletek...
iterator | at (size_t id)
| Visszaadja az adott helyen lévő Datum iterátor-át. Részletek...
Naptar & | operator= (const Naptar &np)
| Érték adó operátor. Részletek...
| Naptar (Naptar &np)

## Privát attribútumok

Datum ** | napok
| Dinamikusan méretezett tömb. A konstruktorban jön létre és a destruktorban szűnik meg.
size_t | db
| A tömb aktuális mérete.

## Részletes leírás

A naptár osztály tárolja azoknak a napoknak a dátumát,amely napok foglaltak már. Ha az osztály kap egy dátumot, akkor el kell tudnia dönteni,hogy az adott nap szabad-e. Fontos, hogy egy dátum csak egyszer szerepelhet. Ha egy adott dátumot egynél többször szeretnénk felvenni, a program hibát dob.

Szerző
  Toldi Balázs Ádám

## Konstruktorok és destruktorok dokumentációja

## Naptar() [1/2]

Naptar::Naptar | ( | Datum * | n | ) |

Konstruktor első elemmel.

Paraméterek

  n | Az első elem

## Naptar() [2/2]

Naptar::Naptar | ( | Naptar & | np | ) |

Másoló konstruktor

Paraméterek

  np | A lemásolandó Naptár objektum

## Tagfüggvények dokumentációja

## at()

Naptar::iterator Naptar::at | ( | size_t | id | ) |

Visszaadja az adott helyen lévő Datum iterátor-át.

Paraméterek

  id | Az adott tag sorszáma

Visszatérési érték
  Az adott helyen lévő Datum iterátor-át

Megjegyzés
  Az események időrendi sorrendben vannak

## begin()

Naptar::iterator Naptar::begin | ( |  | ) |

Bejáró kezdete.

Visszatérési érték
  Bejáró kezdete

A függvény hívó gráfja:

## end()

Naptar::iterator Naptar::end | ( |  | ) |

Bejáró vége.

Visszatérési érték
  Bejáró vége

A függvény hívó gráfja:

## exportCSV()

void Naptar::exportCSV | ( | const char * | path | ) |

A naptár tartalmát kimenti egy CSV fájlba.

Paraméterek

  path | A fájl elérési útvonala

Megjegyzés
  A naptár osztály tartalmát kiírja egy CSV fájlba. A CSV táblázat oszlopai pontosvesszővel( ; ),a sorai sortöréssel vannak elválasztva.

## felszabadit() [1/2]

void Naptar::felszabadit | ( | const Datum & | nap | ) |

Kivesz egy Datum osztályt a tömbből.

Paraméterek

  nap | A Datum osztály, amit el szeretnénk távolítani

Megjegyzés
  Ha az elem nem található,akkor a tartalma változatlan marad (Viszont erőforrást igényel).

A függvény hívó gráfja:

## felszabadit() [2/2]

void Naptar::felszabadit | ( | int | ev,
|  | int | honap,
|  | int | nap
| ) |  |

Kivesz egy Datum osztályt a tömbből.

Paraméterek

  ev | A dátum éve.
  honap | A dátum hónapja.
  nap | A dátum napja.

Megjegyzés
  Ha az elem nem található,akkor a tartalma változatlan marad (Viszont erőforrást igényel).

A függvény hívási gráfja:

## foglalt() [1/2]

bool Naptar::foglalt | ( | const Datum | nap | ) |

Megnézi, hogy egy adott dátum foglalt-e.

Paraméterek

  nap | A keresett dátum

Visszatérési érték
  Logikai változó az alapján, hogy foglalt-e

A függvény hívási gráfja:
A függvény hívó gráfja:

## foglalt() [2/2]

bool Naptar::foglalt | ( | int | ev,
|  | int | honap,
|  | int | nap
| ) |  |

Megnézi, hogy egy adott dátum foglalt-e.

Paraméterek

  ev | A dátum éve.
  honap | A dátum hónapja.
  nap | A dátum napja.

Visszatérési érték
  Logikai változó az alapján, hogy foglalt-e

## hozzaad() [1/2]

void Naptar::hozzaad | ( | Datum * | n | ) |

Hozzáad egy új elemet a listához.

Paraméterek

  n | A hozzáadandó datum osztály

Figyelmeztetés
  Ha a dátum már foglalt, kivételt dob.

A függvény hívási gráfja:
A függvény hívó gráfja:

## hozzaad() [2/2]

void Naptar::hozzaad | ( | int | ev,
|  | int | honap,
|  | int | nap
| ) |  |

Hozzáad egy új elemet a listához.

Paraméterek

  ev | A dátum éve.
  honap | A dátum hónapja.
  nap | A dátum napja.

Figyelmeztetés
  Ha a dátum már foglalt, kivételt dob.

A függvény hívási gráfja:

## operator=()

Naptar& Naptar::operator= | ( | const Naptar & | np | ) |

Érték adó operátor.

Paraméterek

  np | A lemásolandó Naptár objektum

Visszatérési érték
  A lemásolt objektum

## printTable() [1/2]

void Naptar::printTable | ( | int | ev | ) |

Kiirja a megadott évre tervezett eseményeket.

Paraméterek

  ev | Az év,amely eseményeit szeretnénk kiírni

A függvény hívási gráfja:

## printTable() [2/2]

void Naptar::printTable | ( | int | ev,
|  | int | honap
| ) |  |

Kiirja a megadott hónapra tervezett eseményeket.

Paraméterek

  ev | Az év,amely eseményeit szeretnénk kiírni
  honap | A hónap,amely eseményeit szeretnénk kiírni

A függvény hívási gráfja:

## size()

size_t Naptar::size | ( |  | ) | const

A tömb aktuális mérete.

Visszatérési érték
  A tömb aktuális mérete.

Ez a dokumentáció az osztályról a következő fájlok alapján készült:

- Naptar.h
- Naptar.cpp