Interface for a container of meta-data that can be used to track contact across multiple calls to a contact strategy, and allows attaching user specified data to the contact.
More...
#include <ContactStrategyTracking.hpp>
Interface for a container of meta-data that can be used to track contact across multiple calls to a contact strategy, and allows attaching user specified data to the contact.
Each ContactStrategy implementation should also implement the ContactStrategyTracking interface, to allow tracking contacts.
◆ ContactStrategyTracking()
Copy constructor.
- Parameters
-
tracking | [in] the tracking information to copy. |
◆ getSize()
virtual std::size_t getSize |
( |
| ) |
const |
|
virtual |
Get the number of contacts tracked currently.
- Returns
- the number of tracked contacts.
◆ getStrategyData()
Get the current strategy data.
- Returns
- pointer to StrategyData, or NULL if none set.
◆ getUserData()
virtual const UserData::Ptr getUserData |
( |
std::size_t |
index | ) |
const |
|
virtual |
Get user data for the contact with given index.
- Parameters
-
index | [in] the contact to get user data for. |
- Returns
- pointer to user data, or NULL if no user data is set.
◆ isInitialized()
virtual bool isInitialized |
( |
| ) |
const |
|
virtual |
Check whether data container has been initialized with strategy data.
- Returns
- true if initialized - NULL if not initialized, or if tracking is unsupported by strategy.
◆ operator=()
Assign data from other container to this container.
- Parameters
-
data | [in] the data to copy. |
- Returns
- reference to this container.
◆ remove()
virtual void remove |
( |
std::size_t |
index | ) |
|
|
virtual |
Remove meta-data for a specific contact.
- Parameters
-
index | [in] the contact to remove. |
◆ setStrategyData()
Set the strategy data to store for tracking purposes.
- Parameters
-
data | [in] a pointer to the strategy data. |
◆ setUserData()
virtual void setUserData |
( |
std::size_t |
index, |
|
|
const UserData::Ptr |
data |
|
) |
| |
|
virtual |
Attach user data to a given contact.
- Parameters
-
index | [in] the contact to set user data for. |
data | [in] a pointer to the data. |
The documentation for this class was generated from the following file: