desmoj.core.simulator

Class ExternalEventTimedTrace

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.EventAbstract

desmoj.core.simulator.ExternalEvent

desmoj.core.simulator.ExternalEventTimedTrace

public class ExternalEventTimedTrace
extends ExternalEvent

The ExternalEventTimedTrace class allows for inserting items with true time values into the trace file. When the event routine is called an appropriate trace note is sent.

The Experiment class uses ExternalEventTimedTrace events to write the start and stop time of the trace period as true time into the trace file.

Version:

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

Author:

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
ExternalEventTimedTrace(java.lang.String trueTime, int refUnit, java.lang.String what, Model owner) Constructs an ExternalEventTimedTrace with the given true time, description and model.

Method Summary

Modifier and Type	Method and Description
void	eventRoutine() Sends a trace note with the description and the true time including the time unit.

Methods inherited from class desmoj.core.simulator.ExternalEvent

schedule, schedule, schedule, schedule, scheduleAfter, scheduleBefore, schedulePreempt

Methods inherited from class desmoj.core.simulator.EventAbstract

getNumberOfEntities, getRealTimeConstraint, getSchedulingPriority, isExternal, setRealTimeConstraint, setSchedulingPriority

Methods inherited from class desmoj.core.simulator.Schedulable

assignReporter, cancel, getCorrespondingReportable, isCurrent, isScheduled, rename, reSchedule, reSchedule, reSchedulePreempt, scheduledNext, setCorrespondingReportable

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

ExternalEventTimedTrace

public ExternalEventTimedTrace(java.lang.String trueTime,
                               int refUnit,
                               java.lang.String what,
                               Model owner)

Constructs an ExternalEventTimedTrace with the given true time, description and model.

Parameters:

trueTime - String : the true time value to be written into the trace file

what - String : a short description of the true time value

owner - Model : the model this event shall belong to

Method Detail

eventRoutine

public void eventRoutine()

Sends a trace note with the description and the true time including the time unit.

Specified by:

eventRoutine in class ExternalEvent