Teuchos_Dependency.hpp

// @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_DEPENDENCY_HPP_
#define TEUCHOS_DEPENDENCY_HPP_
#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_InvalidDependencyException.hpp"
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_