IterationPack_cast_iq.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef GIP_CAST_IQ_H
#define GIP_CAST_IQ_H

#include <stdexcept>
#include <typeinfo>

#include "IterationPack_AlgorithmState.hpp"
#include "IterationPack_IterQuantityAccess.hpp"

namespace IterationPack {

template<class T>
IterQuantityAccess<T>& cast_iq(
  AlgorithmState& state, const std::string& iq_name );

template<class T>
const IterQuantityAccess<T>& cast_iq(
  const AlgorithmState& state, const std::string& iq_name );

template<class T>
IterQuantityAccess<T>& cast_iq(
  AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name );

template<class T>
const IterQuantityAccess<T>& cast_iq(
  const AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name );

// Helper function

void imp_cast_iq_throw_error(
  const std::string&                 iq_name
  ,const std::string&                iq_is_type_name
  ,const std::string&                iq_want_type_name
  );

void imp_cast_iq_throw_error(
  const AlgorithmState::iq_id_type   iq_id
  ,const std::string&                iq_name
  ,const std::string&                iq_is_type_name
  ,const std::string&                iq_want_type_name
  );

// ///////////////////
// Inline definitions

template<class T>
//inline
IterQuantityAccess<T>& cast_iq(
  AlgorithmState& state, const std::string& iq_name )
{
  IterQuantity
     &iq = state.iter_quant( iq_name );
  IterQuantityAccess<T>
    *p = dynamic_cast<IterQuantityAccess<T>*>( &iq );
      // will throw exception if iq_name does not exist
  if( !p )
    imp_cast_iq_throw_error( iq_name, typeName(iq), TypeNameTraits<T>::name() );
  return *p;  
}

template<class T>
//inline
const IterQuantityAccess<T>& cast_iq(
  const AlgorithmState& state, const std::string& iq_name )
{
  const IterQuantity
     &iq = state.iter_quant( iq_name );
  const IterQuantityAccess<T>
    *p = dynamic_cast<const IterQuantityAccess<T>*>( &iq );
      // will throw exception if iq_name does not exist
  if( !p )
    imp_cast_iq_throw_error( iq_name, typeName(iq), TypeNameTraits<T>::name() );
  return *p;  
}

template<class T>
//inline
IterQuantityAccess<T>& cast_iq(
  AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name )
{
  IterQuantity
     &iq = state.iter_quant( iq_id );
  IterQuantityAccess<T>
    *p = dynamic_cast<IterQuantityAccess<T>*>( &iq );
      // will throw exception if iq_name does not exist
  if( !p )
    imp_cast_iq_throw_error( iq_id, iq_name, typeName(iq), TypeNameTraits<T>::name() );
  return *p;  
}

template<class T>
//inline
const IterQuantityAccess<T>& cast_iq(
  const AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name )
{
  IterQuantity
     &iq = state.iter_quant( iq_id );
  const IterQuantityAccess<T>
    *p = dynamic_cast<const IterQuantityAccess<T>*>( &iq );
      // will throw exception if iq_name does not exist
  if( !p )
    imp_cast_iq_throw_error( iq_id, iq_name, typeName(iq), TypeNameTraits<T>::name() );
  return *p;
}

} // namespace IterationPack

#endif  // GIP_CAST_IQ_H