Show / Hide Table of Contents

State Class

A fundamental building block of any state-and-transition model is the State Class. A State Class is comprised of a Class and a Subclass.

In ST-Sim, each State Class is defined by a unique combination of Class and Subclass values. So, to create a State Class you must first create at least one record in both the Class and Subclass Properties.

Class

Datasheet internal name: stsim_StateLabelX

Column Options

The fields for the Class property are:

Display Name Internal Name Optional Data Type Description
Name Name No String The name of the Class.
Description Description Yes String A description of the Class.

Subclass

Datasheet internal name: stsim_StateLabelY

Column Options

The fields for the Subclass property are:

Display Name Internal Name Optional Data Type Description
Name Name No String The name of the Subclass.
Description Description Yes String A description of the Subclass.

State Class

Datasheet internal name: stsim_StateClass

Column Options

The fields for the State Class property are:

Display Name Internal Name Optional Data Type Description
Name Name No String The name of the State Class.
State Label X StateLabelXId No Integer The Class type.
State Label Y StateLabelYId No Integer The Subclass type.
Id Id Yes Integer The ID for the State Class when running a spatially explicit simulation.
Color Color Yes String The legend color for the State Class when displaying Spatial Maps. Double click in a cell to open the color editor and choose a color.
Map Legend Legend Yes String The map legend for the State Class when displaying Spatial Maps.
Description Description Yes String A description of the State Class.

Once you have created at least one Class and Subclass you are ready to create a State Class. State classes can be created manually by selecting a Class and a Subclass from the Class and Subclass combo boxes in the table. You can specify Name for your State Class, but if you leave this column blank a custom name will be generated for you. You can also create state classes directly in the transition pathway diagram, which will then be automatically added to the States table.

Remarks

The ID values for a State Class must correspond to the ID values for the State Class raster defined in the Spatial Initial Conditions Property.

Summary Table

Display Name Internal Name
Class stsim_StateLabelX
Subclass stsim_StateLabelY
State Class stsim_StateClass
In This Article
Back to top Copyright 2007-2025 Apex Resource Management Solutions Ltd.
Generated by DocFX