Copyright	Copyright (c) 2012-2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Simulation.Aivika.Experiment.Base.WebPageRenderer

Description

Tested with: GHC 8.0.1

It defines a renderer that creates a web page when running the simulation experiment.

Synopsis

data WebPageRenderer a = WebPageRenderer a ExperimentFilePath
data WebPageWriter = WebPageWriter {
- reporterWriteTOCHtml :: Int -> HtmlWriter ()
- reporterWriteHtml :: Int -> HtmlWriter ()
}
type WebPageGenerator a = ExperimentGenerator (WebPageRenderer a)

Documentation

data WebPageRenderer a Source #

It defines the web page renderer for simulation Experiment.

Constructors

WebPageRenderer a ExperimentFilePath

A renderer that depends on the provided parameter and a directory path, where the simulation results are saved in.

Instances

Instances details

ExperimentView ExperimentSpecsView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.ExperimentSpecsView Methods outputView :: ExperimentSpecsView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentView FinalStatsView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.FinalStatsView Methods outputView :: FinalStatsView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentView FinalTableView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.FinalTableView Methods outputView :: FinalTableView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentView InfoView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.InfoView Methods outputView :: InfoView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentView LastValueView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.LastValueView Methods outputView :: LastValueView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentView TableView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.TableView Methods outputView :: TableView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentView TimingStatsView (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.TimingStatsView Methods outputView :: TimingStatsView -> ExperimentGenerator (WebPageRenderer a) Source #
ExperimentRendering (WebPageRenderer a) Source #	Rendering a web page with results when running the simulation experiment.
Instance details Defined in Simulation.Aivika.Experiment.Base.WebPageRenderer Associated Types data ExperimentContext (WebPageRenderer a) Source # type ExperimentEnvironment (WebPageRenderer a) Source # type ExperimentMonad (WebPageRenderer a) :: Type -> Type Source # Methods liftExperiment :: WebPageRenderer a -> ExperimentMonad (WebPageRenderer a) a0 -> IO a0 Source # prepareExperiment :: Experiment -> WebPageRenderer a -> ExperimentMonad (WebPageRenderer a) (ExperimentEnvironment (WebPageRenderer a)) Source # renderExperiment :: Experiment -> WebPageRenderer a -> [ExperimentReporter (WebPageRenderer a)] -> ExperimentEnvironment (WebPageRenderer a) -> ExperimentMonad (WebPageRenderer a) () Source # onExperimentCompleted :: Experiment -> WebPageRenderer a -> ExperimentEnvironment (WebPageRenderer a) -> ExperimentMonad (WebPageRenderer a) () Source # onExperimentFailed :: Exception e => Experiment -> WebPageRenderer a -> ExperimentEnvironment (WebPageRenderer a) -> e -> ExperimentMonad (WebPageRenderer a) () Source #
newtype ExperimentContext (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.WebPageRenderer newtype ExperimentContext (WebPageRenderer a) = WebPageContext { runWebPageContext :: WebPageWriter }
type ExperimentEnvironment (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.WebPageRenderer type ExperimentEnvironment (WebPageRenderer a) = FilePath
type ExperimentMonad (WebPageRenderer a) Source #
Instance details Defined in Simulation.Aivika.Experiment.Base.WebPageRenderer type ExperimentMonad (WebPageRenderer a) = ExperimentWriter

data WebPageWriter Source #

It replies to the requests made by the web page renderer.

Constructors

WebPageWriter

Fields

reporterWriteTOCHtml :: Int -> HtmlWriter ()
Return a TOC (Table of Contents) item for the HTML index file after the finalisation function is called, i.e. in the very end. The agument specifies the ordered number of the item.
You should wrap your HTML in writeHtmlListItem.
reporterWriteHtml :: Int -> HtmlWriter ()
Return an HTML code for the index file after the finalisation function is called, i.e. in the very end. The agument specifies the ordered number of the item.

type WebPageGenerator a = ExperimentGenerator (WebPageRenderer a) Source #

A convenient type synonym for describing a web page generator.