Teuchos_DependencySheet.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @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_