Teuchos_Dependency.hpp

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef TEUCHOS_DEPENDENCY_HPP_
#define TEUCHOS_DEPENDENCY_HPP_
#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_InvalidDependencyException.hpp"
#include <set>
namespace Teuchos{
 
 
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT Dependency : public Describable{
 
public:
 
 
  typedef std::set<RCP<ParameterEntry>, RCPComp > ParameterEntryList;
 
  typedef std::set<RCP<const ParameterEntry>, RCPConstComp > ConstParameterEntryList;
 
 
 
  Dependency(
    ConstParameterEntryList dependees,
    ParameterEntryList dependents);
 
  Dependency(
    ConstParameterEntryList dependees,
    RCP<ParameterEntry> dependent);
 
  Dependency(
    RCP<const ParameterEntry> dependee,
    ParameterEntryList dependents);
 
  Dependency(
    RCP<const ParameterEntry> dependee,
    RCP<ParameterEntry> dependent);
 
 
 
 
  inline const ConstParameterEntryList& getDependees() const{
    return dependees_;
  }
 
  inline ParameterEntryList& getDependents(){
    return dependents_;
  }
 
  inline const ConstParameterEntryList& getDependents() const{
    return constDependents_;
  }
 
 
  inline RCP<const ParameterEntry> getFirstDependee() const{
    return *(dependees_.begin());
  }
 
  template<class S>
  inline S getFirstDependeeValue() const{
    return getValue<S>(*(*(dependees_.begin())));
  }
 
  virtual std::string getTypeAttributeValue() const = 0;
 
 
  static const std::string& getXMLTagName(){
    static const std::string xmlTagName = "Dependency";
    return xmlTagName;
  }
 
 
 
  virtual void evaluate() = 0;
 
 
 
  virtual void print(std::ostream& out) const;
 
 
protected:
 
 
  virtual void validateDep() const = 0;
 
 
 private:
 
 
  ConstParameterEntryList dependees_;
 
  ParameterEntryList dependents_;
 
  ConstParameterEntryList constDependents_;
 
  Dependency(){}
 
  void createConstDependents();
 
  void checkDependeesAndDependents();
 
 
};
 
 
} //namespace Teuchos
#endif //TEUCHOS_DEPENDENCY_HPP_