DataBox.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename DataBox.hpp
 * @Description DataBox class definition.
 * @Status Implementing
 * @Version $Id: DataBox.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa
 */


#ifndef __DATASTRUCTURE_DATABOX_H_
#define __DATASTRUCTURE_DATABOX_H_

#include "DataStructureDescription.hpp"
#include "DataValue.hpp"
#include "DataValueVector.hpp"

#include "IntegerArray.hpp"
#include "DoubleArray.hpp"
#include "StringArray.hpp"


#include <map>
#include <string>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      using boost::shared_ptr;
      
      
      class DataBoxArray; // forward declaration
      
      
      /**
       * @Class DataBox DataBox.hpp "DataBox.hpp"
       * @Description A DataBox is a place where data can be put and retrieved from.
       * @Description This is a smart box, in which you can access data by name.
       * @Author Marco Barbosa
       */
      
      class DataBox : public DataValue
      {
      
          friend class DataFactory;
          
        public:
        
        
          DataBox (const DataBox &dbox);
          
          DataBox * clone();
          
          std::string getBoxStructureName() const;
          
          shared_ptr<DataValue> getValue (std::string valueName) const;
          
          shared_ptr<DataValueVector> getDataValueVector() const;
          
          int getInteger (std::string name) const;
          shared_ptr<IntegerArray> getIntegerArray (std::string name) const;
          
          double getDouble (std::string name) const;
          shared_ptr<DoubleArray> getDoubleArray (std::string name) const;
          
          std::string getString (std::string name) const;
          shared_ptr<StringArray> getStringArray (std::string name) const;
          
          shared_ptr<DataBox> getDataBox (std::string name) const;
          shared_ptr<DataBoxArray> getDataBoxArray (std::string name) const;
          
          void setInteger (std::string name, int value);
          void setDouble (std::string name, double value);
          void setString (std::string name, std::string value);
          
          void setValueFromString (std::string name, std::string value);
          /**
           * @Description Method to convert to string
           */
          virtual operator std::string() const;
          void print() const;
        private:
          //used by DataFactory
          DataBox();
          DataBox (shared_ptr<DataStructureDescription> dsd);
          
          //used by constructor
          void addInteger (std::string name, int i = 0);
          shared_ptr<IntegerArray> addDynamicIntegerArray (std::string name);
          shared_ptr<IntegerArray> addStaticIntegerArray (std::string name, int size);
          
          void addDouble (std::string name, double d = 0.0);
          shared_ptr<DoubleArray> addDynamicDoubleArray (std::string name);
          shared_ptr<DoubleArray> addStaticDoubleArray (std::string name, int size);
          
          void addString (std::string name, std::string s = std::string (""));
          shared_ptr<StringArray> addDynamicStringArray (std::string name);
          shared_ptr<StringArray> addStaticStringArray (std::string name, int size);
          
          void addDataBox (std::string name, std::string type);
          shared_ptr<DataBoxArray> addDynamicDataBoxArray (std::string name, std::string type);
          shared_ptr<DataBoxArray> addStaticDataBoxArray (std::string name, std::string type, int size);
          
          void addDataValue (std::string name, shared_ptr<DataValue> value);
          
          /**
           * @Returns number of read values of the value vector
           */
          int setDataFromValueVector (shared_ptr<DataValueVector> vv, int startPos = 0);
          
          //variables to hold the data
          shared_ptr<DataStructureDescription> dataStructureDescription_;
          shared_ptr<DataValueVector> valueVector_;
          std::map<std::string, shared_ptr<DataValue> > nameToPtrMap_;
          std::map<shared_ptr<DataValue>, std::string> ptrToNameMap_;
      }; // DataBox
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASTRUCTURE_DATABOX_H_