Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_DependencySheet.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 
00044 #ifndef TEUCHOS_DEPENDENCYSHEET_HPP_
00045 #define TEUCHOS_DEPENDENCYSHEET_HPP_
00046 
00051 #include "Teuchos_Dependency.hpp"
00052 
00053 
00054 namespace Teuchos{
00055 
00056 
00061 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DependencySheet{
00062 
00063 public:
00064 
00067 
00071   typedef std::set<RCP<Dependency>, RCPComp > DepSet;
00072 
00077   typedef map<RCP<const ParameterEntry>, DepSet, RCPConstComp > DepMap;
00078   
00080 
00083 
00087   DependencySheet();
00088 
00094   DependencySheet(const std::string &name);
00095   
00097 
00100 
00106   void addDependency(RCP<Dependency> dependency);
00107 
00115   void addDependencies(RCP<DependencySheet> otherSheet);
00116 
00123   void removeDependency(RCP<Dependency> dependency);
00124 
00128   void setName(const std::string newName){
00129     name_ = newName;
00130   }
00131   
00133 
00135 
00136   
00144   inline bool hasDependents(RCP<const ParameterEntry> dependee) const{
00145     return (dependenciesMap_.find(dependee) != dependenciesMap_.end() 
00146       && dependenciesMap_.find(dependee)->second.size() > 0);
00147   }
00148 
00157   RCP<const DepSet> getDependenciesForParameter(
00158     RCP<const ParameterEntry> dependee) const;
00159 
00163   inline const std::string& getName() const{
00164     return name_;
00165   }
00166 
00170   inline bool empty() const{
00171     return dependencies_.empty();
00172   }
00173   
00175 
00178 
00183   inline DepSet::iterator depBegin(){
00184     return dependencies_.begin();
00185   }
00186 
00192   inline DepSet::iterator depEnd(){
00193     return dependencies_.end();
00194   }
00195 
00199   inline DepSet::const_iterator depBegin() const{
00200     return dependencies_.begin();
00201   }
00202     
00206   inline DepSet::const_iterator depEnd() const{
00207     return dependencies_.end();
00208   }
00209 
00217   inline DepSet::size_type size(){
00218     return dependencies_.size();
00219   }
00220   
00222 
00225 
00229   void printDeps(std::ostream& out) const;
00230 
00231 
00234   static const std::string& getNameAttributeName(){
00235     static const std::string NAME_ATTRIBUTE_NAME="name";
00236     return NAME_ATTRIBUTE_NAME;
00237   }
00239 
00240 private:
00241 
00244   
00252   DepMap dependenciesMap_;
00253 
00257   DepSet dependencies_;
00258 
00262   std::string name_;
00263 
00265 
00266 };
00267 
00268 
00269 }
00270 #endif //TEUCHOS_DEPENDENCYSHEET_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines