Class LoggerParameters

java.lang.Object

log.LoggerParameters

public class LoggerParameters
extends Object

Parameters of a JMT logger: the path, name and options of the output file written during a simulation.

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	boolExecTimestamp
Boolean	boolJobClass
Boolean	boolJobID
Boolean	boolLoggername
Boolean	boolTimeAnyClass
Boolean	boolTimeSameClass
Boolean	boolTimeStamp
static final String	GLOBALLOGNAME
boolean	isEnabled
static final int	LOGGER_AR_APPEND
static final int	LOGGER_AR_ASK
static final int	LOGGER_AR_REPLACE
String	name
String	path

Constructor Summary

Constructors

Constructor	Description
LoggerParameters()	Creates a logger with default parameters.
LoggerParameters(String FN, String FP, Boolean ET, Boolean LN, Boolean TS, Boolean JID, Boolean JC, Boolean TSC, Boolean TAC)	Creates a logger with most parameters specified as a string.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a deep copy of this object.
void	disable()
boolean	enable()
boolean	isEnabled()	Convenience: Calculates if the logger should log to a file
boolean	isGlobal()
final String	toString()

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

isEnabled

public volatile boolean isEnabled

name

public String name

path

public String path

boolExecTimestamp

public Boolean boolExecTimestamp

boolLoggername

public Boolean boolLoggername

boolTimeStamp

public Boolean boolTimeStamp

boolJobID

public Boolean boolJobID

boolJobClass

public Boolean boolJobClass

boolTimeSameClass

public Boolean boolTimeSameClass

boolTimeAnyClass

public Boolean boolTimeAnyClass

LOGGER_AR_ASK

public static final int LOGGER_AR_ASK

See Also:

• Constant Field Values

LOGGER_AR_REPLACE

public static final int LOGGER_AR_REPLACE

See Also:

• Constant Field Values

LOGGER_AR_APPEND

public static final int LOGGER_AR_APPEND

See Also:

• Constant Field Values

GLOBALLOGNAME

public static final String GLOBALLOGNAME

See Also:

• Constant Field Values

Constructor Details

LoggerParameters

public LoggerParameters()

Creates a logger with default parameters.

LoggerParameters

public LoggerParameters(String FN,
 String FP,
 Boolean ET,
 Boolean LN,
 Boolean TS,
 Boolean JID,
 Boolean JC,
 Boolean TSC,
 Boolean TAC)

Creates a logger with most parameters specified as a string. Used by NodeSections.LogTunnel class.

Method Details

clone

public Object clone()

Returns a deep copy of this object.

Overrides:

clone in class Object

Returns:

A deep copy of this object.

toString

public final String toString()

Overrides:

toString in class Object

Returns:

String representation of all variables of LoggerParameters instance.

isEnabled

public boolean isEnabled()

Convenience: Calculates if the logger should log to a file

Returns:

Returns true if (1) the logger is enabled, and (2) if there is something to log

enable

public boolean enable()

disable

public void disable()

isGlobal

public boolean isGlobal()