AgentVariables and ModelVariables

AgentVariables

An AgentVariable holds state of an agent’s module. It has to be specified in the config.

An AgentVariable has the following fields:

field_name	default	description
name		The name of the variable
type	None	Name the type of the variable using a string
timestamp	None	Timestamp of the current value
unit	Not defined	Unit of the variable
description	Not defined	Description of the variable
ub	inf	Upper bound of the variables value, used only for numeric values.
lb	-inf	Lower bound of the variables value, used only for numeric values.
clip	False	If set to true, values outside of bounds will be clipped of
allowed_values	[]	If provided, the value may only be any value inside the given set of allowed values. Example would be to only allow only the string options ‘Create’, ‘Update’ and ‘Delete’. Then you should pass allowed_values=[‘Create’, ‘Update’, ‘Delete’]
value	None	The value of the variable
alias	None	Alias, i.e. public name, of the AgentVariable
source	None_None
shared	False	Indicates if the variable is going to be shared with other agents. If False, no external communication of this variable should take place in any module.
rdf_class	None