openfluid::core::Datastore Class Reference

Container class for holding information about additional resources relating to a project. More...

#include <core/Datastore.hpp>

List of all members.

Public Types
typedef std::map< std::string, DatastoreItem * >	DataItemsById_t
	Map indexing DatastoreItems by ID.
Public Member Functions
	Datastore ()
	Creates an empty datastore.
	~Datastore ()
	Destroys all items of the datastore.
DataItemsById_t	getItems ()
	Gets all items of the datastore.
const DataItemsById_t	getItems () const
	Gets all items of the datastore.
DatastoreItem *	getItem (const std::string &ItemID)
	Gets the item of the datastore matching the given ID.
void	addItem (const DatastoreItem *Item)
	Adds an item to the datastore.

---

Detailed Description

Container class for holding information about additional resources relating to a project.

---

Member Typedef Documentation

typedef std::map<std::string, DatastoreItem*> openfluid::core::Datastore::DataItemsById_t

Map indexing DatastoreItems by ID.

---

Constructor & Destructor Documentation

openfluid::core::Datastore::Datastore

(

)

Creates an empty datastore.

openfluid::core::Datastore::~Datastore

(

)

Destroys all items of the datastore.

---

Member Function Documentation

void openfluid::core::Datastore::addItem

(

const DatastoreItem *

Item

)

Adds an item to the datastore.

If an item already exists with the ID of the given Item, it is deleted before adding.

Parameters:

Item	The item to add.

DatastoreItem* openfluid::core::Datastore::getItem

(

const std::string &

ItemID

)

Gets the item of the datastore matching the given ID.

Parameters:

ItemID

ID of the expected item.

Returns:

The item with the given ID, or 0 if not found.

DataItemsById_t openfluid::core::Datastore::getItems

(

)

Gets all items of the datastore.

Returns:

A map of all items of the datastore.

const DataItemsById_t openfluid::core::Datastore::getItems

(

)

const

Gets all items of the datastore.

Returns:

A const map of all items of the datastore.

---

The documentation for this class was generated from the following file:

• core/Datastore.hpp