/*
This software was developed at The MITRE Corporation
in 2004/2006 and has been approved for Public Release; Distribution Unlimited.
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software
interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Program does not specify a
version number of this License, you may choose any version ever
published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
*/
package org.mitre.sim;
import org.mitre.sim.Entity;
import org.mitre.sim.event.EventManager;
import org.mitre.sim.exec.Executive;
import org.mitre.sim.exec.LogicalProcess;
//import org.mitre.sim.exec.State;
import org.mitre.sim.flow.Flow;
//import org.mitre.sim.flow.threads.ThreadFlow;
import org.mitre.sim.gui.ComponentPanel;
import org.mitre.sim.gui.SimulationGui;
//import org.mitre.sim.util.BasicFormatter;
import java.util.HashSet;
import java.util.Properties;
import java.util.Map;
import java.util.Set;
import java.util.Enumeration;
import java.io.PrintStream;
import java.io.Serializable;
import java.net.URL;
/**
Abstract class used to represent a simulation.
An instance of a user-developed <code>Simulation</code> subclass
is associated with a group of entities to share a common
definition of simulation time.
A simulation entity is represented by one of:
<ul>
<li>An instance of {@link EntityDelegate EntityDelegate}
(or {@link ProcessDelegate ProcessDelegate})
<li>An instance of {@link DefaultEntity DefaultEntity}
</ul>
The instance must be associated with an instance of a
<code>Simulation</code> subclass.
This is done with the
{@link #register(EntityDelegate) Simulation.register()} or
{@link org.mitre.sim.Entity#register(EntityDelegate e) Entity.register()}.
A Java program may contain more than one instance of a
<code>Simulation</code> subclass; in that case
each instance will be a separate and independent simulation.
<br>
<p><img src="doc-files/mitre_logo.gif"><br>
<font size=-2>Copyright © 2003-2004 The MITRE Corporation</font>
*/
public abstract class Simulation
implements Runnable, Serializable {
private Executive exec = null;
private Flow flow = null;
private Properties properties = null;
private transient SimulationGui simGui = null;
public Simulation() {
properties = loadProperties();
flow = (Flow) loadObject("org.mitre.sim.Flow.class");
flow.setProperties(properties);
exec = (Executive) loadObject("org.mitre.sim.Executive.class");
exec.setProperties(properties);
exec.setFlow(flow);
exec.setSimulation(this);
EventManager event = (EventManager) loadObject("org.mitre.sim.EventManager.class");
exec.setEventManager(event);
LogicalProcess.resetEntityNumber();
if (properties.getProperty("org.mitre.sim.Simulation.suppressVersionPrint")
== null) {
System.out.println(version());
}
//System.out.println(exec.version() + " loaded from " + getLocation(exec));
//System.out.println(flow.version() + " loaded from " + getLocation(flow));
//System.out.println(event.version() + " loaded from " + getLocation(event));
}
/**
* Add listener for {@link EntityEvent EntityEvents}.
* @see org.mitre.sim.EntityEvent
* @param listener
*/
public final void addEntityEventListener(EntityEventListener listener) {
if (exec != null) {
exec.getEntityEventSupport().addEntityEventListener(listener);
}
}
/**
* Remove listener for {@link EntityEvent EntityEvents}.
* @see org.mitre.sim.EntityEvent
* @param listener
*/
public final void removeEntityEventListener(EntityEventListener listener) {
if (exec != null) {
exec.getEntityEventSupport().removeEntityEventListener(listener);
}
}
/**
Affiliate a new entity with this simulation.
The framework will generate a name for the entity.
Names are used to annotate messages generated by methods
{@link #info(String) info}
and {@link #toString() toString}.
@param ed EntityDelegate instance being registered
@return Same <code>Entity</code> supplied by parameter <code>e</code>.
@throws IllegalStateException if registration attempted after last time has been reached.
*/
public final Entity register(EntityDelegate ed) {
Entity e = new Entity(ed);
e.setExecutive(exec, ed);
ed.setEntity(e);
return e;
}
/**
Affiliate a new entity with this simulation, with specified name.
Entity names are for
developer convenience, are not examined by the executive, and need not be
unique.
Names are used to annotate messages generated by methods
{@link #info(String) info}
and {@link #toString() toString}.
@param ed EntityDelegate instance being registered
@param name
@return Same <code>Entity</code> supplied by parameter <code>e</code>.
@throws IllegalStateException if registration attempted after last time has been reached.
*/
public final Entity register(EntityDelegate ed, String name) {
Entity e = new Entity(ed, name);
e.setExecutive(exec, ed);
ed.setEntity(e);
return e;
}
/**
Create the initial simulation environment.
Code placed in this method is
executed by the simulation executive before simulation time starts to advance.
Usually <code>initialize</code> is used to create and
{@link #register(EntityDelegate) register} the initial
set of entities, and/or to schedule an initial set of events.
Once the <code>initialize</code> method returns, the executive
begins the advance of simulation time by selecting the first entity for computation,
or the first event for execution.
*/
public abstract void initialize();
/**
Override if simulation completion notification is desired.
Simulation execution can come to an end for a variety of reasons.
Overriding the <code>simulationComplete</code> method
gives the simulation developer a place
to put code that will be executed unconditionally at the end of the simulation's life.
<p>
When this method is executed, simulation time is defined as follows:
<ul>
<li>If {@link org.mitre.sim.Entity#stopSimulation() stopSimulation()}
was called, it is the simulation time current when <code>stopSimulation()</code>
was invoked.
<li>Otherwise, if the simulation halted because the last value of simulation time
was reached, time is the last value of simulation time.
<li>Otherwise, time is the time of the last scheduled event executed in the simulation,
or the latest time at the end of any entity's <code>agenda</code>, whichever is greatest.
</ul>
@see org.mitre.sim.EntityDelegate#entityComplete()
*/
public void simulationComplete() {};
/**
Execute the simulation.
Method <code>run</code> performs the following three operations:
<ol>
<li>Invoke the {@link #initialize() initialize} method.
<li>Invoke the <code>agenda</code> methods of all entities associated with this simulation,
interleaved with the execution of scheduled events.
This process continues until:
<ul>
<li>all entities have finished their
{@link org.mitre.sim.Entity#agenda() agendas} and there
are no more scheduled events, or
<li>until the <code>timeLast</code> value of simulation time is reached, or
<li>some entity invokes {@link org.mitre.sim.Entity#stopSimulation() stopSimulation}.
</ul>
<li>Invoke the {@link #simulationComplete() simulationComplete} method.
</ol>
Method <code>run</code> <b>blocks</b> until the simulation is finished.
If blocking is not desired, use method {@link #start() start}
to execute a simulation.
@see #start()
@see #setTimeLast(double)
@see org.mitre.sim.exec.Executive#startSimulation()
*/
public final void run() /* throws NoOptCompilePragma, NoInlinePragma*/ {
initialize();
try {
exec.startSimulation();
}
catch (OutOfMemoryError oome) {
simulationComplete();
// This kills the VM, without calling the various shutdown hooks.
Runtime.getRuntime().halt(0);
}
simulationComplete();
}
/**
Execute the simulation using a new Thread.
Method <code>start</code> executes method {@link #run() run}
in a new Thread.
Method <code>start</code> does <b>not</b> block until the
simulation is finished.
If blocking is desired, use method {@link #run() run}
to execute a simulation.
@see #run()
@see #setTimeLast(double)
@see org.mitre.sim.exec.Executive#startSimulation()
*/
public final void start() {
new Thread(this).start();
}
/**
Specify the last value of time to be simulated before the
simulation stops. The simulation can end before <code>timeLast</code>
if all the entities reach the end of their {@link org.mitre.sim.Entity#agenda() agendas}
before then, and all scheduled events are executed.
If an entity {@link org.mitre.sim.Entity#agenda() agenda} is active when simulation
time reaches the <code>timeLast</code> value, or there is an event scheduled beyond <code>timeLast</code>,
the executive will stop the simulation.
The default value of <code>timeLast</code> is positive infinity.
<br><i>Safe to be called from another thread.</i>
@param t Last value of simulation time to be simulated.
@see org.mitre.sim.Entity#setTimeLast(double)
@see org.mitre.sim.exec.Executive#setTimeLast(double)
*/
public final void setTimeLast(double t) {
exec.setTimeLast(t);
}
/**
Returns the current simulation time.
<br><i>Safe to be called from another thread.</i>
@return Current simulation time.
@see org.mitre.sim.exec.Executive#getTimeNow()
*/
public final double getTimeNow() {
return exec.getTimeNow();
}
/**
* Returns current value of timeLast.
* This value is positive infinity until the user alters it.
* <br><i>Safe to be called from another thread.</i>
* @return Current value of timeLast.
* @see org.mitre.sim.exec.Executive#getTimeLast()
*/
public final double getTimeLast() {
return exec.getTimeLast();
}
/**
Enables or disables the GUI for this simulation
@param flag <code>true:</code> Create and display the controlling GUI for the simulation.
<code>false:</code> Hide the controlling GUI.
*/
public final void setVisible(boolean flag) {
getSimulationGui().setVisible(flag);
}
/**
Convenience method that concatenates the current simulation time,
{@link org.mitre.sim.Simulation Simulation}
subclass name, and the supplied message
string before it is printed on <code>System.out</code>.
@see org.mitre.sim.Entity#info(String)
*/
public final void info(String message) {
info(message, System.out);
}
/**
Convenience method that concatenates the current simulation time,
{@link org.mitre.sim.Simulation Simulation}
subclass name, and the supplied message
string before it is printed on <code>out</code>.
@param out <code>PrintStream</code> to print on
@see org.mitre.sim.Entity#info(String, java.io.PrintStream)
*/
public final void info(String message, PrintStream out) {
String name = getClass().getName();
StringBuffer sb = new StringBuffer();
sb.append(exec.getTimeNow()).append(" ");
sb.append(name.substring(name.lastIndexOf(".") + 1)).append(" ");
sb.append(message);
out.println(sb.toString());
}
/**
Set the minimum amount of real time that must pass before the
simulation advances one unit of simulation time.
This method places an upper bound on the rate at which simulation time
advances. By default, there is no artifical constraint on how fast
simulation time advances. Simulations advance as fast as the required
computation can be performed.
As an example, assume the following are true:
<ul>
<li>The unit of simulation time is the minute.
<li>The simulation is intended to run twice as fast as real time.
That is, two minutes of simulation time should pass for every one
minute of real time.
<li>The software and supporting platform have suffcient capacity to
compute two minutes worth of simulation in less than one minute
of real time.
</ul>
To get the desired 2 to 1 ratio of simulation time to real time,
this invocation should be used:
<blockquote> <pre>
setPace(60 * 1000 / 2)
</pre></blockquote>
To return the simulation to a state in which the computation proceeds as fast as
possible, make the following invocation:
<blockquote> <pre>
setPace(0)
</pre></blockquote>
<i>Safe to be called from another thread.</i>
@param period Minimum number of real milliseconds that must pass before one
unit of simulation time passes.
*/
public final void setPace(long period) {
exec.setPace(period);
}
/**
Return the current pace setting.
<br><i>Safe to be called from another thread.</i>
@return Minimum number of real milliseconds that must pass before one
unit of simulation time passes.
*/
public long getPace() {
return exec.getPace();
}
/**
Used by an external thread to pause the Executive.
The pause will occur after all events generated at the pause time.
<br>
<i>The calling thread will block until the executive is paused.</i>
<p>
Care should be taken when using this method.
If the executive thread or an entity thread calls this method, deadlock will result.
An attempt to pause an executive that is already paused has no effect.
However, a second external thread invoking this method might get stuck.
This is unlikely in the usual application, i.e., pause and resume are called
from the (single) Swing dispatch thread.
*/
public final void pauseSimulation() {
exec.pauseExecutive();
}
/**
Used by an external thread to resume the executive.
An attempt to resume a running executive has no effect.
*/
public final void resumeSimulation() {
exec.resumeExecutive();
}
/**
* Used by external thread to cause simulation to advance as fast as possible
* until simulation time advances by interval.
* Then, after all events at the pause time, the simulation pauses.
* <br>
* <i>The calling thread blocks until the simulation is paused.
* When this method returns, the simulation is paused.</i>
* <p>
* This should not be called from the simulation or an entity thread.
* A second invocation while a pause is pending resets the pause time.
* @param interval
* @param timeAchievedListener SimEventListener to receive SimEvent when
* pause time is achieved.
* If the listener calls back into the Simulation, deadlock will ensue.
*/
public void pauseAfter(double interval, SimEventListener timeAchievedListener) {
exec.pauseAfter(interval, timeAchievedListener);
}
/**
Returns the version of the classes implementing the simulation executive.
@return Simulation, Executive, and Flow implementation version.
*/
public final String version() {
return "Tortuga 4.0.1, " +
exec.version() + ", " +
flow.version() + ", " +
System.getProperty("java.vm.name") + " " +
System.getProperty("java.vm.version");
}
private void setDefaultLoggerProperties(String loggerName,
Properties defaultProps,
String handlerLogLevel) {
defaultProps.setProperty(loggerName + ".level", "ALL");
defaultProps.setProperty(loggerName + ".useParentHandlers", "false");
defaultProps.setProperty(loggerName + ".handlers", "console");
defaultProps.setProperty(loggerName + ".handler.console.class",
"org.mitre.sim.util.ConsoleHandler");
defaultProps.setProperty(loggerName + ".handler.console.stream",
"stdout");
defaultProps.setProperty(loggerName + ".handler.console.level",
handlerLogLevel);
defaultProps.setProperty(loggerName + ".handler.console.formatter.class",
"org.mitre.sim.util.BasicFormatter");
defaultProps.setProperty(loggerName + ".handler.console.formatter.format",
"{0,date,MMM dd, yyyy} {0,time,HH:mm:ss} {1} {2}" +
"'\n' {3}: {4} {5,choice,0#'\n'|1#'\n' {6}}");
}
// The system properties take first priority, with the loaded properties taking second priority,
// and default [hardcoded] properties bringing up the rear
private Properties loadProperties() {
String propFile = "resources/sim.properties";
ClassLoader loader = this.getClass().getClassLoader();
Properties defaultProp = new Properties();
defaultProp.setProperty("org.mitre.sim.Executive.class",
"org.mitre.sim.exec.pausing.PausingExecutive");
defaultProp.setProperty("org.mitre.sim.Flow.class",
"org.mitre.sim.flow.tiger.TigerFlow");
defaultProp.setProperty("org.mitre.sim.EventManager.class",
"org.mitre.sim.event.treeMap.TreeMapImpl");
setDefaultLoggerProperties("org.mitre.sim.Simulation", defaultProp, "INFO");
setDefaultLoggerProperties("org.mitre.sim.Executive", defaultProp, "OFF");
setDefaultLoggerProperties("org.mitre.sim.Flow", defaultProp, "OFF");
setDefaultLoggerProperties("org.mitre.sim.Entity", defaultProp, "INFO");
SimulationGui.setupDefaultProperties(defaultProp);
Properties prop = new Properties(defaultProp);
try {
URL url = loader.getResource(propFile);
if (url == null) {
System.out.println("Unable to load properties file: " +
propFile +
", Default property values will be used.");
}
else {
prop.load(url.openStream());
}
}
catch (Exception e) {
System.out.println("Unable to load properties file: " +
propFile +
", Default property values will be used.");
System.out.println(e);
}
//prop.list(System.out);
Properties sysProperties = new Properties(prop);
for (Map.Entry<Object, Object> entry : System.getProperties().entrySet()) {
try {
sysProperties.setProperty( (String) entry.getKey(),
(String) entry.getValue());
}
catch (Exception e) {
System.out.println(e);
}
}
return sysProperties;
}
private Object createNewInstance(String className) {
ClassLoader loader = this.getClass().getClassLoader();
//System.out.println(System.getProperty("java.class.path"));
try {
return loader.loadClass(className).newInstance();
}
catch (ClassNotFoundException e) {
throw new IllegalArgumentException("Unable to find class " + className);
}
catch (IllegalAccessException e) {
throw new IllegalArgumentException("Class or no-arg ctor not accessible, class " + className);
}
catch (InstantiationException e) {
throw new IllegalArgumentException("Class is abstract or interface, class " + className);
}
}
private Object loadObject(String propName) {
return (createNewInstance(properties.getProperty(propName)));
}
public Properties getSubProperties(String prefix, Properties origProps) {
if (origProps == null) {
return (null);
}
if (!prefix.endsWith(".")) {
prefix = prefix + ".";
}
Properties componentProperties = new Properties();
for (Enumeration<?> e = origProps.propertyNames(); e.hasMoreElements(); ) {
String property = (String) e.nextElement();
if (property.startsWith(prefix)) {
componentProperties.put(property.substring(prefix.length()),
origProps.getProperty(property));
}
}
return (componentProperties);
}
/**
* Obtains the reference to the framework Graphical User Interface
* @return A reference to the framework Graphical User Interface
*/
public SimulationGui getSimulationGui() {
if (simGui == null) {
simGui = new SimulationGui(this, properties);
simGui.setupComponents();
}
return(simGui);
}
// Get the first component on the GUI that
public ComponentPanel getComponentPanel(Class<?> c) {
return(getSimulationGui().getComponentPanel(c));
}
/**
Return all Entities whose delegates are assignable to class c.
The set returned by this method is invalid as soon as control passes
back to the Executive.
@param c EntityDelegate implementation class used to select Entity instances.
@return All entities whose delegate is assignable to class c.
*/
public Set<Entity> getEntities(Class<? extends EntityDelegate> c) {
Set<LogicalProcess> allEntities = exec.getLogicalProcesses();
Set<Entity> result = new HashSet<Entity>();
for (LogicalProcess lp : allEntities) {
if (c.isAssignableFrom(lp.getClass())) {
result.add((Entity)lp);
}
}
return result;
}
/**
Return all Entities in the simulation.
The set returned by this method is invalid as soon as control passes
back to the Executive.
@return Set of all Entities in the simulation.
*/
public Set<Entity> getEntities() {
return getEntities(EntityDelegate.class);
}
}