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

Configuration of hatch order. More...

#include <common.h>

Public Member Functions

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

Public Attributes

bool _flag
 if false, the entire hatching 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 _inherit
 Inherit from current patch. Agent::inherit should be defined for this purpose. 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 HATCH_CONFIG< ENV, AGENT, PATCH >

Configuration of hatch order.

Definition at line 8 of file common.h.

Constructor & Destructor Documentation

◆ HATCH_CONFIG() [1/2]

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

Definition at line 9 of file common.h.

◆ HATCH_CONFIG() [2/2]

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

Definition at line 9 of file common.h.

Member Data Documentation

◆ _flag

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

if false, the entire hatching process is skipped.

Definition at line 20 of file common.h.

◆ _inherit

template<class ENV , class AGENT , class PATCH >
bool HATCH_CONFIG< ENV, AGENT, PATCH >::_inherit

Inherit from current patch. Agent::inherit should be defined for this purpose.

Definition at line 22 of file common.h.

◆ _patch

template<class ENV , class AGENT , class PATCH >
shared_ptr< PATCH > HATCH_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 21 of file common.h.

◆ _quiet

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

Silent exceptions if hatch fails.

Definition at line 23 of file common.h.

◆ _reset

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

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

Definition at line 24 of file common.h.


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