Teuchos - Trilinos Tools Package Version of the Day
Teuchos_Dependency.hpp
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 #ifndef TEUCHOS_DEPENDENCY_HPP_
00044 #define TEUCHOS_DEPENDENCY_HPP_
00045 #include "Teuchos_RCP.hpp"
00046 #include "Teuchos_ParameterList.hpp"
00047 #include "Teuchos_InvalidDependencyException.hpp"
00054 namespace Teuchos{
00055 
00056 
00063 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT Dependency : public Describable{
00064 
00065 public:
00066 
00069 
00073   typedef std::set<RCP<ParameterEntry>, RCPComp > ParameterEntryList;
00074 
00078   typedef std::set<RCP<const ParameterEntry>, RCPConstComp > ConstParameterEntryList;
00079 
00081 
00084 
00091   Dependency(
00092     ConstParameterEntryList dependees, 
00093     ParameterEntryList dependents);
00094 
00101   Dependency(
00102     ConstParameterEntryList dependees, 
00103     RCP<ParameterEntry> dependent);
00104 
00111   Dependency(
00112     RCP<const ParameterEntry> dependee, 
00113     ParameterEntryList dependents);
00114 
00121   Dependency(
00122     RCP<const ParameterEntry> dependee, 
00123     RCP<ParameterEntry> dependent);
00124 
00126 
00128 
00129 
00135   inline const ConstParameterEntryList& getDependees() const{
00136     return dependees_;
00137   }
00138 
00144   inline ParameterEntryList& getDependents(){
00145     return dependents_;
00146   }
00147 
00153   inline const ConstParameterEntryList& getDependents() const{
00154     return constDependents_;
00155   }
00156 
00157 
00161   inline RCP<const ParameterEntry> getFirstDependee() const{
00162     return *(dependees_.begin());
00163   }
00164 
00171   template<class S>
00172   inline S getFirstDependeeValue() const{
00173     return getValue<S>(*(*(dependees_.begin())));
00174   }
00175 
00180   virtual std::string getTypeAttributeValue() const = 0;
00181  
00182 
00186   static const std::string& getXMLTagName(){
00187     static const std::string xmlTagName = "Dependency";
00188     return xmlTagName;
00189   }
00190 
00192 
00195 
00200   virtual void evaluate() = 0;
00201   
00203   
00206 
00208   virtual void print(std::ostream& out) const;
00209 
00211 
00212 protected:
00213 
00216 
00222   virtual void validateDep() const = 0;
00223 
00225 
00226  private:
00227 
00230   
00234   ConstParameterEntryList dependees_;
00235 
00239   ParameterEntryList dependents_;
00240 
00244   ConstParameterEntryList constDependents_;
00245 
00249   Dependency(){}
00250 
00254   void createConstDependents();
00255 
00259   void checkDependeesAndDependents();
00260 
00262 
00263 };
00264 
00265 
00266 } //namespace Teuchos
00267 #endif //TEUCHOS_DEPENDENCY_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines