From 11d19f32e1a9efbe123712f172469a6897f8e91b Mon Sep 17 00:00:00 2001 From: Mathieu Lacage Date: Thu, 29 Mar 2007 17:09:16 +0200 Subject: [PATCH] document Channel base class --- src/node/channel.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/node/channel.h b/src/node/channel.h index 2033fd880..0afb4da0b 100644 --- a/src/node/channel.h +++ b/src/node/channel.h @@ -45,7 +45,18 @@ public: void SetName(std::string); std::string GetName(void); + /** + * \returns the number of NetDevices connected to this Channel. + * + * This method must be implemented by subclasses. + */ virtual uint32_t GetNDevices (void) const = 0; + /** + * \param i index of NetDevice to retrieve + * \returns one of the NetDevices connected to this channel. + * + * This method must be implemented by subclasses. + */ virtual NetDevice *GetDevice (uint32_t i) const = 0; protected: