desmoj.core.report

Class DebugFileOut

java.lang.Object

desmoj.core.report.FileOutput

desmoj.core.report.TableOutput

desmoj.core.report.DebugFileOut

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

ASCIIDebugOutput, HTMLDebugOutput

public class DebugFileOut
extends TableOutput
implements MessageReceiver

DebugOut is used to create a file to write the DebugNotes to. It receives a DebugNotes and divides its individual text information up to be displayed in HTML format on disc in the user's local directory. The messages are displayed in a tabular design with columns for:

• The point of simulation time the DebugNote was created
• The ModelComponent's name responsible for sending the DebugNote
• The textual description of the ModelComponent's current state

Note that if the framework is used as an Applet in webpages there is no access to the disc and an alternative output on screen or into a graphics window must be registered at the Experiment's MessageManager for this type of messages. Errors affecting the java runtime are always displayed on the system's standard output PrintStream.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler, modified by Nicolas Knaak Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields inherited from class desmoj.core.report.TableOutput

DEFAULT_FORMATTER

Fields inherited from class desmoj.core.report.FileOutput

NORMAL_FILE_ACCESS

Constructor Summary

Constructors

Constructor and Description
DebugFileOut(int simTimeFloatingDigits, java.lang.String format) Creates a DebugOut to print DebugNotes into a HTML page.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this DebugOut.
void	open(java.lang.String name) Opens a new file with the given filename for writing DebugNotes into a HTML table.
void	open(java.lang.String pathname, java.lang.String name) Opens a new file with the given file- and pathname for writing DebugNotes into a HTML table.
void	receive(Message m) Receives a debugnote and writes its contents formatted to a HTML table into a file in the user's default directory.
void	receive(Reporter r) Reporters are not handled by this class so this method simply returns.

Methods inherited from class desmoj.core.report.FileOutput

getEndOfLine, getFileName, getSeparator, isEmpty, isOpen, setEndOfLine, setFileSystemAccess, setSeparator, write, writeln, writeSep

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugFileOut

public DebugFileOut(int simTimeFloatingDigits,
                    java.lang.String format)

Creates a DebugOut to print DebugNotes into a HTML page. By opening the file, the necessary HTML tags to define a webpage are already inserted into the file. The parameter given should reflect the experiment that produces this file.

Parameters:

simTimeFloatingDigits - int : The number of floating point digits of the simulation time values to be displayed

Method Detail

close

public void close()

Closes this DebugOut. Writes the final necessary HTML-tags to close a table row, the table and finish the HTML-page. Flushes and closes the FileOutputStream thereafter.

Overrides:

close in class TableOutput

open

public void open(java.lang.String name)

Opens a new file with the given filename for writing DebugNotes into a HTML table. The output path is set to the working directory. If no filename is given, the default filename "DESMOJ_debugfile.html" is used.

Overrides:

open in class TableOutput

Parameters:

name - java.lang.String : The name of the file to be created

open

public void open(java.lang.String pathname,
                 java.lang.String name)

Opens a new file with the given file- and pathname for writing DebugNotes into a HTML table. If no filename is given, the default filename "DESMOJ_debugfile.html" is used. If no pathname is given the current working directory (stored as property "user.dir") is used.

Parameters:

name - java.lang.String : The name of the file to be created

pathname - java.lang.String : The file's output path

receive

public void receive(Message m)

Receives a debugnote and writes its contents formatted to a HTML table into a file in the user's default directory. Note that although any type of message may be given to this method, only debugnotes will be processed. If other types of messages are given to this method, it will simply return doing nothing.

Specified by:

receive in interface MessageReceiver

Parameters:

m - Message : The DebugNote to be written to file in HTML-table format

receive

public void receive(Reporter r)

Reporters are not handled by this class so this method simply returns.

Specified by:

receive in interface MessageReceiver

Parameters:

r - Reporter : The reporter to be processed