All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | List of all members
openfluid::core::Datastore Class Reference

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

#include <core/Datastore.hpp>

Public Types

typedef std::map< std::string,
DatastoreItem * > 
DataItemsById_t
 Map indexing DatastoreItems by ID. More...
 

Public Member Functions

 Datastore ()
 Creates an empty datastore. More...
 
 ~Datastore ()
 Destroys all items of the datastore. More...
 
DataItemsById_t getItems ()
 Gets all items of the datastore. More...
 
const DataItemsById_t getItems () const
 Gets all items of the datastore. More...
 
DatastoreItemgetItem (const std::string &ItemID)
 Gets the item of the datastore matching the given ID. More...
 
void addItem (const DatastoreItem *Item)
 Adds an item to the datastore. More...
 

Detailed Description

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

Member Typedef Documentation

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
ItemThe item to add.
DatastoreItem* openfluid::core::Datastore::getItem ( const std::string &  ItemID)

Gets the item of the datastore matching the given ID.

Parameters
ItemIDID 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: