BaseObjectDescription.h

Go to the documentation of this file.
00001 /******************************************************************************
00002 *       SOFA, Simulation Open-Framework Architecture, version 1.0 beta 3      *
00003 *                (c) 2006-2008 MGH, INRIA, USTL, UJF, CNRS                    *
00004 *                                                                             *
00005 * This library is free software; you can redistribute it and/or modify it     *
00006 * under the terms of the GNU Lesser General Public License as published by    *
00007 * the Free Software Foundation; either version 2.1 of the License, or (at     *
00008 * your option) any later version.                                             *
00009 *                                                                             *
00010 * This library is distributed in the hope that it will be useful, but WITHOUT *
00011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
00012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
00013 * for more details.                                                           *
00014 *                                                                             *
00015 * You should have received a copy of the GNU Lesser General Public License    *
00016 * along with this library; if not, write to the Free Software Foundation,     *
00017 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.          *
00018 *******************************************************************************
00019 *                              SOFA :: Framework                              *
00020 *                                                                             *
00021 * Authors: M. Adam, J. Allard, B. Andre, P-J. Bensoussan, S. Cotin, C. Duriez,*
00022 * H. Delingette, F. Falipou, F. Faure, S. Fonteneau, L. Heigeas, C. Mendoza,  *
00023 * M. Nesme, P. Neumann, J-P. de la Plata Alcade, F. Poyer and F. Roy          *
00024 *                                                                             *
00025 * Contact information: contact@sofa-framework.org                             *
00026 ******************************************************************************/
00027 #ifndef SOFA_CORE_OBJECTMODEL_BASEOBJECTDESCRIPTION_H
00028 #define SOFA_CORE_OBJECTMODEL_BASEOBJECTDESCRIPTION_H
00029 
00030 #include <string>
00031 #include <list>
00032 #include <map>
00033 
00034 namespace sofa
00035 {
00036 
00037 namespace core
00038 {
00039 
00040 namespace objectmodel
00041 {
00042 
00043 class Base;
00044 
00052 class BaseObjectDescription
00053 {
00054 public:
00055     class Attribute
00056     {
00057     protected:
00058         std::string value;
00059         bool accessed;
00060     public:
00061         Attribute() : accessed(false) {}
00062         Attribute(const std::string& v) : value(v), accessed(false) {}
00063         void operator=(const std::string& v) { value = v; }
00064         void operator=(const char* v) { value = v; }
00065         operator std::string() { accessed = true; return value; }
00066         const char* c_str() { accessed = true; return value.c_str(); }
00067         bool isAccessed() { return accessed; }
00068         void setAccessed(bool v) { accessed = v; }
00069     };
00070     
00071     typedef std::map<std::string,Attribute> AttributeMap;
00072     
00073     BaseObjectDescription(const char* name=NULL, const char* type=NULL);
00074     
00075     virtual ~BaseObjectDescription();
00076     
00078     virtual Base* getObject();
00079     
00081     virtual std::string getName();
00082     
00084     virtual BaseObjectDescription* getParent() const;
00085     
00087     virtual std::string getBaseFile();
00088     
00090     //virtual const AttributeMap& getAttributeMap() const;
00091     
00093     template<class T> void getAttributeList(T& container)
00094     {
00095         for (AttributeMap::iterator it = attributes.begin();
00096             it != attributes.end(); ++it)
00097             container.push_back(it->first);
00098     }
00099     
00101     virtual BaseObjectDescription* find(const char* nodeName, bool absolute=false);
00102     
00104     virtual Base* findObject(const char* nodeName);
00105     
00107     virtual const char* getAttribute(const std::string& attr, const char* defaultVal=NULL);
00108     
00110     virtual bool removeAttribute(const std::string& attr);
00111     
00113     virtual std::string getFullName();
00114     
00115 protected:
00116     AttributeMap attributes;
00117 };
00118 
00119 } // namespace objectmodel
00120 
00121 } // namespace core
00122 
00123 } // namespace sofa
00124 
00125 #endif