so_5::impl::internal_agent_iface_t Class Reference

A special class for access to private/protected members of agent class. More...

#include <internal_agent_iface.hpp>

Public Member Functions
	internal_agent_iface_t (agent_t &agent) noexcept
void	bind_to_coop (coop_t &coop)
void	initiate_agent_definition ()
void	shutdown_agent () noexcept
void	set_disp_binder (disp_binder_shptr_t binder)
	Setter for disp_binder.
disp_binder_t &	query_disp_binder () const
	Getter for disp_binder.
void	drop_disp_binder () noexcept
	Helper method that drops pointer to disp_binder.

Private Attributes
agent_t &	m_agent

Detailed Description

A special class for access to private/protected members of agent class.

Since

v.5.6.0

Definition at line 33 of file internal_agent_iface.hpp.

Constructor & Destructor Documentation

internal_agent_iface_t()

so_5::impl::internal_agent_iface_t::internal_agent_iface_t ( agent_t & agent )

inlineexplicitnoexcept

Definition at line 38 of file internal_agent_iface.hpp.

Member Function Documentation

bind_to_coop()

void so_5::impl::internal_agent_iface_t::bind_to_coop ( coop_t & coop )

inline

Definition at line 43 of file internal_agent_iface.hpp.

drop_disp_binder()

void so_5::impl::internal_agent_iface_t::drop_disp_binder ( )

inlinenoexcept

Helper method that drops pointer to disp_binder.

This method is intended to be used for rollback actions (for example, when disp_binder is set for the agent, but agent can't be stored in a coop).

Attention

It's not a thread safe method. But it's expected that it will be used in the context where just one entity owns the pointer to the agent.

Since

v.5.7.5

Definition at line 117 of file internal_agent_iface.hpp.

initiate_agent_definition()

void so_5::impl::internal_agent_iface_t::initiate_agent_definition ( )

inline

Definition at line 49 of file internal_agent_iface.hpp.

query_disp_binder()

disp_binder_t & so_5::impl::internal_agent_iface_t::query_disp_binder ( ) const

inlinenodiscard

Getter for disp_binder.

Attention

It's not a thread safe method. But it's expected that it will be used in the context where just one entity owns the pointer to the agent.

Since

v.5.7.5

Definition at line 92 of file internal_agent_iface.hpp.

set_disp_binder()

void so_5::impl::internal_agent_iface_t::set_disp_binder ( disp_binder_shptr_t binder )

inline

Setter for disp_binder.

Attention

It's not a thread safe method. But it's expected that it will be used in the context where just one entity owns the pointer to the agent.

Since

v.5.7.5

Definition at line 70 of file internal_agent_iface.hpp.

shutdown_agent()

void so_5::impl::internal_agent_iface_t::shutdown_agent ( )

inlinenoexcept

Definition at line 55 of file internal_agent_iface.hpp.

Member Data Documentation

m_agent

agent_t& so_5::impl::internal_agent_iface_t::m_agent

private

Definition at line 35 of file internal_agent_iface.hpp.

---

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

• internal_agent_iface.hpp