MoochoPack: Miscellaneous Utilities for MOOCHO Version of the Day
StandardCompositionRelationshipsPack.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 STANDARD_COMPOSITION_RELATIONSHIPS_PACK_H
00043 #define STANDARD_COMPOSITION_RELATIONSHIPS_PACK_H
00044 
00045 #include "Moocho_ConfigDefs.hpp"
00046 #include "Teuchos_Assert.hpp"
00047 
00048 namespace StandardCompositionRelationshipsPack {
00049 
00056 
00058 class NoRefSet : public std::logic_error
00059 {public: NoRefSet(const std::string& what_arg) : std::logic_error(what_arg) {}};
00060 
00061 // Throw a NoRefSet exception
00062 inline void ThrowNoRefSet(const char func_name[], const char name[])
00063 {
00064   TEUCHOS_TEST_FOR_EXCEPTION(
00065     true,NoRefSet
00066     ,func_name << ": The reference for \'" << name << "\' has not been set yet"
00067     );
00068 }
00069 
00071 template<class ContainedClass>
00072 inline void assert_role_name_set(const ContainedClass* role_name_, const char func_name[]
00073   , const char name[])
00074 {
00075   if(!role_name_) ThrowNoRefSet(func_name, name);
00076 }
00077 
00079 template<class ContainedClass>
00080 inline void set_role_name(ContainedClass*& role_name_, bool& owns_role_name_, const char name[]
00081   , ContainedClass* role_name, bool owns_role_name)
00082 {
00083   if(owns_role_name_ && role_name_ != role_name) delete role_name_;
00084   role_name_ = role_name; owns_role_name_ = owns_role_name;
00085 }
00086 
00088 template<class ContainedClass>
00089 inline ContainedClass* get_role_name(ContainedClass* role_name_, bool owns_role_name_
00090   , const char name[])
00091 {
00092   return role_name_;
00093 }
00094 
00096 template<class ContainedClass>
00097 inline void set_owns_role_name(ContainedClass*& role_name_, bool& owns_role_name_
00098   , const char name[], bool owns_role_name)
00099 {
00100   assert_role_name_set(role_name_, "set_owns_role_name()", name);
00101   owns_role_name_ = owns_role_name;
00102 }
00103 
00105 template<class ContainedClass>
00106 inline bool owns_role_name(ContainedClass* role_name_, bool owns_role_name_, const char name[])
00107 {
00108   assert_role_name_set(role_name_, "owns_role_name()", name);
00109   return owns_role_name_;
00110 }
00111 
00113 template<class ContainedClass>
00114 inline ContainedClass& role_name(ContainedClass* role_name_, bool owns_role_name_, const char name[])
00115 {
00116   assert_role_name_set(role_name_, "role_name()", name);
00117   return *role_name_;
00118 }
00119 
00121 template<class ContainedClass>
00122 inline const ContainedClass& role_name(const ContainedClass* role_name_, bool owns_role_name_, const char name[])
00123 {
00124   assert_role_name_set(role_name_, "role_name()", name);
00125   return *role_name_;
00126 }
00127 
00129 template<class ContainedClass>
00130 inline const ContainedClass& const_role_name(const ContainedClass* role_name_, bool owns_role_name_, const char name[])
00131 {
00132   assert_role_name_set(role_name_, "role_name()", name);
00133   return *role_name_;
00134 }
00135 
00136 
00138 template<class ContainedClass>
00139 inline void destory_container_obj(ContainedClass* role_name_, bool owns_role_name_)
00140 {
00141   if(owns_role_name_) delete role_name_;
00142 }
00143 
00145 
00146 } // end namespace StandardCompositionRelationshipsPack
00147 
00148 #endif // STANDARD_COMPOSITION_RELATIONSHIPS_PACK_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends