core/UnitsColl.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

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

  OpenFLUID 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 General Public License for more details.

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


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/



#ifndef __UNITSCOLL_H__
#define __UNITSCOLL_H__




#include <openfluid/dllexport.hpp>
#include <openfluid/core/TypeDefs.hpp>
//#include <openfluid/core/Unit.hpp>


namespace openfluid { namespace core {


class /*DLLEXPORT*/ Unit;

/**
  Type definition for a list of units
*/
typedef std::list<Unit> UnitsList_t;


class DLLEXPORT UnitsCollection
{
  private :

    UnitsList_t m_Data;


  public :

    UnitsCollection();

    ~UnitsCollection();

    Unit* getUnit(UnitID_t aUnitID);

    Unit* addUnit(Unit aUnit);

    void sortByProcessOrder();

    inline const UnitsList_t* getList() const { return &m_Data; };

    inline UnitsList_t* getList() { return &m_Data; };

};

} } // namespaces


#endif /* __UNITSCOLL_H__ */