Class ExperimentHandlerBsbm

An experiment handler for BSBM.

Hierarchy

ExperimentHandler<ExperimentBsbm>
- ExperimentHandlerBsbm

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ExperimentHandlerBsbm(): ExperimentHandlerBsbm

Overrides ExperimentHandler.constructor
- Defined in packages/experiment-bsbm/lib/ExperimentHandlerBsbm.ts:9
Returns ExperimentHandlerBsbm

Properties

Readonly experimentClassName

experimentClassName: string

Name of the experiment class. This will be used to initialize config files.

Readonly id

id: string

Unique id of this experiment type.

Methods

getDefaultParams

getDefaultParams(experimentPaths: IExperimentPaths): Record<string, any>

Overrides ExperimentHandler.getDefaultParams
- Defined in packages/experiment-bsbm/lib/ExperimentHandlerBsbm.ts:13
Default parameters that should be added to the 'jbr-experiment.json' file during initialization. These should correspond to all (required) Components.js parameters for instantiating an experiment.

Parameters
- experimentPaths: IExperimentPaths
Returns Record<string, any>

getHookNames

getHookNames(): string[]

Overrides ExperimentHandler.getHookNames
- Defined in packages/experiment-bsbm/lib/ExperimentHandlerBsbm.ts:24
Names of possible hooks into the experiment.

Returns string[]

init

init(experimentPaths: IExperimentPaths, experiment: ExperimentBsbm): Promise<void>

Overrides ExperimentHandler.init
- Defined in packages/experiment-bsbm/lib/ExperimentHandlerBsbm.ts:28
Called upon initializing a new experiment.

Parameters
- experimentPaths: IExperimentPaths
- experiment: ExperimentBsbm
Returns Promise<void>

Generated using TypeDoc