Channel Class Reference

#include <channel.h>

List of all members.

---

Detailed Description

Definition at line 29 of file channel.h.

Public Member Functions
	Channel (short id, const std::string &name, const std::string &announcement=std::string())
	Constructor.
	~Channel ()
int	getId () const
	Get the id associated witht his channel.
const std::string &	getName () const
	Get this channel's name.
const std::string &	getAnnouncement () const
	Get the announcement message for this channel.
void	setName (const std::string &channelName)
	Sets the name of the channel.
void	setAnnouncement (const std::string &channelAnnouncement)
	Sets the announcement string of the channel.
ChannelTab *	getTab ()
Protected Member Functions
void	setTab (ChannelTab *tab)
Private Attributes
unsigned short	mId
std::string	mName
std::string	mAnnouncement
ChannelTab *	mTab
Friends
class	ChannelTab

---

Constructor & Destructor Documentation

Channel::Channel	(	short	id,
		const std::string &	name,
		const std::string &	announcement = std::string()
	)

Constructor.

Parameters:

	id	the id associated with the channel.
	name	the name of the channel.
	announcement	a welcome message.

Definition at line 24 of file channel.cpp.

Channel::~Channel

(

)

Definition at line 34 of file channel.cpp.

---

Member Function Documentation

int Channel::getId

(

)

const [inline]

Get the id associated witht his channel.

Definition at line 48 of file channel.h.

const std::string& Channel::getName

(

)

const [inline]

Get this channel's name.

Definition at line 53 of file channel.h.

const std::string& Channel::getAnnouncement

(

)

const [inline]

Get the announcement message for this channel.

Definition at line 59 of file channel.h.

void Channel::setName

(

const std::string &

channelName

)

[inline]

Sets the name of the channel.

Definition at line 65 of file channel.h.

void Channel::setAnnouncement

(

const std::string &

channelAnnouncement

)

[inline]

Sets the announcement string of the channel.

Definition at line 71 of file channel.h.

ChannelTab* Channel::getTab

(

)

[inline]

Definition at line 74 of file channel.h.

void Channel::setTab

(

ChannelTab *

tab

)

[inline, protected]

Definition at line 78 of file channel.h.

---

Friends And Related Function Documentation

friend class ChannelTab [friend]

Definition at line 77 of file channel.h.

---

Member Data Documentation

unsigned short Channel::mId [private]

Definition at line 81 of file channel.h.

std::string Channel::mName [private]

Definition at line 82 of file channel.h.

std::string Channel::mAnnouncement [private]

Definition at line 83 of file channel.h.

ChannelTab* Channel::mTab [private]

Definition at line 84 of file channel.h.

---

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

• tmw/src/channel.h
• tmw/src/channel.cpp