desmoj.core.simulator

Class Reportable

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

Direct Known Subclasses:

Block, BoolStatistic, DataListTally.DataList, Distribution, ExperimentRunner.ReportProvider, MessageChannel, MessageCrossbar, Model, QueueBased, SimulationRunReporter.SimulationRunReporterProvider, Station, StatisticObject, TextHistogram

public abstract class Reportable
extends ModelComponent

All classes that want to publish their information have to extend this class in order to provide the necessary functions to represent their information in reports.

Version:

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

Author:

Tim Lechler, modified by Chr. Müller (TH Wildau) 28.11.2012 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
Reportable(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Creates a reportable object with all parameters required.

Method Summary

Modifier and Type	Method and Description
Schedulable	getCorrespondingSchedulable() Gets the schedulable (e.g. entity) corresponding to this reportable; may be null if no schedulable corresponds to this reportable.
java.lang.String	getDescription() Get an optional description of reported value.
long	getObservations() Returns the number of observations made by the reportable object.
Reporter	getReporter() Returns an instance of a reporter for this reportable.
void	incrementObservations() Increments the number of observations made by this reportable by one (1).
void	incrementObservations(long multiObservations) Increments the number of observations by the amount given as parameter.
boolean	reportIsOn() Checks if this reportable produces a report.
void	reportOff() Switches report mode to prevent this reportable to produce reports.
void	reportOn() Switches report mode of this reportable on to produce a report.
void	reset() Resets the counter for observations made by this reportable.
TimeInstant	resetAt() Shows the point in simulation time when the last reset of this reportable was made.
void	setCorrespondingSchedulable(Schedulable correspondingSchedulable) Sets the schedulable (e.g. entity) corresponding to this Reportable.
void	setDescription(java.lang.String description) Set an optional description of reported value.
void	setReporter(java.lang.Class<? extends Reporter> reporterClass) Specifies a Reporter-Class to be used as reporter by this reportable.

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Reportable

public Reportable(Model owner,
                  java.lang.String name,
                  boolean showInReport,
                  boolean showInTrace)

Creates a reportable object with all parameters required. The reportable registers itself at the given model

Parameters:

name - java.lang.String : The name of this reportable

owner - Model : The model this reportable is associated to

showInReport - boolean : Flag for showing the report. Set it to true if reportable should show up in report. Set it to false if reportable should not be shown in report.

showInTrace - boolean : Flag for showing this reportable in trace files. Set it to true if reportable should show up in trace. Set it to false if reportable should not be shown in trace.

Method Detail

getReporter

public final Reporter getReporter()

Returns an instance of a reporter for this reportable. Note that every reportable has to provide a default reporter, see method createDefaultReporter(). The reporter returned by this method is such a default reporter.

Returns:

desmoj.core.report.Reporter : A reporter for this reportable

setReporter

public void setReporter(java.lang.Class<? extends Reporter> reporterClass)

Specifies a Reporter-Class to be used as reporter by this reportable. Note that such a Reporter has to provide a constructor requiring a reference to this object (i.e. the reportable to report about) as only parameter.
If this method is never called, a default reporter as obtained from createDefaultReporter() will be used.

Parameters:

reporterClass - the reporter's class

getObservations

public long getObservations()

Returns the number of observations made by the reportable object.

Returns:

long : The number of observations made by the reportable object.

incrementObservations

public void incrementObservations()

Increments the number of observations made by this reportable by one (1).

incrementObservations

public void incrementObservations(long multiObservations)

Increments the number of observations by the amount given as parameter.

Parameters:

multiObservations - long : The number to increase the number of observations by

reportIsOn

public boolean reportIsOn()

Checks if this reportable produces a report.

Returns:

boolean : true if report will be produced, false otherwise

reportOff

public void reportOff()

Switches report mode to prevent this reportable to produce reports.

reportOn

public void reportOn()

Switches report mode of this reportable on to produce a report.

reset

public void reset()

Resets the counter for observations made by this reportable. The point of simulation time this method was called will be stored and can be retrieved using method resetAt().

resetAt

public TimeInstant resetAt()

Shows the point in simulation time when the last reset of this reportable was made.

Returns:

TimeInstant : The point of simulation time of the last reset.

getCorrespondingSchedulable

public Schedulable getCorrespondingSchedulable()

Gets the schedulable (e.g. entity) corresponding to this reportable; may be null if no schedulable corresponds to this reportable.

Returns:

Schedulable : The schedulable (e.g. entity) corresponding to this reportable (may be null if no schedulable corresponds to this reportable!)

setCorrespondingSchedulable

public void setCorrespondingSchedulable(Schedulable correspondingSchedulable)

Sets the schedulable (e.g. entity) corresponding to this Reportable. May be null if no schedulable corresponds to this reportable. If set, the schedulable must have the same model as this reportable! A Reportable needs not have a corresponding schedulable.

Parameters:

correspondingSchedulable - Schedulable : The Schedulable corresponding to this Reportable.

setDescription

public void setDescription(java.lang.String description)

Set an optional description of reported value. Default is null. This value is shown in description reports, only when set.

Parameters:

description -

getDescription

public java.lang.String getDescription()

Get an optional description of reported value. Default is null. This value is shown in description reports, only when set.

Returns: