ObjList Class Reference
An object list class.
More...
#include <yateclass.h>
List of all members.
Detailed Description
An object list class.
A simple single-linked object list handling class
Constructor & Destructor Documentation
Creates a new, empty list.
Destroys the list and everything in it.
Member Function Documentation
virtual void* getObject |
( |
const String & |
name |
) |
const [virtual] |
Get a pointer to a derived class given that class name
- Parameters:
-
| name | Name of the class we are asking for |
- Returns:
- Pointer to the requested class or NULL if this object doesn't implement it
Reimplemented from GenObject.
unsigned int length |
( |
|
) |
const |
Get the number of elements in the list
- Returns:
- Count of items
unsigned int count |
( |
|
) |
const |
Get the number of non-null objects in the list
- Returns:
- Count of items
Get the object associated to this list item
- Returns:
- Pointer to the object or NULL
Set the object associated to this list item
- Parameters:
-
| obj | Pointer to the new object to set |
| delold | True to delete the old object (default) |
- Returns:
- Pointer to the old object if not destroyed
Get the next item in the list
- Returns:
- Pointer to the next item in list or NULL
Get the last item in the list
- Returns:
- Pointer to the last item in list
Advance in the list skipping over NULL holding items
- Returns:
- Pointer to the next non NULL holding item in list or NULL
Get the object at a specific index in list
- Parameters:
-
| index | Index of the object to retrieve |
- Returns:
- Pointer to the object or NULL
ObjList* operator+ |
( |
int |
index |
) |
const |
Pointer-like indexing operator
- Parameters:
-
| index | Index of the list item to retrieve |
- Returns:
- Pointer to the list item or NULL
GenObject* operator[] |
( |
signed int |
index |
) |
const [inline] |
Array-like indexing operator with signed parameter
- Parameters:
-
| index | Index of the object to retrieve |
- Returns:
- Pointer to the object or NULL
GenObject* operator[] |
( |
unsigned int |
index |
) |
const [inline] |
Array-like indexing operator with unsigned parameter
- Parameters:
-
| index | Index of the object to retrieve |
- Returns:
- Pointer to the object or NULL
Array-like indexing operator
- Parameters:
-
| str | String value of the object to locate |
- Returns:
- Pointer to the object or NULL
Get the item in the list that holds an object
- Parameters:
-
| obj | Pointer to the object to search for |
- Returns:
- Pointer to the found item or NULL
Get the item in the list that holds an object by String value
- Parameters:
-
| str | String value (toString) of the object to search for |
- Returns:
- Pointer to the found item or NULL
Get the position in list of a GenObject by a pointer to it
- Parameters:
-
| obj | Pointer to the object to search for |
- Returns:
- Index of object in list, -1 if not found
int index |
( |
const String & |
str |
) |
const |
Get the position in list of the first GenObject with a given value
- Parameters:
-
| str | String value (toString) of the object to search for |
- Returns:
- Index of object in list, -1 if not found
Insert an object at this point
- Parameters:
-
| obj | Pointer to the object to insert |
| compact | True to replace NULL values in list if possible |
- Returns:
- A pointer to the inserted list item
Append an object to the end of the list
- Parameters:
-
| obj | Pointer to the object to append |
| compact | True to replace NULL values in list if possible |
- Returns:
- A pointer to the inserted list item
Delete this list item
- Parameters:
-
| delobj | True to delete the object (default) |
- Returns:
- Pointer to the object if not destroyed
Delete the list item that holds a given object
- Parameters:
-
| obj | Object to search in the list |
| delobj | True to delete the object (default) |
- Returns:
- Pointer to the object if not destroyed
Delete the first list item that holds an object with a iven value
- Parameters:
-
| str | String value (toString) of the object to remove |
| delobj | True to delete the object (default) |
- Returns:
- Pointer to the object if not destroyed
Clear the list and optionally delete all contained objects
bool autoDelete |
( |
|
) |
[inline] |
Get the automatic delete flag
- Returns:
- True if will delete on destruct, false otherwise
void setDelete |
( |
bool |
autodelete |
) |
[inline] |
Set the automatic delete flag
- Parameters:
-
| autodelete | True to delete on destruct, false otherwise |
static const ObjList& empty |
( |
|
) |
[static] |
A static empty object list
- Returns:
- Reference to a static empty list
The documentation for this class was generated from the following file: