loggers

Class ManualLogger

java.lang.Object

loggers.ManualLogger

Direct Known Subclasses:

AcceptanceLogger, PenaltiesLogger

public abstract class ManualLogger
extends java.lang.Object

ManualLogger is an abstract class implementing all common methods required for the logging system. All loggers should extend this class.

Since:

0.0

Version:

1.0

Author:

Joeri Ruyssinck (joeri.ruysssinck@intec.ugent.be)

Constructor Summary

Constructors

Constructor and Description
ManualLogger(int loggingInterval, java.lang.String logFile, java.io.File outputDir) Constructs a new Manuallogger (abstract class, cannot be called directly)

Method Summary

Modifier and Type	Method and Description
abstract void	advice(EnsembleSA sa) Abstract method that allows the logger to intervene in the optimization process and perform actions when its advice is requested
void	deleteFile()
int	getIterations() Getter which return frequency of logging
int	getIterationsSoFar() Getter which return frequency of logging
java.lang.String	getLogFile() Getter which returns the log filename
boolean	isFired() Getter which returns if the logger is ready to send feedback
boolean	isPositive() Getter which returns if the logger is positive on the current optimization process
void	log(NetworkSA getter)
abstract ManualLogger	makeCopy(java.lang.String suffix) Copy constructor for this logger, with a new output filename
void	setFired(boolean fired) Setter to indicate if logger is ready to send feedback
void	setLogFile(java.lang.String logFile) Setter to set the log filename
void	setPositive(boolean positive) Setter which sets logger's opinion on optimization process
void	toFile()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManualLogger

public ManualLogger(int loggingInterval,
                    java.lang.String logFile,
                    java.io.File outputDir)

Constructs a new Manuallogger (abstract class, cannot be called directly)

Parameters:

loggingInterval - perform logging action every 'loggingInterval' changes to the network

logFile - name of output file

outputDir - name/path of the output directory

Method Detail

advice

public abstract void advice(EnsembleSA sa)

Abstract method that allows the logger to intervene in the optimization process and perform actions when its advice is requested

makeCopy

public abstract ManualLogger makeCopy(java.lang.String suffix)

Copy constructor for this logger, with a new output filename

isFired

public boolean isFired()

Getter which returns if the logger is ready to send feedback

Returns:

boolean if logger is ready to send feedback

isPositive

public boolean isPositive()

Getter which returns if the logger is positive on the current optimization process

Returns:

boolean if logger is positive on the current optimization

setPositive

public void setPositive(boolean positive)

Setter which sets logger's opinion on optimization process

Parameters:

positive - logger's opinion on optimization process

setFired

public void setFired(boolean fired)

Setter to indicate if logger is ready to send feedback

Parameters:

fired - logger is ready to send feedback

getLogFile

public java.lang.String getLogFile()

Getter which returns the log filename

Returns:

log filename

setLogFile

public void setLogFile(java.lang.String logFile)

Setter to set the log filename

Parameters:

String - log filename

getIterations

public int getIterations()

Getter which return frequency of logging

Returns:

logging frequency

getIterationsSoFar

public int getIterationsSoFar()

Getter which return frequency of logging

Returns:

logging frequency

log

public void log(NetworkSA getter)

deleteFile

public void deleteFile()

toFile

public void toFile()