A vector holding GenObjects.
More...
#include <yateclass.h>
List of all members.
Detailed Description
A vector holding GenObjects.
Simple vector class that holds objects derived from GenObject
Constructor & Destructor Documentation
ObjVector |
( |
bool |
autodelete = true | ) |
[inline, explicit] |
Constructor of a zero capacity vector
- Parameters:
-
autodelete | True to delete objects on destruct, false otherwise |
ObjVector |
( |
unsigned int |
maxLen, |
|
|
bool |
autodelete = true |
|
) |
| |
Constructor of an empty vector
- Parameters:
-
maxLen | Maximum number of objects the vector can hold |
autodelete | True to delete objects on destruct, false otherwise |
ObjVector |
( |
ObjList & |
list, |
|
|
bool |
move = true , |
|
|
unsigned int |
maxLen = 0 , |
|
|
bool |
autodelete = true |
|
) |
| |
Constructor from an object list
- Parameters:
-
list | List of objects to store in vector |
move | True to move elements from list, false to just copy the pointer |
maxLen | Maximum number of objects to put in vector, zero to put all |
autodelete | True to delete objects on destruct, false otherwise |
Destroys the vector and the objects if automatic delete is set
Member Function Documentation
unsigned int assign |
( |
ObjList & |
list, |
|
|
bool |
move = true , |
|
|
unsigned int |
maxLen = 0 |
|
) |
| |
Clear the vector and assign objects from a list
- Parameters:
-
list | List of objects to store in vector |
move | True to move elements from list, false to just copy the pointer |
maxLen | Maximum number of objects to put in vector, zero to put all |
- Returns:
- Capacity of the vector
Get the object at a specific index in vector
- Parameters:
-
index | Index of the object to retrieve |
- Returns:
- Pointer to the object or NULL
Get the automatic delete flag
- Returns:
- True if will delete objects on destruct, false otherwise
Clear the vector and optionally delete all contained objects
unsigned int count |
( |
| ) |
const |
Get the number of non-null objects in the vector
- Returns:
- Count of items
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.
Get the position in vector of a GenObject by a pointer to it
- Parameters:
-
obj | Pointer to the object to search for |
- Returns:
- Index of object in vector, -1 if not found
Get the position in vector of the first GenObject with a given value
- Parameters:
-
str | String value (toString) of the object to search for |
- Returns:
- Index of object in vector, -1 if not found
unsigned int length |
( |
| ) |
const [inline] |
Get the capacity of the vector
- Returns:
- Number of items the vector can hold
GenObject* operator[] |
( |
signed int |
index | ) |
const [inline] |
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] |
Indexing operator with unsigned parameter
- Parameters:
-
index | Index of the object to retrieve |
- Returns:
- Pointer to the object or NULL
Store an object in the vector
- Parameters:
-
obj | Object to store in vector |
index | Index of the object to store |
- Returns:
- True for success, false if index was out of bounds
Set the automatic delete flag
- Parameters:
-
autodelete | True to delete objects on destruct, false otherwise |
Retrieve and remove an object from the vector
- Parameters:
-
index | Index of the object to retrieve |
- Returns:
- Pointer to the stored object, NULL for out of bound index
The documentation for this class was generated from the following file: