Trait dvcompute_experiment_branch::simulation::experiment::ExperimentRendering

pub trait ExperimentRendering {
    type ExperimentContext: Send;
    type ExperimentEnvironment: Send;
    fn prepare(
        &self, 
        experiment: &Experiment
    ) -> Result<Self::ExperimentEnvironment>;
    fn render(
        &self, 
        experiment: &Experiment, 
        reporters: &Vec<Box<dyn ExperimentReporter<Self> + Sync + Send>>, 
        env: &Self::ExperimentEnvironment
    ) -> Result<()>
    where
        Self: Sized;
    fn on_completed(
        &self, 
        experiment: &Experiment, 
        env: &Self::ExperimentEnvironment
    ) -> Result<()>;
    fn on_failed(
        &self, 
        experiment: &Experiment, 
        env: &Self::ExperimentEnvironment, 
        err: &Error
    ) -> Result<()>;
}

It allows rendering the simulation results in an arbitrary way.

Associated Types

type ExperimentContext: Send

Defines a context used when rendering the experiment.

type ExperimentEnvironment: Send

Defines the experiment environment.

Required methods

fn prepare(
    &self,
    experiment: &Experiment
) -> Result<Self::ExperimentEnvironment>

Prepare before rendering the experiment.

fn render(
    &self,
    experiment: &Experiment,
    reporters: &Vec<Box<dyn ExperimentReporter<Self> + Sync + Send>>,
    env: &Self::ExperimentEnvironment
) -> Result<()> where
    Self: Sized, 

Render the experiment after the simulation is finished, example, create the index.html file in the specified directory.

fn on_completed(
    &self,
    experiment: &Experiment,
    env: &Self::ExperimentEnvironment
) -> Result<()>

It is called when the experiment has been completed.

fn on_failed(
    &self,
    experiment: &Experiment,
    env: &Self::ExperimentEnvironment,
    err: &Error
) -> Result<()>

It is called when the experiment has been failed.

Implementors

impl<T> ExperimentRendering for WebPageRendering<T>

type ExperimentContext = Box<dyn WebPageWriter + Send>

type ExperimentEnvironment = Box<Path>