source: XIOS3/trunk/src/attribute_map.hpp @ 2433

#ifndef __XIOS_CAttributeMap__
#define __XIOS_CAttributeMap__

/// XIOS headers ///
#include "xios_spl.hpp"
#include "attribute.hpp"
#include "attribute_template.hpp"
#include "exception.hpp"
#include "xml_node.hpp"

namespace xios
{
      /// ////////////////////// Déclarations ////////////////////// ///
      /*!
        \class CAttributeMap
        This class represents the set of attributes which an object can have.
        Each attribute in the set is represented by an unique id.
      */

      class CAttributeMap
         : public xios_map<StdString, CAttribute*>
      {
            typedef xios_map<StdString, CAttribute*> SuperClassMap;

         public :

            /// Tests ///
            bool hasAttribute(const StdString & key) const;

            /// Accesseurs ///
            CAttribute * operator[](const StdString & key);

            /// Mutateurs ///
            void setAttribute(const StdString & key, CAttribute * const attr);

            void setAttributes(const xml::THashAttributes & attributes);
            void setAttributes(const CAttributeMap * const _parent, bool apply=true);
            void duplicateAttributes(const CAttributeMap* const _parent);
            size_t computeGlobalAttributesHash(const vector<StdString>& excludedAttrs);
            void clearAllAttributes(void);
            StdString dumpXiosAttributes(void) const;
            StdString recordXiosAttributes(void) const;

            void clearAttribute(const StdString& key);
            bool isEqual(const CAttributeMap& another, const vector<StdString>& excludedAttrs);

            /// Destructeur ///
            virtual ~CAttributeMap(void);

            /// Flux ///
            // Debug only //
            // friend StdOStream & operator << (StdOStream & os, const CAttributeMap & attributmap);

            /// Autre ///
            virtual StdString toString(void) const;
            virtual void fromString(const StdString & str);

//            virtual void toBinary  (StdOStream & os) const;
//            virtual void fromBinary(StdIStream & is);
            virtual void generateCInterface(ostream& oss, const string& className) ;
            virtual void generateFortran2003Interface(ostream& oss, const string& className) ;
            virtual void generateFortranInterface_hdl_(ostream& oss, const string& className) ;
            virtual void generateFortranInterface_hdl(ostream& oss, const string& className) ;
            virtual void generateFortranInterface_id(ostream& oss, const string& className) ;
            virtual void generateFortranInterfaceGet_hdl_(ostream& oss, const string& className) ;
            virtual void generateFortranInterfaceGet_hdl(ostream& oss, const string& className) ;
            virtual void generateFortranInterfaceGet_id(ostream& oss, const string& className) ;
            virtual void generateFortranInterfaceIsDefined_hdl_(ostream& oss, const string& className) ;
            virtual void generateFortranInterfaceIsDefined_hdl(ostream& oss, const string& className) ;
            virtual void generateFortranInterfaceIsDefined_id(ostream& oss, const string& className) ;

         protected :

            /// Constructeurs ///
            CAttributeMap(void);
            CAttributeMap(const xios_map<StdString, CAttribute*> & umap);       // Never implemented.
            CAttributeMap(const xios_map<StdString, CAttribute*> * const umap); // Not implemented.

            /// Propriété statique ///
            static CAttributeMap * Current;

      };  // class CAttributeMap

      inline bool CAttributeMap::hasAttribute(const StdString& key) const
      {
         return (this->find(key) != this->end());
      }

} // namespace xios

#endif // __XIOS_CAttributeMap__