Extensible Class Reference

class Extensible is the parent class of many classes such as userrec and chanrec. More...

#include <base.h>

Inheritance diagram for Extensible:

[legend]Collaboration diagram for Extensible:

[legend]List of all members.

Public Member Functions
bool	Extend (std::string key, char *p)
	Extend an Extensible class.
bool	Shrink (std::string key)
	Shrink an Extensible class.
char *	GetExt (std::string key)
	Get an extension item.
void	GetExtList (std::deque< std::string > &list)
	Get a list of all extension items names.
Private Attributes
std::map< std::string, char * >	Extension_Items
	Private data store.

---

Detailed Description

class Extensible is the parent class of many classes such as userrec and chanrec.

class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage).

Definition at line 51 of file base.h.

---

Member Function Documentation

bool Extensible::Extend (  std::string  key, char *  p )

Extend an Extensible class. Parameters: key  The key parameter is an arbitary string which identifies the extension data p  This parameter is a pointer to any data you wish to associate with the object You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, Extensible::Extend will return false in this case. Returns: Returns true on success, false if otherwise

char* Extensible::GetExt (  std::string  key  )

Get an extension item. Parameters: key  The key parameter is an arbitary string which identifies the extension data Returns: If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.

void Extensible::GetExtList (  std::deque< std::string > &  list  )

Get a list of all extension items names. Parameters: list  A deque of strings to receive the list Returns: This function writes a list of all extension items stored in this object by name into the given deque and returns void.

bool Extensible::Shrink (  std::string  key  )

Shrink an Extensible class. Parameters: key  The key parameter is an arbitary string which identifies the extension data You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns: Returns true on success.

---

Member Data Documentation

std::map<std::string,char*> Extensible::Extension_Items [private]

Private data store. Definition at line 55 of file base.h.

---

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

• base.h

---