DianaBasic.hpp

/* -----------------------------------------------------------------------------
 *  Diana process modelling, simulation and analysis software
 *  Copyright (c) 2005, Michael Krasnyk
 *  All rights reserved.
 *
 *  This file is a part of Diana process modelling, simulation and analysis software
 *
 *  Diana 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 (see accompanying file LICENSE)
 * -----------------------------------------------------------------------------
 *  $Id: DianaBasic.hpp 8160 2009-03-16 18:36:30Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef DIANA_BASIC_H
#define DIANA_BASIC_H

#include <vector>
#include <map>
#include <list>

#include <CapeOpen.hpp>

namespace Diana{

  class DianaCollection : public Common::Collection::ICapeCollection {
  private:
      Common::Types::CapeBoolean owning; 
  public:
      DianaCollection(Common::Types::CapeBoolean owning=true):ICapeCollection(),owning(owning){};
    virtual ~DianaCollection();

      Common::Types::CapeBoolean getOwning() const;

      void setOwning(const Common::Types::CapeBoolean _owning);

    const Common::Types::CapeString& GetComponentName() const
      throw (Common::Error::ECapeUnknown);

    void SetComponentName(const Common::Types::CapeString& _name)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    const Common::Types::CapeString& GetComponentDescription() const
      throw (Common::Error::ECapeUnknown);

    void SetComponentDescription(const Common::Types::CapeString& _description)
                                throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    Common::Types::CapeLong Count() const  
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation);
      
    Common::Identification::ICapeIdentification* ItemByIndex(Common::Types::CapeLong index) const
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfBounds);


    Common::Identification::ICapeIdentification* ItemByName(const Common::Types::CapeString& name) const
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
             Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfBounds);

    void Add(Common::Identification::ICapeIdentification* item,
             const Common::Types::CapeString& alias=Common::Types::CapeStringUNDEFINED)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    void AddIndexed(Common::Identification::ICapeIdentification* item,
                    const Common::Types::CapeString& alias=Common::Types::CapeStringUNDEFINED)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

      void AddArray(Common::Identification::ICapeIdentification* item,
                    const std::vector<Common::Identification::ICapeIdentification*>& skalItems,
                    const Common::Types::CapeString& alias=Common::Types::CapeStringUNDEFINED)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    Common::Identification::ICapeIdentification* 
    GetArray(Common::Types::CapeLong index)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);
      
                
    Common::Types::CapeLong ItemIndexByName(const Common::Types::CapeString& name) const
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

  protected:
    Common::Types::CapeString   strCollName;              
    Common::Types::CapeString   strCollDescription;       
    
    Common::Types::CapeLong mapNameToPosition(const Common::Types::CapeString& name) const;
    Common::Identification::ICapeIdentification* getItemFromPool(Common::Types::CapeLong pos) const
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfBounds);
    void addStringMapping(const Common::Types::CapeString& name, const Common::Types::CapeString& alias,
                          Common::Types::CapeLong pos)
      throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);
    typedef std::vector<Common::Identification::ICapeIdentification*> vecident;
    typedef std::vector<Common::Types::CapeLong> vecindices;
    typedef std::map<std::string, Common::Types::CapeLong> mapindices;
                
    vecident   vecItemsPool;     
    vecindices vecItems;         
    vecindices arrayItems;       
    mapindices mapItems;         
    mapindices mapItemsIndexed;  
  };
};

#endif // DIANA_BASIC_H