Click or drag to resize

ExperimentCollection Class

Collection of experiments.
Inheritance Hierarchy
SystemObject
  Demo3D.ExperimentsExperimentCollection

Namespace: Demo3D.Experiments
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 19.00.00
Syntax
C#
public class ExperimentCollection

The ExperimentCollection type exposes the following members.

Properties
 NameDescription
Public propertyCount Number of experiments.
Public propertyCurrent The experiment currently selected.
Public propertyExperimentsTable The experiments table.
Public propertyFirst The first experiment in the collection.
Public propertyIsThisParallelInstance Returns whether this application is a Parallel Instance of Demo3D.
Public propertyItem Get the Experiment at index 'i' from the experiment collection.
Public propertySpeed The speed at which to run the experiments.
Top
Methods
 NameDescription
Public methodAddExperiment Creates and adds a new experiment to both the collection and table.
Public methodAddExperiment(Boolean) Creates and adds a new experiment to both the collection and table.
Public methodAddProperty Adds a new experiment property column to the experiments table.
Public methodClear Clears all experiments and then adds an empty experiment ready for configuration.
Public methodCreateNewAnalysisDocument Creates a new document in the analysis window.
Public methodGetResults 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.
Public methodRenumber Renumbers the experiments so that the numbering is the sequence [1, Count].
Public methodStartExperimentNow 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.
Public methodStopExperimentNow Callback function that is executed when the current experiment has finished; for example because the simulation time has reached the experiment's ending time.
Top
See Also