From cd9f9a8add02597a2998ba74b803ed3fbf81314c Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 27 Nov 2005 01:44:46 +0000 Subject: Added new documentation git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classExtensible.html | 111 +++++++++++++++++------------------ 1 file changed, 53 insertions(+), 58 deletions(-) (limited to 'docs/module-doc/classExtensible.html') diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index 516f0bf3a..4308465d9 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -1,82 +1,79 @@ - + -InspIRCd: Extensible class Reference +InspIRCd: Extensible Class Reference - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members
-

Extensible Class Reference

class Extensible is the parent class of many classes such as userrec and chanrec. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
+

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:

Inheritance graph
- - - - - - - + + + + +
[legend]
Collaboration diagram for Extensible:

Collaboration graph
- + -
[legend]
List of all members. +
[legend]
List of all members.
- - + + - - + + - - + + - - - + + + - +

Public Member Functions

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

Public Member Functions

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

bool Shrink (std::string key)
 Extend an Extensible class.
bool Shrink (std::string key)
 Shrink an Extensible class.

char * GetExt (std::string key)
 Shrink an Extensible class.
char * GetExt (std::string key)
 Get an extension item.


Private Attributes

std::map< std::string, char * > Extension_Items
 Get an extension item.

Private Attributes

std::map< std::string, char * > Extension_Items
 Private data store.

 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). +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 50 of file base.h.

Member Function Documentation

-

- +

+

- + - + - - + + - + -
bool Extensible::Extend bool Extensible::Extend ( std::string std::string  key,
char *  p
) 
- +
  @@ -88,34 +85,33 @@ 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
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.

+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 char* Extensible::GetExt ( std::string std::string  key  ) 
- +
  @@ -127,32 +123,31 @@ Get an extension item.

Parameters:
- +
key The key parameter is an arbitary string which identifies the extension data
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.
-

- +

+

- + - + -
bool Extensible::Shrink bool Extensible::Shrink ( std::string std::string  key  ) 
- +
  @@ -164,7 +159,7 @@ Shrink an Extensible class.

Parameters:
- +
key The key parameter is an arbitary string which identifies the extension data
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.

@@ -173,18 +168,19 @@ You must provide a key name. The given key name will be removed from the classes

Member Data Documentation

-

- +

+

- +
std::map<std::string,char*> Extensible::Extension_Items [private] + std::map<std::string,char*> Extensible::Extension_Items [private]
- +
  @@ -201,9 +197,8 @@ Definition at line 54 of fil

The documentation for this class was generated from the following file: -
Generated on Mon May 30 05:16:57 2005 for InspIRCd by +
Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by  -doxygen -1.3.3
+doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91