Optika GUI Toolik Version of the Day
Optika_DependencySheet.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //         Optika: A Tool For Developing Parameter Obtaining GUIs
00005 //                Copyright (2009) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, with Sandia Corporation, the 
00008 // U.S. Government retains certain rights in this software.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Kurtis Nusbaum (klnusbaum@gmail.com) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 #ifndef OPTIKA_DEPENDENCYSHEET_HPP_
00029 #define OPTIKA_DEPENDENCYSHEET_HPP_
00030 #include "Optika_Dependency.hpp"
00031 
00032 namespace Optika{
00033 
00043 class DependencySheet{
00044 public:
00048   typedef std::set<Teuchos::RCP<Optika::Dependency>, Optika::Dependency::DepComp > DepSet;
00049 
00054   typedef Teuchos::map<const Teuchos::ParameterEntry*, DepSet > DepMap;
00055 
00062   DependencySheet(Teuchos::RCP<Teuchos::ParameterList> rootList);
00063 
00071   DependencySheet(Teuchos::RCP<Teuchos::ParameterList> rootList, const std::string &name);
00072 
00079   bool addDependency(const Teuchos::RCP<Optika::Dependency> dependency);
00080 
00087   bool removeDependency(Teuchos::RCP<Optika::Dependency> dependency);
00088 
00096   bool hasDependents(const Teuchos::ParameterEntry *dependee) const;
00097 
00104   const DepSet& getDependenciesForParameter(const Teuchos::ParameterEntry *dependee) const;
00105 
00111   DepMap::iterator depBegin();
00112 
00118   DepMap::iterator depEnd();
00119 
00125   DepMap::const_iterator depBegin() const;
00126 
00132   DepMap::const_iterator depEnd() const;
00133 
00137   void printDeps();
00138 
00139 private:
00144   DepMap dependencies;
00145 
00149   std::string name;
00150 
00154   Teuchos::RCP<Teuchos::ParameterList> rootList;
00155 
00160   void validateExistanceInRoot(Teuchos::RCP<Optika::Dependency> dependency);
00161 };
00162 
00163 
00164 }
00165 #endif //OPTIKA_DEPENDENCYSHEET_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends