Teko_RequestMesg.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Teko_RequestMesg_hpp__
#define __Teko_RequestMesg_hpp__

#include <string>
#include <iostream>

#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterList.hpp"

namespace Teko {

class RequestMesg {
 public:
  explicit RequestMesg(const std::string& name, unsigned int tag = 0) : name_(name), tag_(tag) {}

  explicit RequestMesg(const Teuchos::RCP<const Teuchos::ParameterList>& pl) : paramList_(pl) {
    fromParameterList(*paramList_);
  }

  virtual ~RequestMesg() {}

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

  unsigned int getTag() const { return tag_; }

  const Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const {
    return paramList_.getConst();
  }

 protected:
  void fromParameterList(const Teuchos::ParameterList& pl) {
    name_ = "Parameter List";
    tag_  = 0;
    if (pl.isParameter("Name")) name_ = pl.get<std::string>("Name");
    if (pl.isParameter("Tag")) tag_ = pl.get<unsigned int>("Tag");
  }

  std::string name_;
  unsigned int tag_;
  Teuchos::RCP<const Teuchos::ParameterList> paramList_;
};

// simple stream interface for RequestMesg
inline std::ostream& operator<<(std::ostream& os, const Teko::RequestMesg& rm) {
  os << "RequestMesg <"
     << "name = \"" << rm.getName() << "\", "
     << "tag = " << rm.getTag() << ">";

  return os;
}

}  // end namespace Teko

#endif