Class that performs a task. More...

#include <runnable.h>

Inheritance diagram for runnable:

Public Member Functions
	runnable ()
	Constructor for runnable.

virtual	~runnable ()
	Destructor for runnable.

virtual void	run_onetime ()
	Function that is called only one time on start.

virtual void	idle ()
	idling function that is called while is_running() returns true.

virtual bool	should_quit () const
	Function that if return true, the program will exit.

virtual bool	is_running () const
	Get if the simulation is running.

virtual void	set_running (bool running)
	Set if the simulation is running.

Public Member Functions inherited from recursive_configurable_module
virtual void	recursive_load (configuration &config) override
	Start recursively load configurables. More...

virtual void	recursive_configure (configuration &config) override
	Recursively call configure. More...

Public Member Functions inherited from recursive_configurable
	recursive_configurable ()=default
	Default constructor.

virtual void	recursive_initialize (const configurable::environment_map &environment=configurable::environment_map())
	Initialize the program itself and relay the same to its children. Used to get things ready for actual use. More...

virtual bool	is_ready () const
	Get if the instance is initialized. More...

virtual void	add_child (configurable *child)
	Add a child instance. More...

virtual void	add_child (recursive_configurable *child)
	Add a child instance. More...

virtual void	remove_child (configurable *child)
	Remove a child instance. More...

virtual void	remove_child (recursive_configurable *child)
	Remove a child instance. More...

virtual void	setup_now (configuration &config=get_global_configuration()) override
	Run recursive_load - recursive_configure - recursive_initialize processes.

virtual bool	not_recursive () override
	Check if this instance is not derived from recursive_configurable. More...

void	set_environment (std::string name, const void *value)
	Set the pointer to an environmental value associated with an input name. More...

Public Member Functions inherited from configurable
virtual void	load (configuration &config)
	Load the program. Used to load files and libraries into memory. More...

virtual void	configure (configuration &config)
	Configure the program. Used to load and set parameters. More...

Public Member Functions inherited from module
	module ()
	Default constructor for module.

virtual	~module ()
	Default destructor for module.

virtual std::string	get_module_name () const
	Get the module name. More...

Public Member Functions inherited from credit
	credit ()=default
	Default constructor.

	credit (std::string name, std::string argument_name)
	Constructor for credit. More...

virtual void	set_name (std::string name, std::string argument_name="")
	Set name (and perhaps, argument name together) More...

virtual std::string	get_name () const
	Get the name.

virtual void	set_argument_name (std::string argument_name)
	Set an argument name. More...

virtual std::string	get_argument_name () const
	Get an argument name. More...

virtual double	get_version () const
	Get version. More...

virtual std::string	get_author () const
	Get author's name. More...

virtual std::tuple< int, int, int >	get_date () const
	Get currently set date. More...

virtual std::string	get_email_address () const
	Get email address. More...

Public Member Functions inherited from messageable
virtual bool	send_message (std::string message, void *ptr=nullptr)
	Send a message. More...

virtual bool	const_send_message (std::string message, void *ptr=nullptr) const
	Send a message. More...

Protected Member Functions
virtual void	initialize (const environment_map &environment) override
	Initialize the program. Used to get things ready for actual use. More...

Protected Member Functions inherited from configurable
bool	check_set (const environment_map &environment, std::vector< std::string > names)
	Check if the values for a variable keys exist. More...

Additional Inherited Members
Public Types inherited from configurable
using	environment_map = std::map< std::string, const void * >
	Type for environment_map.

Static Public Member Functions inherited from configurable
static configuration &	set_global_configuration (const configuration &config)
	Assign the global settings of the program. More...

static configuration &	get_global_configuration ()
	Get the global settings of the program. More...

template<class T >
static const T &	get_env (const environment_map &environment, std::string key)
	Extract an specified type of pointer from the input environment. More...

Static Public Member Functions inherited from module
static std::string	module_libpath (std::string module_name)
	Get the path to the dynamic library. e.g., "mylib" -> "symlink-public/lib/libshiokaze_mylib.dylib". More...

static module *	alloc_module (configuration &config, std::string arg_name, std::string default_module_name, std::string description)
	Automatically reads the parameter "arg_name" to fetch the name for the library, and allocate the library. More...

static module *	alloc_module (std::string path)
	Reads the dynamic library of a class module, allocate, and return the pointer to it. More...

static unsigned	close_all_handles ()
	Close all the handles that are still unloaded. More...

template<class T >
static std::unique_ptr< T >	unique_alloc_module (configuration &config, std::string arg_name, std::string default_module_name, std::string description)
	Allocate the module and cast to the a specified class T. More...

static unsigned	count_open_modules ()
	Count all the open modules. More...

Protected Attributes inherited from credit
std::string	m_name
	Name of credit.

std::string	m_argument_name
	Argument name.

Detailed Description

Class that performs a task.

Member Function Documentation

◆ initialize()

virtual void runnable::initialize ( const environment_map & environment )

inlineoverrideprotectedvirtual

Initialize the program. Used to get things ready for actual use.

Parameters

[in] config Configuration setting.

Reimplemented from recursive_configurable.

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

include/shiokaze/core/runnable.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ initialize()