SObjectizer  5.7
Public Member Functions | Private Attributes | Friends | List of all members
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. More...
 
 agent_context_t (environment_t &env, agent_tuning_options_t options)
 
environment_tenv () const
 Access to SObjectizer Environment. More...
 
environment_tenvironment () const
 Access to SObjectizer Environment. More...
 
agent_tuning_options_toptions ()
 Read-Write access to agent options. More...
 
const agent_tuning_options_toptions () const
 Read-only access to agent options. More...
 

Private Attributes

environment_tm_env
 SObjectizer Environment to work in. More...
 
agent_tuning_options_t m_options
 Options for agent tuning. More...
 

Friends

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

Detailed Description

A context for agent construction and tuning.

Since
v.5.5.4
Examples:
so_5/custom_direct_mbox/main.cpp.

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
envSObjectizer Environment an agent will work in.

◆ 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
envSObjectizer Environment an agent will work in.
optionsOptions to be used for agent tuning.

Member Function Documentation

◆ env()

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

Access to SObjectizer Environment.

◆ environment()

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

Access to SObjectizer Environment.

Since
v.5.5.9

◆ options() [1/2]

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

Read-Write access to agent options.

◆ options() [2/2]

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

Read-only access to agent options.

Friends And Related Function Documentation

◆ swap

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

Swap operation.

Member Data Documentation

◆ m_env

environment_t* so_5::agent_context_t::m_env
private

SObjectizer Environment to work in.

◆ m_options

agent_tuning_options_t so_5::agent_context_t::m_options
private

Options for agent tuning.


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