SimBiology^®

StatesToLog - Specify species data recorded

Description

The StatesToLog property indicates the species data to log during a simulation. This is the data returned in x during execution of (t,x) = sbiosimulate(modelObj). By default all species are logged.

Characteristics

Applies to	Object: `RunTimeOptions`
Data type	Object or vector of objects
Data values	Species objects to log. Default is `All`.
Access	Read/Write

Example

Illustrates how to assign species to StatesToLog.

Create a model object by importing the file oscillator.xml.
```
modelObj  = sbmlimport('oscillator');
```

Retrieve the first and second species in the modelObj.

speciesObj1 = modelObj.Species(1);
speciesObj2 = modelObj.Species(2);

Retrieve the configsetObj of modelObj.
```
configsetObj = getconfigset(modelObj);
```

Set the StatesToLog to record three species; two using the retrieved species objects and one using indexing and view the species in StatesToLog.

set (configsetObj.RuntimeOptions, 'StatesToLog', [speciesObj1, speciesObj2, modelObj.Species(3)]);
get(configsetObj.RuntimeOptions, 'StatesToLog')

SpeciesVariables

Stoichiometry