IterationPack: General framework for building iterative algorithms Version of the Day
IterationPack_CastIQMember.cpp
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 #include <string>
00043 #include <sstream>
00044  
00045 #include "IterationPack_CastIQMember.hpp"
00046 #include "Teuchos_Assert.hpp"
00047 
00048 namespace IterationPack {
00049 
00050 CastIQMemberBase::CastIQMemberBase( const std::string iq_name )
00051   :  iq_name_(iq_name), iq_id_(NOT_SET_YET)
00052 {}
00053 
00054 const std::string&
00055 CastIQMemberBase::iq_name() const
00056 {
00057   return iq_name_;
00058 }
00059 
00060 bool
00061 CastIQMemberBase::exists_in( const AlgorithmState& s ) const
00062 {
00063   cache_iq_id(s);
00064   return iq_id_ != AlgorithmState::DOES_NOT_EXIST;
00065 }
00066 
00067 void CastIQMemberBase::cache_iq_id( const AlgorithmState& s ) const
00068 {
00069   if( iq_id_ == NOT_SET_YET ) {
00070     iq_id_ = s.get_iter_quant_id( iq_name_ );
00071   }
00072 }
00073 
00074 void CastIQMemberBase::throw_cast_error( const AlgorithmState::iq_id_type iq_id, const std::string& iqa_name ) const
00075 {
00076   TEUCHOS_TEST_FOR_EXCEPTION(
00077     iq_id == AlgorithmState::DOES_NOT_EXIST, AlgorithmState::DoesNotExist
00078     ,"CastIQMember<T>::operator()(...) : Error, the iteration quantity \""
00079     << iq_name_ << "\" does not exist in this state object." );
00080   TEUCHOS_TEST_FOR_EXCEPTION(
00081     true, IterationPack::InvalidTypeCastException
00082     ,"CastIQMember<T>::operator()(state) : Error, the iteration quantity \""
00083     << iq_name_ << "\" exists but it is not of the type IterQuantityAccess<"
00084     << iqa_name << ">" );
00085 }
00086 
00087 } // namespace IterationPack
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends