C:/Programs/source/NIREP/DisplayDescription/ResourceDescriptionList/BasicDescription.h

/***************************************************************************************
*   Programmer: Gary E. Christensen
*   Date: 6/24/2010
*   Name: BasicDescription
*   Purpose: This class holds descriptive information about namespaces,
*      algorithms, and coordinate systems.
*      Objects of this class are filled with information by parsing a resource description list.
*      All non-required tags and their values are stored in the attribute list.
*   Optional XML Tags:
*      attributes - contains user defined XML tags and values
******************************************************************************************/
#pragma once
#ifndef _BASIC_DESCRIPTION_H_
#define _BASIC_DESCRIPTION_H_

#include <string>
#include <map>
#include <algorithm>

#include "tinyxml.h"

class BasicDescription {
public:
        typedef std::map<std::string, std::string> AttributeList;

  BasicDescription(){};

        BasicDescription(const std::string & default_ns){ m_ns = default_ns;};

        BasicDescription(TiXmlElement * descrip){
                FillUsingDom(descrip);
        };
  
  BasicDescription(TiXmlElement * descrip, const std::string & default_ns){
    m_ns = default_ns;
                FillUsingDom(descrip);
        };

        ~BasicDescription(){
                this->Clear(); 
        };

        void Clear(){
                m_id.clear();
                m_ns.clear();
                ClearAttributes(); 
        }

        const std::string & GetID(){ return m_id;}
        void SetID(const std::string & id){ 
    m_id = id;
    // convert m_id to lower case for case insensitivity strin comparison
    std::transform(m_id.begin(), m_id.end(), m_id.begin(), ::tolower);
  }
        
        const std::string & GetNameSpace(){ return m_ns;}
        void SetNameSpace(const std::string & ns){ 
    m_ns = ns; 
    // convert m_ns to lower case for case insensitivity strin comparison
    std::transform(m_ns.begin(), m_ns.end(), m_ns.begin(), ::tolower);
  }

  const std::string CreateNSID(){ return m_ns + "|" + m_id;}

        // Convert back and forth from DOM = Document Object Model
        TiXmlElement * CreateDOM(const std::string & tag);
        bool FillUsingDom(TiXmlElement * descrip);

        // Accessor functions for non-required data description attributes
        const std::string GetAttribute(std::string key){ 
    // convert key to lower case for case insensitivity strin comparison
    std::transform(key.begin(), key.end(), key.begin(), ::tolower);

                // return m_attribute[key]; Incorrect.  This command adds a new empty entry to map if key is missing
                AttributeList::iterator iter = m_attribute.find(key);
                if (iter != m_attribute.end()){
                        return iter->second;
                } else {
                        return "";
                }
        }
        void AddAttribute(std::string key, const std::string & value){ 
    // convert key to lower case for case insensitivity strin comparison
    std::transform(key.begin(), key.end(), key.begin(), ::tolower);

    m_attribute[key] = value; 
  }
        void ClearAttributes(){ m_attribute.clear(); }

protected:
        std::string   m_id;            // description id, e.g., 001, 002
  std::string   m_ns;            // namespace, e.g., na0
        AttributeList m_attribute;     // Stores non-required attributes listed in 
                                       // data resource file, e.g., name, description, 
                                       // modality, scanner, etc
};

#endif