cppyabm  1.0.17
An agent-based library to integrate C++ and Python
Public Member Functions | Public Attributes | List of all members
MOVE_CONFIG< ENV, AGENT, PATCH > Struct Template Reference

Configuration of move order. More...

#include <common.h>

Public Member Functions

 MOVE_CONFIG (bool flag=false, shared_ptr< PATCH > _patch=nullptr, bool quiet=false, bool reset=false)
 
 MOVE_CONFIG (bool flag=false, shared_ptr< PATCH > _patch=nullptr, bool quiet=false, bool reset=false)
 

Public Attributes

bool _flag
 if false, the entire process is skipped. More...
 
shared_ptr< PATCH > _patch
 the patch that the new agent will be set. If null, a random patch will be selected. More...
 
bool _quiet
 Silent exceptions if hatch fails. More...
 
bool _reset
 Resets upon failure in hatching. If false, the agent will try in the next steps again. More...
 

Detailed Description

template<class ENV, class AGENT, class PATCH>
struct MOVE_CONFIG< ENV, AGENT, PATCH >

Configuration of move order.

Definition at line 28 of file common.h.

Constructor & Destructor Documentation

◆ MOVE_CONFIG() [1/2]

template<class ENV , class AGENT , class PATCH >
MOVE_CONFIG< ENV, AGENT, PATCH >::MOVE_CONFIG ( bool  flag = false,
shared_ptr< PATCH >  _patch = nullptr,
bool  quiet = false,
bool  reset = false 
)
inline

Definition at line 29 of file common.h.

◆ MOVE_CONFIG() [2/2]

template<class ENV , class AGENT , class PATCH >
MOVE_CONFIG< ENV, AGENT, PATCH >::MOVE_CONFIG ( bool  flag = false,
shared_ptr< PATCH >  _patch = nullptr,
bool  quiet = false,
bool  reset = false 
)
inline

Definition at line 29 of file common.h.

Member Data Documentation

◆ _flag

template<class ENV , class AGENT , class PATCH >
bool MOVE_CONFIG< ENV, AGENT, PATCH >::_flag

if false, the entire process is skipped.

Definition at line 36 of file common.h.

◆ _patch

template<class ENV , class AGENT , class PATCH >
shared_ptr< PATCH > MOVE_CONFIG< ENV, AGENT, PATCH >::_patch

the patch that the new agent will be set. If null, a random patch will be selected.

Definition at line 37 of file common.h.

◆ _quiet

template<class ENV , class AGENT , class PATCH >
bool MOVE_CONFIG< ENV, AGENT, PATCH >::_quiet

Silent exceptions if hatch fails.

Definition at line 38 of file common.h.

◆ _reset

template<class ENV , class AGENT , class PATCH >
bool MOVE_CONFIG< ENV, AGENT, PATCH >::_reset

Resets upon failure in hatching. If false, the agent will try in the next steps again.

Definition at line 39 of file common.h.


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