desmoj.core.report

Class DebugNote

java.lang.Object

desmoj.core.report.Message

desmoj.core.report.DebugNote

public class DebugNote
extends Message

Represents a DebugNote produced by a simulation run whenever the modeller enables the debug mode for a specific ModelComponent. Provides the basic information needed to debug a model's changes of state:

• The Model this DebugNote originates from
• The point in simulation time that this DebugNote was issued
• The name of the ModelComponent that produced the DebugNote
• The textual debug information produced by that ModelComponent

Version:

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

Author:

Tim Lechler 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.

Constructor Summary

Constructors

Constructor and Description
DebugNote(Model origin, TimeInstant time, java.lang.String componentName, java.lang.String description) Constructs a debugnote with the given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOrigin() Returns the name of the modelcomponent that produced this debugnote.

Methods inherited from class desmoj.core.report.Message

getDescription, getExperimentName, getModelName, getSendTime, getTime, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugNote

public DebugNote(Model origin,
                 TimeInstant time,
                 java.lang.String componentName,
                 java.lang.String description)

Constructs a debugnote with the given parameters.

Parameters:

origin - Model : The model that produced this debugnote

description - java.lang.String : The actual debug information

time - TimeInstant : The point of simulation time this debugnote was created

componentName - java.lang.String : The name of the modelcomponent the debugnote evolved from

Method Detail

getOrigin

public java.lang.String getOrigin()

Returns the name of the modelcomponent that produced this debugnote.

Returns:

java.lang.String : The model that produced this debugnote