MOAB: Mesh Oriented datABase  (version 5.2.1)
Wrapper.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2009 Sandia National Laboratories.  Developed at the
00005     University of Wisconsin--Madison under SNL contract number
00006     624796.  The U.S. Government and the University of Wisconsin
00007     retain certain rights to this software.
00008 
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00011     License as published by the Free Software Foundation; either
00012     version 2.1 of the License, or (at your option) any later version.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018 
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 
00023     (2009) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file Wrapper.hpp
00028  *  \brief Common interface implemented by wrappers.
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_WRAPPER_HPP
00033 #define MSQ_WRAPPER_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include "IQInterface.hpp"
00037 
00038 namespace MBMesquite
00039 {
00040 
00041 class QualityAssessor;
00042 
00043 /**\brief Interface for wrappers.
00044  *
00045  * Interaface implemented by wrappers.  In addition to implementing
00046  * IQInterface, also provide access to QualityAssessor instance so
00047  * that caller can modify QA output.
00048  */
00049 class MESQUITE_EXPORT Wrapper : public IQInterface
00050 {
00051   public:
00052     Wrapper();
00053 
00054     virtual ~Wrapper();
00055 
00056     /** Get the quality assessor associated with this wrapper */
00057     inline QualityAssessor& quality_assessor()
00058     {
00059         return *qualAssessor;
00060     }
00061 
00062     /** Get the quality assessor associated with this wrapper */
00063     inline const QualityAssessor& quality_asssessor() const
00064     {
00065         return *qualAssessor;
00066     }
00067 
00068   protected:
00069     /** Function inherited from IQInterface that we implement here */
00070     void run_common( MeshDomainAssoc* mesh_and_domain, ParallelMesh* pmesh, Settings* settings, MsqError& err );
00071 
00072     /** Function that each wrapper must implement */
00073     virtual void run_wrapper( MeshDomainAssoc* mesh_and_domain, ParallelMesh* pmesh, Settings* settings,
00074                               QualityAssessor* quality_assessor, MsqError& err ) = 0;
00075 
00076   private:
00077     QualityAssessor* qualAssessor;
00078 };
00079 
00080 }  // namespace MBMesquite
00081 
00082 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines