Sacado_ParameterFamilyBase.hpp

Go to the documentation of this file.

// $Id: Sacado_ParameterFamilyBase.hpp,v 1.3 2007/07/24 00:08:06 etphipp Exp $ 
// $Source: /space/CVS/Trilinos/packages/sacado/src/parameter/Sacado_ParameterFamilyBase.hpp,v $ 
// @HEADER
// ***********************************************************************
// 
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef SACADO_PARAMETERFAMILYBASE_HPP
#define SACADO_PARAMETERFAMILYBASE_HPP

#include <map>
#include <string>

#include "Teuchos_RCP.hpp"

namespace Sacado {
  
  template <typename EntryBase, template<typename> class EntryType>
  class ParameterFamilyBase  {

  public:
  
    ParameterFamilyBase(const std::string& name, 
      bool supports_ad, 
      bool supports_analytic);

    virtual ~ParameterFamilyBase();

    std::string getName() const;

    bool supportsAD() const;

    bool supportsAnalytic() const;

    template <typename ValueType>
    bool hasType() const;


    template <typename ValueType>
    bool addEntry(const Teuchos::RCP< EntryType<ValueType> >& entry);

    template <typename ValueType>
    Teuchos::RCP< EntryType<ValueType> > getEntry();

    template <typename ValueType>
    Teuchos::RCP< const EntryType<ValueType> > getEntry() const;

    void printFamily(std::ostream& os) const;

  protected: 

    typedef std::map<std::string, Teuchos::RCP<EntryBase> > ValueMap;

    typedef typename ValueMap::const_iterator const_iterator;

    typedef typename ValueMap::iterator iterator;
    
    template <class ValueType> std::string getTypeName() const;

  private:

    ParameterFamilyBase(const ParameterFamilyBase&);
    
    ParameterFamilyBase& operator = (const ParameterFamilyBase&);

  protected:

    ValueMap family;

    const std::string name;

    bool supports_ad;
    
    bool supports_analytic;

  };
}

// Include template definitions
#include "Sacado_ParameterFamilyBaseImp.hpp"

#endif

---