IterationPack: General framework for building iterative algorithms Version of the Day
IterationPack_CastIQMember.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef CAST_IQ_MEMBER_H
00043 #define CAST_IQ_MEMBER_H
00044 
00045 #include <limits.h>
00046 
00047 #include <typeinfo>
00048 
00049 #include "IterationPack_AlgorithmState.hpp"
00050 #include "IterationPack_IterQuantityAccess.hpp"
00051 
00052 namespace IterationPack {
00053 
00058 class CastIQMemberBase {
00059 public:
00062   const std::string& iq_name() const;
00065   bool exists_in( const AlgorithmState& s ) const;
00066 protected:
00068   CastIQMemberBase( const std::string iq_name );
00070   void cache_iq_id( const AlgorithmState& s ) const;
00072   void throw_cast_error( const AlgorithmState::iq_id_type iq_id, const std::string& iqa_name ) const;
00074   const std::string         iq_name_;
00076   mutable AlgorithmState::iq_id_type  iq_id_;
00077 private:
00078   enum { NOT_SET_YET = AlgorithmState::DOES_NOT_EXIST - 1 };
00079   CastIQMemberBase(); // not defined and not to be called.
00080 };  // end class CastIQMemberBase
00081 
00153 template < class T >
00154 class CastIQMember : public CastIQMemberBase {
00155 public:
00157   CastIQMember( const std::string iq_name );
00167   IterQuantityAccess<T>& operator()( AlgorithmState& s ) const;
00169   const IterQuantityAccess<T>& operator()( const AlgorithmState& s ) const;
00170 private:
00171   CastIQMember(); // not defined and not to be called
00172 };  // end class CastIQMember<T>
00173 
00174 // //////////////////////////////////////////
00175 // Definition of template members
00176 
00177 template < class T >
00178 CastIQMember<T>::CastIQMember( const std::string iq_name )
00179   :  CastIQMemberBase(iq_name)
00180 {}
00181 
00182 template < class T >
00183 IterQuantityAccess<T>&
00184 CastIQMember<T>::operator()( AlgorithmState& s ) const
00185 {
00186   cache_iq_id(s);
00187   if( iq_id_ == AlgorithmState::DOES_NOT_EXIST )
00188     throw_cast_error(iq_id_,TypeNameTraits<T>::name());
00189   IterQuantityAccess<T>
00190     *p = dynamic_cast<IterQuantityAccess<T>*>( &s.iter_quant( iq_id_ ) );
00191   if( !p )
00192     throw_cast_error(iq_id_,TypeNameTraits<T>::name());
00193   return *p;  
00194 }
00195 
00196 template < class T >
00197 const IterQuantityAccess<T>&
00198 CastIQMember<T>::operator()( const AlgorithmState& s ) const
00199 {
00200   cache_iq_id(s);
00201   if( iq_id_ == AlgorithmState::DOES_NOT_EXIST )
00202     throw_cast_error(iq_id_,TypeNameTraits<T>::name());
00203   const IterQuantityAccess<T>
00204     *p = dynamic_cast<const IterQuantityAccess<T>*>( &s.iter_quant( iq_id_ ) );
00205   if( !p )
00206     throw_cast_error(iq_id_,TypeNameTraits<T>::name());
00207   return *p;  
00208 }
00209 
00210 } // namespace IterationPack
00211 
00212 #endif  // CAST_IQ_MEMBER_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends