Channel Class Reference

#include <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 ()

Private Attributes
unsigned short	mId
std::string	mName
std::string	mAnnouncement
ChannelTab *	mTab

Detailed Description

Definition at line 28 of file channel.h.

Constructor & Destructor Documentation

Channel()

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 26 of file channel.cpp.

~Channel()

Channel::~Channel

(

)

Definition at line 36 of file channel.cpp.

Member Function Documentation

getAnnouncement()

const std::string & Channel::getAnnouncement ( ) const

inline

Get the announcement message for this channel.

Definition at line 58 of file channel.h.

getId()

int Channel::getId ( ) const

inline

Get the id associated witht his channel.

Definition at line 47 of file channel.h.

getName()

const std::string & Channel::getName ( ) const

inline

Get this channel's name.

Definition at line 52 of file channel.h.

getTab()

ChannelTab * Channel::getTab ( )

inline

Definition at line 73 of file channel.h.

setAnnouncement()

void Channel::setAnnouncement ( const std::string &  channelAnnouncement )

inline

Sets the announcement string of the channel.

Definition at line 70 of file channel.h.

setName()

void Channel::setName ( const std::string &  channelName )

inline

Sets the name of the channel.

Definition at line 64 of file channel.h.

Member Data Documentation

mAnnouncement

std::string Channel::mAnnouncement

private

Definition at line 78 of file channel.h.

mId

unsigned short Channel::mId

private

Definition at line 76 of file channel.h.

mName

std::string Channel::mName

private

Definition at line 77 of file channel.h.

mTab

ChannelTab* Channel::mTab

private

Definition at line 79 of file channel.h.

---

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

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