Storage Class Reference

Storage class. More...

#include <Storage.hpp>

Inheritance diagram for Storage:
Inheritance graph


class  istream
class  ostream

Public Member Functions

 Storage (StorageMode_e mode, const std::string &name, bool autoRemove=false)
 ~Storage ()
std::string getName () const
GroupgetGroup (const std::string name)
Groupoperator() (const std::string name="")
virtual void remove ()
- Public Member Functions inherited from Cell
 Cell (ICell *parent, const std::string &id)
 ~Cell ()
ICellgetParent () const
const std::string & getId () const
std::string getFullId (char sep='.') const
void setCompressLevel (int level)
int getCompressLevel () const
- Public Member Functions inherited from ICell
virtual ~ICell ()
- Public Member Functions inherited from ISmartPointer
virtual ~ISmartPointer ()
- Public Member Functions inherited from SmartPointer
void use ()
void forget ()

Protected Attributes


Additional Inherited Members

- Static Public Member Functions inherited from ICell
static ICellgetRoot (ICell *cell)
- Protected Member Functions inherited from SmartPointer
 SmartPointer ()
virtual ~SmartPointer ()

Detailed Description

Storage class.

The Storage class is the entry point for managing collections and groups.

It delegates all the actions to a root group (retrievable through an operator overload).

Such a storage is supposed to gather several information sets in a single environment, with possible hierarchical composition.

It is a template class: one should provide the actual type of the collections containers. Possible template types could be designed for:

  • classical file system
  • HDF5 files
  • memory

Constructor & Destructor Documentation

Storage ( StorageMode_e  mode,
const std::string &  name,
bool  autoRemove = false 


[in]mode: storage mode
[in]name: name of the storage.
[in]autoRemove: tells whether the storage has to be physically deleted when this object is deleted.
~Storage ( )


Member Function Documentation

Group& getGroup ( const std::string  name)

Facility for retrieving the root group.

the root group.
std::string getName ( ) const

Get the name of the storage.

Group & operator() ( const std::string  name = "")

Facility for retrieving the root group.

the root group.
void remove ( )

Remove physically the storage.

Implements ICell.

Member Data Documentation

Group* _root

Root group.

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