Teuchos_DependencySheet.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_DEPENDENCYSHEET_HPP_
#define TEUCHOS_DEPENDENCYSHEET_HPP_

#include "Teuchos_Dependency.hpp"


namespace Teuchos{


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DependencySheet{

public:


  typedef std::set<RCP<Dependency>, RCPComp > DepSet;

  typedef map<RCP<const ParameterEntry>, DepSet, RCPConstComp > DepMap;



  DependencySheet();

  DependencySheet(const std::string &name);



  void addDependency(RCP<Dependency> dependency);

  void addDependencies(RCP<DependencySheet> otherSheet);

  void removeDependency(RCP<Dependency> dependency);

  void setName(const std::string newName){
    name_ = newName;
  }




  inline bool hasDependents(RCP<const ParameterEntry> dependee) const{
    return (dependenciesMap_.find(dependee) != dependenciesMap_.end()
      && dependenciesMap_.find(dependee)->second.size() > 0);
  }

  RCP<const DepSet> getDependenciesForParameter(
    RCP<const ParameterEntry> dependee) const;

  inline const std::string& getName() const{
    return name_;
  }

  inline bool empty() const{
    return dependencies_.empty();
  }



  inline DepSet::iterator depBegin(){
    return dependencies_.begin();
  }

  inline DepSet::iterator depEnd(){
    return dependencies_.end();
  }

  inline DepSet::const_iterator depBegin() const{
    return dependencies_.begin();
  }

  inline DepSet::const_iterator depEnd() const{
    return dependencies_.end();
  }

  inline DepSet::size_type size(){
    return dependencies_.size();
  }



  void printDeps(std::ostream& out) const;


  static const std::string& getNameAttributeName(){
    static const std::string NAME_ATTRIBUTE_NAME="name";
    return NAME_ATTRIBUTE_NAME;
  }

private:


  DepMap dependenciesMap_;

  DepSet dependencies_;

  std::string name_;


};


}
#endif //TEUCHOS_DEPENDENCYSHEET_HPP_