desmoj.core.report

Class Message

java.lang.Object

desmoj.core.report.Message

Direct Known Subclasses:

CrossbarMessage, DebugNote, ErrorMessage, TraceNote

public class Message
extends java.lang.Object

Base class for all message types used in the DESMO-J framework. Provides the basic functionality and information common to all messages. Other Messages must be derived from this class and extend the attributes to transport the desired information. This allows for adding custom message bearing specific information. Given the references to the objects to be displayed in a message, the constructor extracts their names if possible. In case of null references given as parameters, the String "----" is taken instead.

Version:

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

Author:

Tim Lechler, modified by Ruth Meyer 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
Message(Model origin, java.lang.String description, TimeInstant time) Constructs a message with the given parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the textual description of this message as a String.
java.lang.String	getExperimentName()
java.lang.String	getModelName() Returns the name of the model that produced this message.
TimeInstant	getSendTime() Returns the time the message was (created) sent as a TimeInstant object.
java.lang.String	getTime() Returns the point of simulation time that this message was created as a String.
java.lang.String	toString() Overrides the Object's toString() method to return the message's description when this object is used as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

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

Constructs a message with the given parameters.

Parameters:

origin - Model : The model that produced this message

description - java.lang.String : The actual message text

time - TimeInstant : The point in simulation time this message was created

Method Detail

getDescription

public java.lang.String getDescription()

Returns the textual description of this message as a String.

Returns:

java.lang.String : The message's description

getModelName

public java.lang.String getModelName()

Returns the name of the model that produced this message.

Returns:

java.lang.String : The the name of the model that produced this message

getExperimentName

public java.lang.String getExperimentName()

getSendTime

public TimeInstant getSendTime()

Returns the time the message was (created) sent as a TimeInstant object.

Returns:

desmoj.core.simulator.TimeInstant : The time the message was sent as a TimeInstant object.

getTime

public java.lang.String getTime()

Returns the point of simulation time that this message was created as a String.

Returns:

java.lang.String : the point of simulation time this message was created

toString

public java.lang.String toString()

Overrides the Object's toString() method to return the message's description when this object is used as a String.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String : The message's description