Dokumentace třídy BaseLayer

[BaseLayer example] ...

#include <baselayer.h>

Diagram dědičnosti pro třídu BaseLayer

Veřejné metody
	BaseLayer ()
virtual uint32_t	Up (char *data, uint32_t len)
virtual uint32_t	Down (char *data, uint32_t len)
virtual BaseLayer &	operator+= (BaseLayer &bl)
BaseLayer *	getDown (void) const

Chráněné metody
void	setUp (BaseLayer *p)
void	setDown (BaseLayer *p)

Detailní popis

Od této třídy budeme dále odvozovat ostatní.

Použití virtuálních metod umožňuje polymorfizmus. Pokud v odvozené třídě přetížíme nějakou virtuální metodu, bude se používat ta přetížená, polud ne, použije se ta virtuální. Třída nemá *.cpp, všechny metody jsou jednoduché a tedy inline.

Dokumentace konstruktoru a destruktoru

BaseLayer::BaseLayer ( )

inline

Konstruktor

Dokumentace k metodám

virtual uint32_t BaseLayer::Down ( char *  data, uint32_t  len  )

inlinevirtual

Virtuální metoda, přesouvající data směrem dolů, pokud s nimi nechceme dělat něco jiného.

Parametry

data	ukazatel na pole dat
len	delka dat v bytech

Návratová hodnota

počet přenesených bytů

Reimplementováno v GdbPacket, CDClass a Usart1.

BaseLayer* BaseLayer::getDown ( void  ) const

inline

Getter pro pDown

Návratová hodnota

pDown

virtual BaseLayer& BaseLayer::operator+= ( BaseLayer &  bl )

inlinevirtual

Zřetězení stacku

Parametry

bl	Třída, ležící pod, spodní

Návratová hodnota

Odkaz na tuto třídu (aby se to dalo řetězit)

void BaseLayer::setDown ( BaseLayer *  p )

inlineprotected

Lokální setter pro pDown

Parametry

p	Co budeme do pDown dávat

void BaseLayer::setUp ( BaseLayer *  p )

inlineprotected

Lokální setter pro pUp

Parametry

p	Co budeme do pUp dávat

virtual uint32_t BaseLayer::Up ( char *  data, uint32_t  len  )

inlinevirtual

Virtuální metoda, přesouvající data směrem nahoru, pokud s nimi nechceme dělat něco jiného.

Parametry

data	ukazatel na pole dat
len	delka dat v bytech

Návratová hodnota

počet přenesených bytů

Reimplementováno v Swdp, GdbPacket, GdbServer a TwoTop.

---

Dokumentace pro tuto třídu byla generována z následujícího souboru:

• inc/baselayer.h