Teko_CloneFactory.hpp

/*
// @HEADER
// 
// ***********************************************************************
// 
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 Sandia Corporation 
//  
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//  
// 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 Eric C. Cyr (eccyr@sandia.gov)
// 
// ***********************************************************************
// 
// @HEADER

*/

#ifndef __Teko_CloneFactory_hpp__
#define __Teko_CloneFactory_hpp__

#include "Teuchos_RCP.hpp"

namespace Teko {

class Cloneable {
public:
   virtual ~Cloneable() {}

   virtual Teuchos::RCP<Cloneable> clone() const = 0;
};

class AutoCloneDummy {};

template <class CloneType,class BaseType=AutoCloneDummy>
class AutoClone : public Cloneable, public BaseType {
public:
   virtual ~AutoClone() {}

   AutoClone() 
      : BaseType()
   { }
   
   virtual Teuchos::RCP<Cloneable> clone() const
   { return Teuchos::rcp(new AutoClone<CloneType,CloneType>()); }

private:
   // hidden
   AutoClone(const AutoClone<BaseType> & );
};

template <class CloneBaseType>
class CloneFactory {
public:
   CloneFactory() {}

   CloneFactory(const CloneFactory<CloneBaseType> & cf) : parentClones_(cf.parentClones_) {}

   virtual ~CloneFactory() {}

   virtual Teuchos::RCP<CloneBaseType> build(const std::string & str) const
   { 
      std::map<std::string,Teuchos::RCP<const Cloneable> >::const_iterator itr 
            = parentClones_.find(str);
      if(itr==parentClones_.end()) return Teuchos::null;
      return Teuchos::rcp_dynamic_cast<CloneBaseType>(itr->second->clone(),true); 
   }

   virtual void addClone(const std::string & str,const Teuchos::RCP<Cloneable> & clone)
   { parentClones_[str] = clone; }

   virtual int cloneCount() const
   { return parentClones_.size(); }

   void getCloneNames(std::vector<std::string> & names) const
   {
      std::map<std::string,Teuchos::RCP<const Cloneable> >::const_iterator itr;
      for(itr=parentClones_.begin();itr!=parentClones_.end();++itr)
         names.push_back(itr->first);
   }

protected:
   std::map<std::string,Teuchos::RCP<const Cloneable> > parentClones_;
};

}

#endif