Bpp/Simulation
Simulator
C++
 
 
DESCRIPTION
 

This module provides classes to define the basic functionalities of a simulator.

 
SOURCE FILES
 

This section allows you to access the C++ source files of the module.

 
PARENT MODULE
 

This module is part of Bpp/Simulation.

 
INCLUDED FILES
 

The files listed below are included in the interface part of the module. So any module dependent of this module is also dependent of the files listed here.

  • <bpp/simulation/event.hpp>

  • <jirk/bpp/simulation/simulatorframe.hpp>

 
NEEDED FILES
 

The files listed below are needed by the implementation part of the module. But a module dependent of this module is not necessary dependent of the files listed here.

  • <jirk/java/lang/thread.hpp>

  • <jirk/java/lang/string.hpp>

  • <jirk/java/lang/system.hpp>

  • <bpp/modules.hpp>

 
INTEGRATED NAMESPACES
 

The namespaces listed below are integrated in this module. That means any element declared in one of those namespaces can now be directly used by or from this module.

  • simulationEvent

 
ERRORS
 

Here are listed the errors that are supported or generated by the module. To use one of them, you do not have to specify the namespace of the module.

  • erEmptySimulationScheduler
    The simulation scheduler is empty.

  • erInvalidSimulationDate
    The simulation date is not valid.

  • erSimulationNotRunning
    The simulation is not running.

  • erSimulationRunning
    The simulation is running.

  • erEndMeasureParameterMissing
    The end_measure parameter is missing in the experiment file.

  • erEndRunningParameterMissing
    The end_running parameter is missing in the experiment file.

  • erReplicationParameterMissing
    The replication parameter is missing in the experiment file.

  • erStartMeasureParameterMissing
    The start_measure parameter is missing in the experiment file.

  • erStartRunningParameterMissing
    The start_running parameter is missing in the experiment file.

 
CLASSES
 

Here are listed the classes provided by the module. To use one of them, you have to specify the namespace of the module.

 
clScheduler
 
 
Declaration

class clScheduler

 
Description

Represents the scheduler of a simulator. It manages the time advance and the execution of the events in a simulation.

 
Methods
 
clSimulator
 
 
Declaration

class clSimulator : public clStillObject

 
Description

Represents a simulator. It allows to perform a full simulation experiment.

 
Types
  • type std_map(clString,clString) clParameterX
    Type of the parameters list read from the experiment file.

 
Attributes
  • tyBoolean informationDisplayed()
    Indicates if the simulator must display information. Reading access only.

  • tyBoolean graphic()
    Indicates if the simulator must provide a graphical animation. Reading access only.

  • jirk::bpp::simulation::jaSimulatorFrame frame()
    Java frame where the simulation is animated. Reading access only.

  • clString dataLocation()
    Location of the data files used by the simulation. Reading access only.

  • clParameterX parameters()
    Parameters read from the experiment file. Reading access only.

  • clRandomGenerator randomGenerator()
    Random generator used for the simulation. Reading and writing access.

  • tyBoolean running()
    Indicates if the simulator is running. Reading access only.

  • tyCardinal startRunningDate()
    Start date of the simulation running. Reading access only.

  • tyCardinal endRunningDate()
    End date of the simulation running. Reading access only.

  • tyCardinal startMeasureDate()
    Start date of the statistical measures in the simulation. Reading access only.

  • tyCardinal endMeasureDate()
    End date of the statistical measures in the simulation. Reading access only.

  • tyCardinal nbReplication()
    Number of replications of the simulation experiment. Reading access only.

  • tyCardinal date()
    Current date of the simulation. Only relevant when the simulator is running. Reading access only.

  • tyCardinal replication()
    Current replication of the simulation experiment. Only relevant when the simulator is running. Reading access only.

 
Methods
 
 
Copyright (c) 1999-2016 - Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. See this license for more details (http://www.gnu.org).