AbstractApplication.h

Go to the documentation of this file.

/*
    This software is Copyright by the Board of Trustees of Michigan
    State University (c) Copyright 2017.

    You may use this software under the terms of the GNU public license
    (GPL).  The terms of this license are described at:

     http://www.gnu.org/licenses/gpl.txt

     Authors:
             Ron Fox
             Giordano Cerriza
         FRIB
         Michigan State University
         East Lansing, MI 48824-1321
*/

#ifndef ABSTRACTAPPLICATION_H
#define ABSTRACTAPPLICATION_H
#include <mpi.h>
namespace frib {
    namespace analysis {
        class CParameterReader;
        class AbstractApplication {
        private:
            // Keep the program arguments so that we can access them from the
            // methods.
            
            int m_argc;
            char** m_argv;
            unsigned m_nWorkers;
            int    m_rank;
        private:
            MPI_Datatype  m_messageHeaderType;
            MPI_Datatype  m_requestDataType;
            MPI_Datatype  m_parameterHeaderDataType;
            MPI_Datatype  m_parameterValueDataType;
            MPI_Datatype  m_parameterDefDataType;
            MPI_Datatype  m_variableDefDataType;
        public:
            AbstractApplication(int argc, char** argv);
            virtual ~AbstractApplication();
        private:
            AbstractApplication(const AbstractApplication& rhs);
            AbstractApplication& operator=(const AbstractApplication& rhs);
            int operator==(const AbstractApplication& rhs);
            int operator!=(const AbstractApplication& rhs);
            
        public:
            // Application entry point.
            
            virtual void operator()(CParameterReader& paramReader);
            
            // Roles in the program (Strategy methods).
            
            virtual void dealer(int argc, char** argv, AbstractApplication* pApp) = 0;  // Rank 0
            virtual void farmer(int argc, char** argv, AbstractApplication* pApp) = 0;  // Rank 1
            virtual void outputter(int argc, char** argv, AbstractApplication* pApp) = 0; // Rank 2
            virtual void worker(int argc, char** argv, AbstractApplication* pApp) = 0;  // Rank 3-n.
            
            // Get message header data type
            
            MPI_Datatype& messageHeaderType();
            MPI_Datatype& requestDataType();
            MPI_Datatype& parameterHeaderDataType();
            MPI_Datatype& parameterValueDataType();
            MPI_Datatype& parameterDefType();
            MPI_Datatype& variableDefType();
            
            unsigned numWorkers();
            
            // Code factored out of other bits of the system:
            
            void forwardPassThrough(const void* pData, size_t nBytes);
            int  getRequest();
            void sendEofs();
            void sendEof();
            void requestData(size_t maxBytes);
            void throwMPIError(int status, const char* reason);
            

            // Services for derived classes that might override operator():
        protected:            
            int getArgc() const;
            char** getArgv();            
            void makeDataTypes();
            
        };
        
         
    }
}

#endif