so_5::agent_context_t Class Reference

A context for agent construction and tuning. More...

#include <agent_context.hpp>

Public Member Functions
	agent_context_t (environment_t &env)
	Constructor for the case when only environment available.
	agent_context_t (environment_t &env, agent_tuning_options_t options)
environment_t &	env () const
	Access to SObjectizer Environment.
environment_t &	environment () const
	Access to SObjectizer Environment.
agent_tuning_options_t &	options ()
	Read-Write access to agent options.
const agent_tuning_options_t &	options () const
	Read-only access to agent options.

Private Attributes
environment_t *	m_env
	SObjectizer Environment to work in.
agent_tuning_options_t	m_options
	Options for agent tuning.

Friends
void	swap (so_5::agent_context_t &a, so_5::agent_context_t &b) noexcept
	Swap operation.

Detailed Description

A context for agent construction and tuning.

Since

v.5.5.4

Examples

so_5/custom_direct_mbox/main.cpp.

Definition at line 29 of file agent_context.hpp.

Constructor & Destructor Documentation

agent_context_t() [1/2]

so_5::agent_context_t::agent_context_t ( environment_t & env )

inline

Constructor for the case when only environment available.

Parameters

env	SObjectizer Environment an agent will work in.

Definition at line 33 of file agent_context.hpp.

agent_context_t() [2/2]

so_5::agent_context_t::agent_context_t ( environment_t & env, agent_tuning_options_t options )

inline

Constructor for the case when environment and already created tuning option object are avaliable.

Parameters

env	SObjectizer Environment an agent will work in.
options	Options to be used for agent tuning.

Definition at line 41 of file agent_context.hpp.

Member Function Documentation

env()

environment_t & so_5::agent_context_t::env ( ) const

inline

Access to SObjectizer Environment.

Definition at line 63 of file agent_context.hpp.

environment()

environment_t & so_5::agent_context_t::environment ( ) const

inline

Access to SObjectizer Environment.

Since

v.5.5.9

Definition at line 73 of file agent_context.hpp.

options() [1/2]

agent_tuning_options_t & so_5::agent_context_t::options ( )

inline

Read-Write access to agent options.

Definition at line 80 of file agent_context.hpp.

options() [2/2]

const agent_tuning_options_t & so_5::agent_context_t::options ( ) const

inline

Read-only access to agent options.

Definition at line 87 of file agent_context.hpp.

Friends And Related Symbol Documentation

swap

void swap ( so_5::agent_context_t & a, so_5::agent_context_t & b )

friend

Swap operation.

Definition at line 52 of file agent_context.hpp.

Member Data Documentation

m_env

environment_t* so_5::agent_context_t::m_env

private

SObjectizer Environment to work in.

Definition at line 94 of file agent_context.hpp.

m_options

agent_tuning_options_t so_5::agent_context_t::m_options

private

Options for agent tuning.

Definition at line 96 of file agent_context.hpp.

---

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

• agent_context.hpp