ms_clusterparams.hpp

/*
##############################################################################
# file: ms_clusterparams.hpp                                                 #
# 'msparser' toolkit                                                         #
# Encapsulates "mascot.dat"-file that describes most important parameters    #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2003 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_clusterparams.hpp       $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_CLUSTERPARAMS_HPP
#define MS_CLUSTERPARAMS_HPP


#include <string>


namespace matrix_science {
    enum OPERATING_SYS
    {
        _OS_UNKNOWN           = 0,   
        _OS_WINDOWS_NT        = 1,   
        _OS_LINUX             = 2,   
        _OS_NUM_OPERATING_SYS = 3    
    };


    class MS_MASCOTRESFILE_API ms_clusterparams: public ms_customproperty
    {
        friend class ms_datfile;
    public:

        enum {
            NUM_PROCESSORS_AUTO_DETECT = -1 
        };

        ms_clusterparams();

        ms_clusterparams(const ms_clusterparams& src);

        ~ms_clusterparams();

        void defaultValues();

        void copyFrom(const ms_clusterparams* right);

#ifndef SWIG

        ms_clusterparams& operator=(const ms_clusterparams& right);
#endif

        bool isSectionAvailable() const;

        void setSectionAvailable(const bool value);

        bool isEnabled() const;

        void setEnabled(const bool flag);

        const ms_computeraddress* getMasterComputer() const;

        void setMasterComputer(const ms_computeraddress* value);

        OPERATING_SYS getDefaultNodeOS() const;

        void setDefaultNodeOS(const OPERATING_SYS value);

        std::string getDefaultNodeHomeDir() const;

        void setDefaultNodeHomeDir(const char* str);

        int getDefaultPort() const;

        void setDefaultPort(const int value);

        std::string getDefaultNodeHomeDirFromMaster() const;

        void setDefaultNodeHomeDirFromMaster(const char* str);

        std::string getMascotNodeScript() const;

        void setMascotNodeScript(const char* str);

        std::string getMascotNodeRebootScript() const;

        void setMascotNodeRebootScript(const char* str);

        int getNumberOfSubClusters() const;

        void clearSubClusters();

        int getSubClusterID(const int index) const;

        int getSubClusterMaxCPU(const int index) const;

        void appendSubCluster(const int id, const int maxCPUs);

        // internal usage only
        int getThisSubClusterID() const;

        // internal usage only
        void setThisSubClusterID(const int id);

        int getIPCTimeout() const;

        void setIPCTimeout(const int value);

        int getIPCLogging() const;

        void setIPCLogging(const int value);

        std::string getIPCLogfile() const;

        void setIPCLogfile(const char* str);

        int getCheckNodesAliveFreq() const;

        void setCheckNodesAliveFreq(const int value);

        int getSecsToWaitForNodeAtStartup() const;

        void setSecsToWaitForNodeAtStartup(const int value);

        std::string getNodeSequenceDatabaseDir() const;

        void setNodeSequenceDatabaseDir(const char* str);

#ifdef SUPPRESS_MS_CUSTOMPROPERTY_INHERITANCE
#include "suppress_ms_customproperty.hpp"
#endif

    private:
        bool            sectionAvailable_;
        bool            enabled_;

        ms_computeraddress masterComputer_;

        OPERATING_SYS   defaultNodeOS_;
        std::string     szDefaultNodeHomeDir_;
        int             defaultPort_;
        std::string     szDefaultNodeHomeDirFromMaster_;
        std::string     szMascotNodeScript_;
        std::string     szMascotNodeRebootScript_;

        std::vector<int> subClusterIDs_;
        std::vector<int> maxCpusPerSubCluster_;
        bool             anySubCluster_;

        int             thisSubCluster_;

        int             IPCTimeout_;
        int             IPCLogging_;
        std::string     IPCLogfile_;
        int             checkNodesAliveFreq_;
        int             secsToWaitForNodeAtStartup_;

        std::string     szNodeSequenceDatabaseDir_;
    }; // class ms_clusterparams // end of config_group
} // namespace matrix_science

#endif // MS_CLUSTERPARAMS_HPP

/*------------------------------- End of File -------------------------------*/