IterationPack_CastIQMember.hpp

Go to the documentation of this file.

// @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.
// 
// 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef CAST_IQ_MEMBER_H
#define CAST_IQ_MEMBER_H

#include <limits.h>

#include <typeinfo>

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

namespace IterationPack {

class CastIQMemberBase {
public:
  const std::string& iq_name() const;
  bool exists_in( const AlgorithmState& s ) const;
protected:
  CastIQMemberBase( const std::string iq_name );
  void cache_iq_id( const AlgorithmState& s ) const;
  void throw_cast_error( const AlgorithmState::iq_id_type iq_id, const std::string& iqa_name ) const;
  const std::string         iq_name_;
  mutable AlgorithmState::iq_id_type  iq_id_;
private:
  enum { NOT_SET_YET = AlgorithmState::DOES_NOT_EXIST - 1 };
  CastIQMemberBase(); // not defined and not to be called.
};  // end class CastIQMemberBase

template < class T >
class CastIQMember : public CastIQMemberBase {
public:
  CastIQMember( const std::string iq_name );
  IterQuantityAccess<T>& operator()( AlgorithmState& s ) const;
  const IterQuantityAccess<T>& operator()( const AlgorithmState& s ) const;
private:
  CastIQMember(); // not defined and not to be called
};  // end class CastIQMember<T>

// //////////////////////////////////////////
// Definition of template members

template < class T >
CastIQMember<T>::CastIQMember( const std::string iq_name )
  :  CastIQMemberBase(iq_name)
{}

template < class T >
IterQuantityAccess<T>&
CastIQMember<T>::operator()( AlgorithmState& s ) const
{
  cache_iq_id(s);
  if( iq_id_ == AlgorithmState::DOES_NOT_EXIST )
    throw_cast_error(iq_id_,TypeNameTraits<T>::name());
  IterQuantityAccess<T>
    *p = dynamic_cast<IterQuantityAccess<T>*>( &s.iter_quant( iq_id_ ) );
  if( !p )
    throw_cast_error(iq_id_,TypeNameTraits<T>::name());
  return *p;  
}

template < class T >
const IterQuantityAccess<T>&
CastIQMember<T>::operator()( const AlgorithmState& s ) const
{
  cache_iq_id(s);
  if( iq_id_ == AlgorithmState::DOES_NOT_EXIST )
    throw_cast_error(iq_id_,TypeNameTraits<T>::name());
  const IterQuantityAccess<T>
    *p = dynamic_cast<const IterQuantityAccess<T>*>( &s.iter_quant( iq_id_ ) );
  if( !p )
    throw_cast_error(iq_id_,TypeNameTraits<T>::name());
  return *p;  
}

} // namespace IterationPack

#endif  // CAST_IQ_MEMBER_H