desmoj.core.report

Class TraceNote

java.lang.Object

desmoj.core.report.Message

desmoj.core.report.TraceNote

public class TraceNote
extends Message

Represents a message produced by a simulation run whenever entities and / or events are scheduled, created, deleted or enqueued. Tracenotes document the changes of state of the model and allow modellers to trace and check the model's dynamic behaviour. The basic information needed to trace a model's changes of state are:

• The name of the Model this message was produced in
• The point of simulation time that this message was created
• The name of the event involved in the change of state
• The name of the entity or process involved in the change of state
• A text to describe the kind of changes made to the model

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
TraceNote(Model origin, java.lang.String message, TimeInstant time, Entity entityInvolved, EventAbstract eventInvolved) Creates a new tracenote with the given parameters as initial values.
TraceNote(Model origin, java.lang.String message, TimeInstant time, java.util.List<Entity> entitiesInvolved, EventAbstract eventInvolved) Creates a new tracenote with the given parameters as initial values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEntity() Returns the name of the entity this tracenote evolved from.
java.lang.String	getEvent() Returns the name of the event described in this tracenote from.

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

TraceNote

public TraceNote(Model origin,
                 java.lang.String message,
                 TimeInstant time,
                 Entity entityInvolved,
                 EventAbstract eventInvolved)

Creates a new tracenote with the given parameters as initial values. If null references are given, they are displayed as "----" in the trace output.

Parameters:

origin - Model : The model that produced this tracenote

message - java.lang.String : The actual trace message

time - TimeInstant : The point in simulation time this tracenote was produced

entityInvolved - Entity : The entity involved in this change of state

eventInvolved - Event : The event involved in this change of state

TraceNote

public TraceNote(Model origin,
                 java.lang.String message,
                 TimeInstant time,
                 java.util.List<Entity> entitiesInvolved,
                 EventAbstract eventInvolved)

Creates a new tracenote with the given parameters as initial values. If null references are given, they are displayed as "----" in the trace output.

Parameters:

origin - Model : The model that produced this tracenote

message - java.lang.String : The actual trace message

time - TimeInstant : The point in simulation time this tracenote was produced

entitiesInvolved - List : The entities involved in this change of state

eventInvolved - Event : The event involved in this change of state

Method Detail

getEntity

public java.lang.String getEntity()

Returns the name of the entity this tracenote evolved from.

Returns:

java.lang.String : The name of the entity that produced this tracenote

getEvent

public java.lang.String getEvent()

Returns the name of the event described in this tracenote from.

Returns:

java.lang.String : The name of the event that produced this tracenote