Overview  Package   Class  Use  Deprecated  Index
Home >> All >> [ desmoj overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

desmoj
Class Reportable  

java.lang.Object
  desmoj.NamedObject
      desmoj.ModelComponent
          desmoj.Reportable

Direct Known Subclasses:

Model, QueueBased

---

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. 1.5 copyright (c) 2001 licensed under GNU GPL

---

Field Summary
private  SimTime	lastReset           stores the last time that this reportable object was reset.
private  long	observations           The number of observations that this reportable can report about
private  boolean	reportMode           Flag indicating if this reportable should produce a report.

 

Fields inherited from class desmoj.ModelComponent

 

Fields inherited from class desmoj.NamedObject

 

Constructor Summary

Reportable(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace)           Creates a reportable object with all parameters required.

 

Method Summary
Reporter	createReporter()           Override this method to return the appropriate reporter to the reportable object.
long	getObservations()           Returns the number of observations made by the reportable object.
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.
SimTime	resetAt()           Shows the point in simulation time when the last reset of this reportable was made.

 

Methods inherited from class desmoj.ModelComponent

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

 

Methods inherited from class desmoj.NamedObject

getName, getQuotedName, rename, toString

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

reportMode

private boolean reportMode

Flag indicating if this reportable should produce a report.

---

observations

private long observations

The number of observations that this reportable can report about

---

lastReset

private SimTime lastReset

stores the last time that this reportable object was reset.

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

Method Detail

createReporter

public Reporter createReporter()

Override this method to return the appropriate reporter to the reportable object. To ensure that always the appropriate reporter is used, it has to be obtained from the reportable object that is of interest. All reportable objects in desmoj that want to deliver special repoters have to implement this method to hand back the correct reporter. The default implementation returns an object of type StandardReporter If you want to extend the framework by new concepts, you have to make sure, that classes inheriting direct or indirect from reportable have to implement this method correctly, especially by implementing an appropriate reporter first and give a reference to it back through this method.

---

getObservations

public long getObservations()

Returns 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.

---

reportIsOn

public boolean reportIsOn()

Checks if this reportable produces a report.

---

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 SimTime resetAt()

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

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> [ desmoj overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---