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

#ifndef __DATASTRUCTURE_DATABOXARRAY_H_
#define __DATASTRUCTURE_DATABOXARRAY_H_

#include <DataArray.hpp>
#include <DataBox.hpp>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      /**
       * @Class DataBoxArray DataBoxArray.hpp "DataBoxArray.hpp"
       * @Description Class representing an array of DataBox's
       * @Author Marco Barbosa
       */
      class DataBoxArray : public DataArray<DataBox>
      {
        public:
        
          /**
           * @Description Default constructor. This initializes the array as dynamic.
           * @Argument typeName Name of the type of DataBoxes stored in this array.
           */
          DataBoxArray (std::string typeName);
          
          /**
           * @Description Constructor. This initializes the array as static, with the given size.
           * @Argument typeName Name of the type of DataBoxes stored in this array.
           * @Argument size Size of the static integer array.
           */
          DataBoxArray (std::string typeName, int size);
          
          /**
           * @Description Clone method. This clones the array.
           */
          virtual DataValue * clone();
          
          /**
           * @Description String cast operation. Converts the DataBox array into its string representation.
           */
          virtual operator std::string() const;
          
          /**
           * @Description Operation that appends a DataBox to the end of the array. This is only valid in dynamic arrays.
           * @Argument box DataBox to be appended.
           */
          void pushBack (shared_ptr<DataBox> box);
          
        private:
        
          /**
           * @Description Name of the type of the DataBoxes stored in this array.
           */
          std::string boxTypeName_;
      }; // class DataBoxArray
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASTRUCTURE_DATABOXARRAY_H_