DataArray.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 DataArray.hpp
 * @Description DataArray class definition.
 * @Status Implementing
 * @Version $Id: DataArray.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa
 */

#ifndef __DATASTRUCTURE_DATAARRAY_H_
#define __DATASTRUCTURE_DATAARRAY_H_

#include "DataValue.hpp"

#include <Exception.hpp>

#include <vector>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
    
      using boost::shared_ptr;
      using mermaid::support::errorhandling::Exception;
      
      /**
       * @Class DataArray DataArray.hpp "DataArray.hpp"
       * @Description Class representing a data value array
       * @Author Marco Barbosa
       */
      template<class T>
      class DataArray : public DataValue
      {
        public:
          /**
           * @Description Default constructor. This initializes the array as a dynamic array (one whose size may change during time).
           */
          DataArray() : DataValue() {
            isDynamic_ = true;
          };
          
          /**
           * @Description Constructor. This initializes the array as a static array (one whose size is fixed during time).
           * @Argument size Size of the static array.
           */
          DataArray (int size) : DataValue() {
            isDynamic_ = false;
            
            for (int i = 0; i < size; i++) {
              array_.push_back (shared_ptr<T>());
            };
          };
          
          /**
           * @Description Getter. Returns a pointer to the object at a specific position in the array.
           * @Argument index Position of the array to be accessed.
           */
          shared_ptr<T>& operator[] (const int index) {
            return array_[index];
          };
          
          /**
           * @Description Operation that adds a data element at the end of the array. This operation is only valid in dynamic arrays.
           * @Argument value Value to be added at the end of the array.
           */
          void pushBack (shared_ptr<T> value) {
            if (isDynamic_ == false) {
              throw Exception ("DataArray::pushBack : array is not dynamic");
            }
            
            array_.push_back (value);
          };
          
          /**
           * @Description Tests if the array is dynamic or not.
           * @Returns True if the array is dynamic, false otherwise.
           */
          bool isDynamic() {
            return isDynamic_;
          };
          
          /**
           * @Description Gives the size of the array.
           * @Returns Size of the array.
           */
          unsigned int getSize() {
            return array_.size();
          };
          
        protected:
          bool isDynamic_;
          std::vector<shared_ptr<T> > array_;
          
      }; // class DataArray
    } // namespace data
  } // namespace support
} // namespace mermaid


#endif // __DATASTRUCTURE_DATAARRAY_H_