Settings used for initializing GAMS controllers. More...

#include <ControllerSettings.h>

Public Member Functions
	ControllerSettings ()=default
	Constructor. More...

Public Attributes
std::string	agent_prefix = "agent.0"
	the default agent prefix(e.g., "agent.bob" or "agent.0"). More...

std::string	checkpoint_prefix = "checkpoint"
	the knowledge checkpointing file system prefix(e.g., "./checkpoint" will save checkpoints to current directory in files that start with checkpoint More...

int	checkpoint_strategy = CHECKPOINT_NONE
	the knowledge checkpointing strategy More...

madara::knowledge::EvalSettings	eval_settings
	settings used in any KnowledgeBase operations by this controller More...

int	gams_log_level = -1
	the gams logging level(negative means don't change) More...

double	loop_hertz = 2.0
	the hertz rate that a controller should run at More...

int	madara_log_level = -1
	the MADARA logging level(negative means don't change) More...

double	run_time = -1
	maximum runtime(-1 means persistent, forever) More...

int	scheduling_strategy = SCHEDULE_ROUND_ROBIN
	for multicontrollers, default to round robin schedule More...

double	send_hertz = 1.0
	the hertz rate to call send_modifieds at More...

bool	shared_memory_transport = true
	include a shared memory transport when managing multiple controllers More...

int	simulation_engine = 0
	Decide on which simulation engine to run. More...

int	threading_strategy = THREADS_NONE
	for multicontrollers, default to no launched threads More...

Detailed Description

Settings used for initializing GAMS controllers.

Definition at line 97 of file ControllerSettings.h.

Constructor & Destructor Documentation

◆ ControllerSettings()

gams::controllers::ControllerSettings::ControllerSettings ( )

default

Constructor.

Member Data Documentation

◆ agent_prefix

std::string gams::controllers::ControllerSettings::agent_prefix = "agent.0"

the default agent prefix(e.g., "agent.bob" or "agent.0").

This is a prefix of what the self_ agent prefix will be in the knowledge base. E.g., agent.0.location, agent.0.algorithm, etc.

Definition at line 110 of file ControllerSettings.h.

◆ checkpoint_prefix

std::string gams::controllers::ControllerSettings::checkpoint_prefix = "checkpoint"

the knowledge checkpointing file system prefix(e.g., "./checkpoint" will save checkpoints to current directory in files that start with checkpoint

Definition at line 116 of file ControllerSettings.h.

◆ checkpoint_strategy

int gams::controllers::ControllerSettings::checkpoint_strategy = CHECKPOINT_NONE

the knowledge checkpointing strategy

Definition at line 119 of file ControllerSettings.h.

◆ eval_settings

madara::knowledge::EvalSettings gams::controllers::ControllerSettings::eval_settings

Initial value:

=

madara::knowledge::EvalSettings::SEND

settings used in any KnowledgeBase operations by this controller

Definition at line 137 of file ControllerSettings.h.

◆ gams_log_level

int gams::controllers::ControllerSettings::gams_log_level = -1

the gams logging level(negative means don't change)

Definition at line 122 of file ControllerSettings.h.

◆ loop_hertz

double gams::controllers::ControllerSettings::loop_hertz = 2.0

the hertz rate that a controller should run at

Definition at line 125 of file ControllerSettings.h.

◆ madara_log_level

int gams::controllers::ControllerSettings::madara_log_level = -1

the MADARA logging level(negative means don't change)

Definition at line 128 of file ControllerSettings.h.

◆ run_time

double gams::controllers::ControllerSettings::run_time = -1

maximum runtime(-1 means persistent, forever)

Definition at line 131 of file ControllerSettings.h.

◆ scheduling_strategy

int gams::controllers::ControllerSettings::scheduling_strategy = SCHEDULE_ROUND_ROBIN

for multicontrollers, default to round robin schedule

Definition at line 144 of file ControllerSettings.h.

◆ send_hertz

double gams::controllers::ControllerSettings::send_hertz = 1.0

the hertz rate to call send_modifieds at

Definition at line 134 of file ControllerSettings.h.

◆ shared_memory_transport

bool gams::controllers::ControllerSettings::shared_memory_transport = true

include a shared memory transport when managing multiple controllers

Definition at line 147 of file ControllerSettings.h.

◆ simulation_engine

int gams::controllers::ControllerSettings::simulation_engine = 0

Decide on which simulation engine to run.

Used if the simulator can be controlled via direct code. Defaults to -1 e.g not set.

Definition at line 151 of file ControllerSettings.h.

◆ threading_strategy

int gams::controllers::ControllerSettings::threading_strategy = THREADS_NONE

for multicontrollers, default to no launched threads

Definition at line 141 of file ControllerSettings.h.

The documentation for this class was generated from the following file:

src/gams/controllers/ControllerSettings.h

Public Member Functions

Public Attributes