SimLogger (Open Traffic Sim core classes 1.00.02 API)

java.lang.Object
- org.opentrafficsim.base.logger.CategoryLogger
- - org.opentrafficsim.core.logger.SimLogger

```
public class SimLogger
extends CategoryLogger
```
SimLogger, "extends" the CategoryLogger to be simulator aware and able to print the simulator time as part of the log message.

Copyright (c) 2003-2018 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl. The source code and binary code of this software is proprietary information of Delft University of Technology.

Author:

Alexander Verbraeck

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SimLogger.DelegateSimLogger
DelegateSimLogger class that takes care of actually logging the message and/or exception.
- Nested classes/interfaces inherited from class org.opentrafficsim.base.logger.CategoryLogger
  CategoryLogger.DelegateLogger

Nested Classes
Modifier and Type	Class and Description
`static class`	`SimLogger.DelegateSimLogger` DelegateSimLogger class that takes care of actually logging the message and/or exception.

Field Summary
- Fields inherited from class org.opentrafficsim.base.logger.CategoryLogger
  categories, DEFAULT_MESSAGE_FORMAT, delegateLogger, noLogger

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addLogCategory(LogCategory logCategory)` Add a category to be logged to the Writers.
`static CategoryLogger.DelegateLogger`	`always()` The "pass" filter that will result in always trying to log.
`protected static void`	`create()` Create a new logger for the system console.
`static CategoryLogger.DelegateLogger`	`filter(LogCategory... logCategories)` Check whether the provided categories contain one or more categories that need to be logged.
`static CategoryLogger.DelegateLogger`	`filter(LogCategory logCategory)` Check whether the provided category needs to be logged.
`static CategoryLogger.DelegateLogger`	`filter(Set<LogCategory> logCategories)` Check whether the provided categories contain one or more categories that need to be logged.
`static void`	`removeLogCategory(LogCategory logCategory)` Remove a category to be logged to the Writers.
`static void`	`setAllLogLevel(org.pmw.tinylog.Level newLevel)` Set a new logging level for all registered writers.
`static void`	`setAllLogMessageFormat(String newMessageFormat)` Set a new logging format for the message lines of all writers.
`static void`	`setLogCategories(LogCategory... newLogCategories)` Set the categories to be logged to the Writers.
`static void`	`setLogLevel(org.pmw.tinylog.writers.Writer writer, org.pmw.tinylog.Level newLevel)` Set a new logging level for one of the registered writers.
`static void`	`setLogMessageFormat(org.pmw.tinylog.writers.Writer writer, String newMessageFormat)` Set a new logging format for the message lines of a writer.
`static void`	`setSimulator(SimulatorInterface<?,?,?> newSimulator)` Set the simulator of which to include the time in the log messages.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
protected static void create()
```
    Create a new logger for the system console. Note that this REPLACES current loggers, so create this class before ANY other loggers are created. Note that the initial LogCategory is LogCategory.ALL, so all categories will be logged. This category has to be explicitly removed (or new categories have to be set) to log a limited set of categories.
  - setSimulator
```
public static final void setSimulator(SimulatorInterface<?,?,?> newSimulator)
```
    Set the simulator of which to include the time in the log messages.
    
    Parameters:
    
    newSimulator - the simulator to set
  - setAllLogMessageFormat
```
public static void setAllLogMessageFormat(String newMessageFormat)
```
    Set a new logging format for the message lines of all writers. The default message format is:
    {class_name}.{method}:{line} {message|indent=4}
    
    A few popular placeholders that can be used:
    - {class} Fully-qualified class name where the logging request is issued
    - {class_name} Class name (without package) where the logging request is issued
    - {date} Date and time of the logging request, e.g. {date:yyyy-MM-dd HH:mm:ss} [SimpleDateFormat]
    - {level} Logging level of the created log entry
    - {line} Line number from where the logging request is issued
    - {message} Associated message of the created log entry
    - {method} Method name from where the logging request is issued
    - {package} Package where the logging request is issued
    
    Parameters:
    
    newMessageFormat - the new formatting pattern to use for all registered writers
    
    See Also:
    
    https://tinylog.org/configuration
  - setAllLogLevel
```
public static void setAllLogLevel(org.pmw.tinylog.Level newLevel)
```
    Set a new logging level for all registered writers.
    
    Parameters:
    
    newLevel - the new log level for all registered writers
  - setLogMessageFormat
```
public static void setLogMessageFormat(org.pmw.tinylog.writers.Writer writer,
                                       String newMessageFormat)
```
    Set a new logging format for the message lines of a writer. The default message format is:
    {class_name}.{method}:{line} {message|indent=4}
    
    A few popular placeholders that can be used:
    - {class} Fully-qualified class name where the logging request is issued
    - {class_name} Class name (without package) where the logging request is issued
    - {date} Date and time of the logging request, e.g. {date:yyyy-MM-dd HH:mm:ss} [SimpleDateFormat]
    - {level} Logging level of the created log entry
    - {line} Line number from where the logging request is issued
    - {message} Associated message of the created log entry
    - {method} Method name from where the logging request is issued
    - {package} Package where the logging request is issued
    
    Parameters:
    
    writer - the writer to change the mesage format for
    
    newMessageFormat - the new formatting pattern to use for all registered writers
    
    See Also:
    
    https://tinylog.org/configuration
  - setLogLevel
```
public static void setLogLevel(org.pmw.tinylog.writers.Writer writer,
                               org.pmw.tinylog.Level newLevel)
```
    Set a new logging level for one of the registered writers.
    
    Parameters:
    
    writer - the writer to change the log level for
    
    newLevel - the new log level for the writer
  - addLogCategory
```
public static void addLogCategory(LogCategory logCategory)
```
    Add a category to be logged to the Writers.
    
    Parameters:
    
    logCategory - the LogCategory to add
  - removeLogCategory
```
public static void removeLogCategory(LogCategory logCategory)
```
    Remove a category to be logged to the Writers.
    
    Parameters:
    
    logCategory - the LogCategory to remove
  - setLogCategories
```
public static void setLogCategories(LogCategory... newLogCategories)
```
    Set the categories to be logged to the Writers.
    
    Parameters:
    
    newLogCategories - the LogCategories to set, replacing the previous ones
  - always
```
public static CategoryLogger.DelegateLogger always()
```
    The "pass" filter that will result in always trying to log.
    
    Returns:
    
    the logger that tries to execute logging (delegateLogger)
  - filter
```
public static CategoryLogger.DelegateLogger filter(LogCategory logCategory)
```
    Check whether the provided category needs to be logged. Note that when LogCategory.ALL is contained in the categories, filter will return true.
    
    Parameters:
    
    logCategory - the category to check for.
    
    Returns:
    
    the logger that either tries to log (delegateLogger), or returns without logging (noLogger)
  - filter
```
public static CategoryLogger.DelegateLogger filter(LogCategory... logCategories)
```
    Check whether the provided categories contain one or more categories that need to be logged. Note that when LogCategory.ALL is contained in the categories, filter will return true.
    
    Parameters:
    
    logCategories - LogCategory...; elements or array with the categories to check for
    
    Returns:
    
    the logger that either tries to log (delegateLogger), or returns without logging (noLogger)
  - filter
```
public static CategoryLogger.DelegateLogger filter(Set<LogCategory> logCategories)
```
    Check whether the provided categories contain one or more categories that need to be logged. Note that when LogCategory.ALL is contained in the categories, filter will return true.
    
    Parameters:
    
    logCategories - Set<LogCategory>; the categories to check for
    
    Returns:
    
    the logger that either tries to log (delegateLogger), or returns without logging (noLogger)

Class SimLogger

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.base.logger.CategoryLogger

Field Summary

Fields inherited from class org.opentrafficsim.base.logger.CategoryLogger

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

setSimulator

setAllLogMessageFormat

setAllLogLevel

setLogMessageFormat

setLogLevel

addLogCategory

removeLogCategory

setLogCategories

always

filter

filter

filter