# Copyright 2014 Modelling, Simulation and Design Lab (MSDL) at
# McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)
#
# 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.
from pypdevs.tracers.tracerBase import BaseTracer
from pypdevs.util import runTraceAtController
import sys
[docs]class TracerVerbose(BaseTracer):
"""
A tracer for simple verbose output
"""
[docs] def __init__(self, uid, server, filename):
"""
Constructor
:param uid: the UID of this tracer
:param server: the server to make remote calls on
:param filename: file to save the trace to, can be None for output to stdout
"""
super(TracerVerbose, self).__init__(uid, server)
if server.getName() == 0:
self.filename = filename
else:
self.filename = None
self.prevtime = (-1, -1)
[docs] def startTracer(self, recover):
"""
Starts up the tracer
:param recover: whether or not this is a recovery call (so whether or not the file should be appended to)
"""
if self.filename is None:
self.verb_file = sys.stdout
elif recover:
self.verb_file = open(self.filename, 'a+')
else:
self.verb_file = open(self.filename, 'w')
[docs] def stopTracer(self):
"""
Stop the tracer
"""
self.verb_file.flush()
[docs] def trace(self, time, text):
"""
Actual tracing function
:param time: time at which this trace happened
:param text: the text that was traced
"""
string = ""
if time > self.prevtime:
string = ("\n__ Current Time: %10.6f " + "_"*42 + " \n\n") % (time[0])
self.prevtime = time
string += "%s\n" % text
try:
self.verb_file.write(string)
except TypeError:
self.verb_file.write(string.encode())
[docs] def traceInternal(self, aDEVS):
"""
Tracing done for the internal transition function
:param aDEVS: the model that transitioned
"""
text = "\n"
text += "\tINTERNAL TRANSITION in model <%s>\n" % aDEVS.getModelFullName()
text += "\t\tNew State: %s\n" % str(aDEVS.state)
text += "\t\tOutput Port Configuration:\n"
for I in range(len(aDEVS.OPorts)):
text += "\t\t\tport <" + str(aDEVS.OPorts[I].getPortName()) + ">:\n"
for msg in aDEVS.my_output.get(aDEVS.OPorts[I], []):
text += "\t\t\t\t" + str(msg) + "\n"
# Don't show the age
text += "\t\tNext scheduled internal transition at time %.6f\n" \
% (aDEVS.time_next[0])
runTraceAtController(self.server,
self.uid,
aDEVS,
[aDEVS.time_last, '"' + text + '"'])
[docs] def traceConfluent(self, aDEVS):
"""
Tracing done for the confluent transition function
:param aDEVS: the model that transitioned
"""
text = "\n"
text += "\tCONFLUENT TRANSITION in model <%s>\n" % aDEVS.getModelFullName()
text += "\t\tInput Port Configuration:\n"
for I in range(len(aDEVS.IPorts)):
text += "\t\t\tport <" + str(aDEVS.IPorts[I].getPortName()) + ">: \n"
for msg in aDEVS.my_input.get(aDEVS.IPorts[I], []):
text += "\t\t\t\t" + str(msg) + "\n"
text += "\t\tNew State: %s\n" % str(aDEVS.state)
text += "\t\tOutput Port Configuration:\n"
for I in range(len(aDEVS.OPorts)):
text += "\t\t\tport <" + str(aDEVS.OPorts[I].getPortName()) + ">:\n"
for msg in aDEVS.my_output.get(aDEVS.OPorts[I], []):
text += "\t\t\t\t" + str(msg) + "\n"
# Don't show the age
text += "\t\tNext scheduled internal transition at time %.6f\n" \
% (aDEVS.time_next[0])
runTraceAtController(self.server,
self.uid,
aDEVS,
[aDEVS.time_last, '"' + text + '"'])
[docs] def traceExternal(self, aDEVS):
"""
Tracing done for the external transition function
:param aDEVS: the model that transitioned
"""
text = "\n"
text += "\tEXTERNAL TRANSITION in model <%s>\n" % aDEVS.getModelFullName()
text += "\t\tInput Port Configuration:\n"
for I in range(len(aDEVS.IPorts)):
text += "\t\t\tport <" + str(aDEVS.IPorts[I].getPortName()) + ">:\n"
for msg in aDEVS.my_input.get(aDEVS.IPorts[I], []):
text += "\t\t\t\t" + str(msg) + "\n"
text += "\t\tNew State: %s\n" % str(aDEVS.state)
# Don't show the age
text += "\t\tNext scheduled internal transition at time %.6f\n" \
% (aDEVS.time_next[0])
runTraceAtController(self.server,
self.uid,
aDEVS,
[aDEVS.time_last, '"' + text + '"'])
[docs] def traceInit(self, aDEVS, t):
"""
Tracing done for the initialisation
:param aDEVS: the model that was initialised
:param t: time at which it should be traced
"""
text = "\n"
text += "\tINITIAL CONDITIONS in model <%s>\n" % aDEVS.getModelFullName()
text += "\t\tInitial State: %s\n" % str(aDEVS.state)
# Don't show the age
text += "\t\tNext scheduled internal transition at time %.6f\n" \
% (aDEVS.time_next[0])
runTraceAtController(self.server,
self.uid,
aDEVS,
[t, '"' + text + '"'])
[docs] def traceUser(self, time, aDEVS, variable, value):
text = "\n"
text += "\tUSER CHANGE in model <%s>\n" % aDEVS.getModelFullName()
text += "\t\tAltered attribute <%s> to value <%s>\n" % (variable, value)
# Is only called at the controller, outside of the GVT loop, so commit directly
self.trace(time, text)