ExperimentCollection Class

Collection of experiments.

Inheritance Hierarchy

SystemObject
Demo3D.ExperimentsExperimentCollection

Namespace: Demo3D.Experiments
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 18.03.00

Syntax

public class ExperimentCollection

The ExperimentCollection type exposes the following members.

Properties

	Name	Description
	Count	Number of experiments.
	Current	The experiment currently selected.
	ExperimentsTable	The experiments table.
	First	The first experiment in the collection.
	IsThisParallelInstance	Returns whether this application is a Parallel Instance of Demo3D.
	Item	Get the Experiment at index 'i' from the experiment collection.
	Speed	The speed at which to run the experiments.

Methods

	Name	Description
	AddExperiment	Creates and adds a new experiment to both the collection and table.
	AddExperiment(Boolean)	Creates and adds a new experiment to both the collection and table.
	AddProperty	Adds a new experiment property column to the experiments table.
	Clear	Clears all experiments and then adds an empty experiment ready for configuration.
	CreateNewAnalysisDocument	Creates a new document in the analysis window.
	GetResults	Collects all simulation experiment tables and the experiment definitions together into a single dataset. An experiment column is added as the first column of each of the tables in the data set to identify which experiment that table row is from.
	Renumber	Renumbers the experiments so that the numbering is the sequence [1, Count].
	StartExperimentNow	Callback function that is executed when the current experiment's start time is reached. Queues an event to stop the experiment after the current experiment's duration.
	StopExperimentNow	Callback function that is executed when the current experiment has finished; for example because the simulation time has reached the experiment's ending time.