MOOCHO (Single Doxygen Collection) Version of the Day
IterationPack_cast_iq.hpp
Go to the documentation of this file.
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 GIP_CAST_IQ_H
00043 #define GIP_CAST_IQ_H
00044 
00045 #include <stdexcept>
00046 #include <typeinfo>
00047 
00048 #include "IterationPack_AlgorithmState.hpp"
00049 #include "IterationPack_IterQuantityAccess.hpp"
00050 
00051 namespace IterationPack {
00052 
00066 template<class T>
00067 IterQuantityAccess<T>& cast_iq(
00068   AlgorithmState& state, const std::string& iq_name );
00069 
00071 template<class T>
00072 const IterQuantityAccess<T>& cast_iq(
00073   const AlgorithmState& state, const std::string& iq_name );
00074 
00090 template<class T>
00091 IterQuantityAccess<T>& cast_iq(
00092   AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name );
00093 
00095 template<class T>
00096 const IterQuantityAccess<T>& cast_iq(
00097   const AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name );
00098 
00099 // Helper function
00100 
00101 void imp_cast_iq_throw_error(
00102   const std::string&                 iq_name
00103   ,const std::string&                iq_is_type_name
00104   ,const std::string&                iq_want_type_name
00105   );
00106 
00107 void imp_cast_iq_throw_error(
00108   const AlgorithmState::iq_id_type   iq_id
00109   ,const std::string&                iq_name
00110   ,const std::string&                iq_is_type_name
00111   ,const std::string&                iq_want_type_name
00112   );
00113 
00114 // ///////////////////
00115 // Inline definitions
00116 
00117 template<class T>
00118 //inline
00119 IterQuantityAccess<T>& cast_iq(
00120   AlgorithmState& state, const std::string& iq_name )
00121 {
00122   IterQuantity
00123      &iq = state.iter_quant( iq_name );
00124   IterQuantityAccess<T>
00125     *p = dynamic_cast<IterQuantityAccess<T>*>( &iq );
00126       // will throw exception if iq_name does not exist
00127   if( !p )
00128     imp_cast_iq_throw_error( iq_name, typeName(iq), TypeNameTraits<T>::name() );
00129   return *p;  
00130 }
00131 
00132 template<class T>
00133 //inline
00134 const IterQuantityAccess<T>& cast_iq(
00135   const AlgorithmState& state, const std::string& iq_name )
00136 {
00137   const IterQuantity
00138      &iq = state.iter_quant( iq_name );
00139   const IterQuantityAccess<T>
00140     *p = dynamic_cast<const IterQuantityAccess<T>*>( &iq );
00141       // will throw exception if iq_name does not exist
00142   if( !p )
00143     imp_cast_iq_throw_error( iq_name, typeName(iq), TypeNameTraits<T>::name() );
00144   return *p;  
00145 }
00146 
00147 template<class T>
00148 //inline
00149 IterQuantityAccess<T>& cast_iq(
00150   AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name )
00151 {
00152   IterQuantity
00153      &iq = state.iter_quant( iq_id );
00154   IterQuantityAccess<T>
00155     *p = dynamic_cast<IterQuantityAccess<T>*>( &iq );
00156       // will throw exception if iq_name does not exist
00157   if( !p )
00158     imp_cast_iq_throw_error( iq_id, iq_name, typeName(iq), TypeNameTraits<T>::name() );
00159   return *p;  
00160 }
00161 
00162 template<class T>
00163 //inline
00164 const IterQuantityAccess<T>& cast_iq(
00165   const AlgorithmState& state, const AlgorithmState::iq_id_type iq_id, const std::string& iq_name )
00166 {
00167   const IterQuantity
00168      &iq = state.iter_quant( iq_id );
00169   const IterQuantityAccess<T>
00170     *p = dynamic_cast<const IterQuantityAccess<T>*>( &iq );
00171       // will throw exception if iq_name does not exist
00172   if( !p )
00173     imp_cast_iq_throw_error( iq_id, iq_name, typeName(iq), TypeNameTraits<T>::name() );
00174   return *p;
00175 }
00176 
00177 } // namespace IterationPack
00178 
00179 #endif  // GIP_CAST_IQ_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines