albaStorageElement.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaStorageElement
 Authors: Marco Petrone
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef __albaStorageElement_h__
#define __albaStorageElement_h__
 
#include "albaDefines.h"
#include <vector>
//----------------------------------------------------------------------------
// forward declarations :
//----------------------------------------------------------------------------
class albaStorage;
class albaStorable;
class albaMatrix;
class albaString;
class albaObject;
 
 
class ALBA_EXPORT albaStorageElement
{
public:
  virtual ~albaStorageElement();
 
  virtual const char *GetName()=0;
 
  virtual void SetAttribute(const char *name,const char *value)=0;
  void SetAttribute(const char *name,const albaID value);
  void SetAttribute(const char *name,const double value);
 
  virtual bool GetAttribute(const char *name,albaString &value)=0;
  
  bool GetAttributeAsDouble(const char *name,double &value);
 
  bool GetAttributeAsInteger(const char *name,albaID &value);
 
  albaString UpgradeAttribute(const char *attribute);
 
  virtual int StoreText(const char *name, const char *text)=0;
  virtual int StoreMatrix(const char *name,const albaMatrix *matrix)=0;
  virtual int StoreVectorN(const char *name, double *comps,int num)=0;
  virtual int StoreVectorN(const char *name, int *comps,int num)=0;
  virtual int StoreVectorN(const char *name, const std::vector<double> &comps,int num)=0;
  virtual int StoreVectorN(const char *name, const std::vector<int> &comps,int num)=0;
  virtual int StoreVectorN(const char *name, const std::vector<albaString> &comps,int num,const char *tag)=0;
 
  //virtual int StoreData(const char *name, const char *data, const int size)=0;
  //virtual int StoreData16(const char *name, const short *data, const int size)=0;
  //virtual int StoreData32(const char *name, const long *data, const int size)=0;
 
  //virtual int RestoreData(const char *name, char *data, const int size)=0;
  //virtual int RestoreData16(const char *name,short *data, const int size)=0;
  //virtual int RestoreData32(const char *name,long *data, const int size)=0;
 
  int RestoreMatrix(const char *name,albaMatrix *matrix);
  int RestoreVectorN(const char *name,double *comps,unsigned int num);
  int RestoreVectorN(const char *name,int *comps,unsigned int num);
  int RestoreVectorN(const char *name,std::vector<double> &comps,unsigned int num);
  int RestoreVectorN(const char *name,std::vector<int> &comps,unsigned int num);
  int RestoreVectorN(const char *name,std::vector<albaString> &comps,unsigned int num,const char *tag);
  int RestoreText(const char *name,char *&buffer);
  int RestoreText(const char *name,albaString &buffer);
 
 
  virtual int RestoreMatrix(albaMatrix *matrix)=0;
  virtual int RestoreVectorN(double *comps,unsigned int num)=0;
  virtual int RestoreVectorN(int *comps,unsigned int num)=0;
  virtual int RestoreVectorN(std::vector<double> &comps,unsigned int num)=0;
  virtual int RestoreVectorN(std::vector<int> &comps,unsigned int num)=0;
  virtual int RestoreVectorN(std::vector<albaString> &comps,unsigned int num,const char *tag)=0;
  virtual int RestoreText(albaString &buffer)=0;
 
  virtual int RestoreText(char *&buffer);
  
  int StoreDouble(const char *name,const double &value);
  int RestoreDouble(const char *name,double &value);
  int RestoreDouble(double &value);
 
  int StoreInteger(const char *name, const int &value);
  int RestoreInteger(const char *name,int &value);
  int RestoreInteger(int &value);
  
  int RestoreObject(const char *name,albaStorable * object);
 
  albaObject *RestoreObject(const char *name);
 
  albaObject *RestoreObject();
 
  albaStorageElement *StoreObject(const char *name,albaObject *object);
 
  virtual int StoreObjectVector(const char *name,const std::vector<albaObject *> &vector,const char *items_name="Item");
 
  virtual int RestoreObjectVector(const char *name,std::vector<albaObject *> &vector,const char *items_name="Item");
 
  virtual int RestoreObjectVector(albaStorageElement *element,std::vector<albaObject *> &vector,const char *items_name="Item");
 
  albaStorage *GetStorage() {return m_Storage;}
 
  albaStorageElement *GetParent() {return m_Parent;}
 
  virtual albaStorageElement *AppendChild(const char *name) = 0;
  
  virtual albaStorageElement *FindNestedElement(const char *name);
 
  typedef std::vector<albaStorageElement *> ChildrenVector;
 
  virtual ChildrenVector &GetChildren()=0;
  
  virtual bool GetNestedElementsByName(const char *name,std::vector<albaStorageElement *> &list);
 
protected:
  albaStorageElement(albaStorageElement *parent,albaStorage *storage);
 
  albaStorageElement *StoreObject(const char *name,albaStorable *storable, const char *type_name);
 
  void SetStorage(albaStorage *storage) {m_Storage = storage;}
  void SetParent(albaStorageElement *element) {m_Parent = element;}
 
  albaStorage *m_Storage;                        
  albaStorageElement *m_Parent;                  
  std::vector<albaStorageElement *> *m_Children;  
};
#endif // _albaStorageElement_h_