Monitor.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2021 Marco Foscato <marco.foscato@uib.no>
 * 
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.logging;
 
import java.util.HashMap;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Level;
import java.util.logging.Logger;
 
import denoptim.exception.DENOPTIMException;
import denoptim.io.DenoptimIO;
 
public class Monitor extends HashMap<CounterID,AtomicInteger> 
{
    private static final long serialVersionUID = 1L;
    
    public String name = "noname";
    
    private String monitorFile = "unset.eamonitor";
    
    private int dumpStep = 50;
    
    private boolean dumpData = false;
    
    public int generationId = 0;
    
    private int dumpsId = 0;
    
    private Logger logger;
    
    private final String NL = System.getProperty("line.separator");
 
//------------------------------------------------------------------------------
    
    public Monitor()
    {
        super();
        for (CounterID cid : CounterID.values())
        {
            this.put(cid,new AtomicInteger());
        }
    }
 
//------------------------------------------------------------------------------
    
    public Monitor(String identifier, int genId, String monitorFile, 
            int dumpStep, boolean dumpData, Logger logger)
    {
        this();
        name = identifier;
        generationId = genId;
        this.monitorFile = monitorFile;
        this.dumpStep = dumpStep;
        this.dumpData = dumpData;
        this.logger = logger;
    }
    
//------------------------------------------------------------------------------
    
    public void changeBy(CounterID cid, int value)
    {
        String dump = "";
        synchronized (this)
        {
            this.get(cid).addAndGet(value);
            if (cid == CounterID.NEWCANDIDATEATTEMPTS)
            {
                dumpsId++;
                if (dumpData && dumpsId >= dumpStep)
                {
                    dumpsId = 0;
                    dump = getMonitorDataLine("DUMP");
                }
            }
        }
        if (!dump.equals(""))
        {
            try
            {
                printSnapshot(dump);
            } catch (DENOPTIMException e)
            {
                logger.log(Level.WARNING,
                        "Unable to print monitor report: "+e.getMessage() + NL
                        + "Monitor report: " + NL + dump);
            }
        }
    }
    
//------------------------------------------------------------------------------
    
    public void increase(CounterID cid)
    {
        changeBy(cid,1);
    }
    
//------------------------------------------------------------------------------
    
    public void increaseBy(CounterID cid, int value)
    {
        changeBy(cid,value);
    }
    
//------------------------------------------------------------------------------
    
    public void decrease(CounterID cid)
    {
        changeBy(cid,-1);
    }
    
//------------------------------------------------------------------------------
    
    public void decreaseBy(CounterID cid, int value)
    {
        changeBy(cid,-value);
    }
    
//------------------------------------------------------------------------------
 
    public void printHeader(String pathName) throws DENOPTIMException
    {
        DenoptimIO.writeData(pathName, getMonitorDataHeader(), true);
    }
    
//------------------------------------------------------------------------------
 
    public void printSummary() throws DENOPTIMException
    {
        DenoptimIO.writeData(monitorFile, getMonitorDataLine("SUMMARY"), true);
    }
    
//------------------------------------------------------------------------------
 
    public void printSnapshot(String snapshot) throws DENOPTIMException
    {
        DenoptimIO.writeData(monitorFile, snapshot, true);
    }
 
//------------------------------------------------------------------------------
 
    private String getMonitorDataHeader()
    {
        StringBuilder sb = new StringBuilder();
        sb.append("RecordType MonitorName Generation ");
        synchronized (this)
            {
            for (CounterID cid : CounterID.values())
            {
                sb.append(cid).append(" ");
            }
        }
        return sb.toString();
    }
    
//------------------------------------------------------------------------------
 
    private String getMonitorDataLine(String prefix)
    {
        StringBuilder sb = new StringBuilder();
        sb.append(prefix).append(" ");
        sb.append(name).append(" ");
        sb.append(generationId).append(" ");
        synchronized (this)
            {
            for (CounterID cid : CounterID.values())
            {
                sb.append(this.get(cid).get()).append(" ");
            }
        }
        return sb.toString();
    }
    
//------------------------------------------------------------------------------
        
}