51Degrees Common C/C++  4.1

A shared functionality library that is used by 51Degrees products
Search

FiftyoneDegrees::Common::Collection< K, V > Class Template Reference abstract

Detailed Description

template<class K, class V>
class FiftyoneDegrees::Common::Collection< K, V >

A group of items accessible by index or key.

A Collection instance hands out new instances of any item requested so once they are finished with, they must be deleted. A static object is not returned, as this would require any type V to declare a default constructor in the case that the caller declares a variable before calling a get method.

Usage Example

FiftyoneDegrees::Common::Collection<string, string> *collection;
// Iterate over all indexes
for (int i = 0; i < collection->getSize(); i++) {
// Get the value for the current index
string *value = collection->getByIndex(i);
// Do something with the value
// ...
// Delete the value instance
delete value;
}
// Or get a value using it's key of type <T>
string *value = collection->getByKey("string type key");
// Do something with the value
// ...
// Delete the value instance
delete value;
Template Parameters
K - key type for the items in the collection which must be unique e.g. string is used for property meta data where the unique key is the name of the property. The type K must implement the '<' and '==' operators
V - value type for the items stored in the collection. These must be instantiatable by the collection, and should implement a public destructor as their lifetimes are not handled by the collection instance

Public Member Functions

Destructor

virtual  ~Collection ()
Dispose of any internal data.

Getters

virtual V *  getByIndex (uint32_t index)=0
Get the item from the collection at the index provided. More...
virtual V *  getByKey (K key)=0
Get the item for the key from the collection. More...
virtual uint32_t  getSize ()=0
Number of items in the underlying collection. More...

Protected Member Functions

 Collection ()
A collection can't be constructed without an inheriting class.

Member Function Documentation

◆ getByIndex()

template<class K, class V>
virtual V* FiftyoneDegrees::Common::Collection< K, V >::getByIndex ( uint32_t   index )
pure virtual

Get the item from the collection at the index provided.

Parameters
index - of the item required in the collection. Not the same as the key
Returns
a new instance of the item at the index

◆ getByKey()

template<class K, class V>
virtual V* FiftyoneDegrees::Common::Collection< K, V >::getByKey ( K   key )
pure virtual

Get the item for the key from the collection.

Parameters
key - unique key of the item required in the collection
Returns
a new instance of the item with the key

◆ getSize()

template<class K, class V>
virtual uint32_t FiftyoneDegrees::Common::Collection< K, V >::getSize ( )
pure virtual

Number of items in the underlying collection.

Returns
the number of items in the collection
The documentation for this class was generated from the following file:
On This Page

Generated by doxygen 1.8.15