Teuchos_ParameterEntry.hpp

Go to the documentation of this file.

// @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.
// 
// 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 Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER


#ifndef TEUCHOS_PARAMETER_ENTRY_H
#define TEUCHOS_PARAMETER_ENTRY_H

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_any.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_ParameterEntryValidator.hpp"

namespace Teuchos {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
class ParameterList; // another parameter type (forward declaration)
#endif

class ParameterEntry {
public:



  ParameterEntry();
  
  ParameterEntry(const ParameterEntry& source);

  template<typename T>
  explicit ParameterEntry(
    T value, bool isDefault = false, bool isList = false,
    const std::string &docString = "",
    RCP<const ParameterEntryValidator> const& validator = null
    );

  ~ParameterEntry();




  ParameterEntry& operator=(const ParameterEntry& source);

  template<typename T>
  void setValue(
    T value, bool isDefault = false,
    const std::string &docString = "",
    RCP<const ParameterEntryValidator> const& validator = null
    );

  void setAnyValue(
    const any &value, bool isDefault = false
    );

  void setValidator(
    RCP<const ParameterEntryValidator> const& validator
    );

  void setDocString(const std::string &docString);

  ParameterList& setList(
    bool isDefault = false,
    const std::string &docString = ""
    );



   
  template<typename T>
  T& getValue(T *ptr) const;

  any& getAny(bool activeQry = true);

  const any& getAny(bool activeQry = true) const;



  
  bool isUsed() const;

  bool isList() const;

  template <typename T>
  bool isType() const;

  bool isDefault() const;

  std::string docString() const;

  RCP<const ParameterEntryValidator> validator() const;



  std::ostream& leftshift(std::ostream& os, bool printFlags = true) const;


private:

  void reset();
  
  any val_;

  mutable bool isUsed_;

  mutable bool isDefault_;

  std::string  docString_;

  RCP<const ParameterEntryValidator> validator_;

};

template<typename T>
inline T& getValue( const ParameterEntry &entry )
{
  return entry.getValue((T*)NULL);
}

inline bool operator==(const ParameterEntry& e1, const ParameterEntry& e2) 
{ 
  return (
    e1.getAny() == e2.getAny()
    && e1.isList()== e2.isList()
    && e1.isUsed() == e2.isUsed()
    && e1.isDefault() == e2.isDefault()
    );
}

inline bool operator!=(const ParameterEntry& e1, const ParameterEntry& e2) 
{ 
  return !( e1 == e2 );
}

inline std::ostream& operator<<(std::ostream& os, const ParameterEntry& e) 
{ 
  return e.leftshift(os);
}

// ///////////////////////////////////////////
// Inline and Template Function Definitions

// Constructor/Destructor

template<typename T>
inline
ParameterEntry::ParameterEntry(
  T value, bool isDefault, bool isList
  ,const std::string &docString
  ,RCP<const ParameterEntryValidator> const& validator
  )
  : val_(value),
    isUsed_(false),
    isDefault_(isDefault),
    docString_(docString),
    validator_(validator)
{}

inline
ParameterEntry::~ParameterEntry()
{}

// Set Methods

template<typename T>
inline
void ParameterEntry::setValue(
  T value, bool isDefault, const std::string &docString
  ,RCP<const ParameterEntryValidator> const& validator
  )
{
  val_ = value;
  isDefault_ = isDefault;
  if(docString.length())
    docString_ = docString;
  if(validator.get())
    validator_ = validator;
}

// Get Methods

template<typename T>
inline
T& ParameterEntry::getValue(T *ptr) const
{
  isUsed_ = true;
  return const_cast<T&>(Teuchos::any_cast<T>( val_ ));
}

inline
any& ParameterEntry::getAny(bool activeQry)
{ 
  if (activeQry == true) {
    isUsed_ = true;
  }
  return val_; 
}

inline
const any& ParameterEntry::getAny(bool activeQry) const
{ 
  if (activeQry == true) {
    isUsed_ = true;
  }
  return val_; 
}

// Attribute Methods

inline
bool ParameterEntry::isUsed() const
{ return isUsed_; }

template <typename T>
inline
bool ParameterEntry::isType() const
{
  bool match = ( val_.type() == typeid(T) );
#ifdef HAVE_SHARED
  // For shared libraries, the above may resolve as false because one
  // of the types is not fully qualified.  The following check will
  // compensate for that.
  if ( !match )
    match = ( strcmp(val_.type().name(), typeid(T).name()) == 0 );
#endif
  return match;
}

inline
bool ParameterEntry::isDefault() const
{ return isDefault_; }

inline
std::string ParameterEntry::docString() const
{ return docString_; }

inline
RCP<const ParameterEntryValidator>
ParameterEntry::validator() const
{ return validator_; }

} // namespace Teuchos

#endif

---