Teuchos_Condition.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_CONDITION_HPP_
#define TEUCHOS_CONDITION_HPP_

#include "Teuchos_Dependency.hpp"
#include "Teuchos_Describable.hpp"

namespace Teuchos {

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT Condition : public Describable{
public:


  typedef Teuchos::Array<Teuchos::RCP<Condition> > ConditionList;

  typedef Teuchos::Array<Teuchos::RCP<const Condition> > ConstConditionList;



  Condition(){}

  virtual ~Condition(){}




  virtual bool isConditionTrue() const = 0;

  virtual bool containsAtLeasteOneParameter() const = 0;

  virtual Dependency::ConstParameterEntryList getAllParameters() const = 0;

  virtual std::string getTypeAttributeValue() const = 0;

  static const std::string& getXMLTagName(){
    static const std::string xmlTagName = "Condition";
    return xmlTagName;
  }


};

}
#endif //TEUCHOS_CONDITION_HPP_