cppyabm  1.0.17
An agent-based library to integrate C++ and Python
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
script.Domain Class Reference
Inheritance diagram for script.Domain:
script.pyDomain

Public Member Functions

def __init__ (self, output_flag)
 
def generate_agent (self, agent_name)
 
def generate_patch (self, mesh_item)
 
def update_repo (self)
 
def damage (self)
 
def setup (self)
 
def step (self)
 
def episode (self)
 
def update (self)
 
def output (self)
 
def __init__ (self, output_flag)
 
def generate_agent (self, agent_name)
 
def generate_patch (self, mesh_item)
 
def update_repo (self)
 
def damage (self)
 
def setup (self)
 
def step (self)
 
def episode (self)
 
def update (self)
 
def output (self)
 
def __init__ (self)
 
def generate_agent (self, agent_name)
 
def generate_patch (self, mesh_item)
 
def update_repo (self)
 
def damage (self)
 
def setup (self)
 
def step (self)
 
def episode (self)
 
def update (self)
 
def output (self)
 
def __init__ (self)
 
def generate_agent (self, agent_name)
 
def generate_patch (self, mesh_item)
 
def update_repo (self)
 
def damage (self)
 
def setup (self)
 
def step (self)
 
def episode (self)
 
def update (self)
 
def output (self)
 

Public Attributes

 agents_repo
 
 patches_repo
 
 tick
 
 data
 
 output_flag
 

Static Public Attributes

int memory_usage_max = 0
 
 memory_usage_max
 

Detailed Description

This class extends Env to simulate coordinate the simulation.

Definition at line 58 of file script.py.

Constructor & Destructor Documentation

◆ __init__() [1/4]

def script.Domain.__init__ (   self,
  output_flag 
)

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 63 of file script.py.

◆ __init__() [2/4]

def script.Domain.__init__ (   self,
  output_flag 
)

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 63 of file script.py.

◆ __init__() [3/4]

def script.Domain.__init__ (   self)

Definition at line 76 of file script.py.

◆ __init__() [4/4]

def script.Domain.__init__ (   self)

Definition at line 76 of file script.py.

Member Function Documentation

◆ damage() [1/4]

def script.Domain.damage (   self)
Create damage

Definition at line 101 of file script.py.

◆ damage() [2/4]

def script.Domain.damage (   self)
Create damage

Definition at line 108 of file script.py.

◆ damage() [3/4]

def script.Domain.damage (   self)
Create damage

Definition at line 97 of file script.py.

◆ damage() [4/4]

def script.Domain.damage (   self)
Create damage

Definition at line 108 of file script.py.

◆ episode() [1/4]

def script.Domain.episode (   self)
Simulate the whole duration of the run

Definition at line 141 of file script.py.

◆ episode() [2/4]

def script.Domain.episode (   self)
Simulate the whole duration of the run

Definition at line 148 of file script.py.

◆ episode() [3/4]

def script.Domain.episode (   self)
Simulate the whole duration of the run

Definition at line 137 of file script.py.

◆ episode() [4/4]

def script.Domain.episode (   self)
Simulate the whole duration of the run

Definition at line 148 of file script.py.

◆ generate_agent() [1/4]

def script.Domain.generate_agent (   self,
  agent_name 
)
Extension of the original function to create agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 75 of file script.py.

◆ generate_agent() [2/4]

def script.Domain.generate_agent (   self,
  agent_name 
)
Extension of the original function to create agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 82 of file script.py.

◆ generate_agent() [3/4]

def script.Domain.generate_agent (   self,
  agent_name 
)
Extension of the original function to create agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 71 of file script.py.

◆ generate_agent() [4/4]

def script.Domain.generate_agent (   self,
  agent_name 
)
Extension of the original function to create agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 82 of file script.py.

◆ generate_patch() [1/4]

def script.Domain.generate_patch (   self,
  mesh_item 
)
Extension of the original function to create pacthes

Definition at line 83 of file script.py.

◆ generate_patch() [2/4]

def script.Domain.generate_patch (   self,
  mesh_item 
)
Extension of the original function to create pacthes

Definition at line 90 of file script.py.

◆ generate_patch() [3/4]

def script.Domain.generate_patch (   self,
  mesh_item 
)
Extension of the original function to create pacthes

Definition at line 79 of file script.py.

◆ generate_patch() [4/4]

def script.Domain.generate_patch (   self,
  mesh_item 
)
Extension of the original function to create pacthes

Definition at line 90 of file script.py.

◆ output() [1/4]

def script.Domain.output (   self)
Output the results

Definition at line 160 of file script.py.

◆ output() [2/4]

def script.Domain.output (   self)
Output the results

Definition at line 167 of file script.py.

◆ output() [3/4]

def script.Domain.output (   self)
Output the results

Definition at line 156 of file script.py.

◆ output() [4/4]

def script.Domain.output (   self)
Output the results

Definition at line 167 of file script.py.

◆ setup() [1/4]

def script.Domain.setup (   self)
Setup the simulation by creating mesh, patches, damage, and agents

Definition at line 112 of file script.py.

◆ setup() [2/4]

def script.Domain.setup (   self)
Setup the simulation by creating mesh, patches, damage, and agents

Definition at line 119 of file script.py.

◆ setup() [3/4]

def script.Domain.setup (   self)
Setup the simulation by creating mesh, patches, damage, and agents

Definition at line 108 of file script.py.

◆ setup() [4/4]

def script.Domain.setup (   self)
Setup the simulation by creating mesh, patches, damage, and agents

Definition at line 119 of file script.py.

◆ step() [1/4]

def script.Domain.step (   self)
Simulate the progress of the model

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 127 of file script.py.

◆ step() [2/4]

def script.Domain.step (   self)
Simulate the progress of the model

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 134 of file script.py.

◆ step() [3/4]

def script.Domain.step (   self)
Simulate the progress of the model

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 123 of file script.py.

◆ step() [4/4]

def script.Domain.step (   self)
Simulate the progress of the model

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 134 of file script.py.

◆ update() [1/4]

def script.Domain.update (   self)
Update the model. A call to parent function is sent to take care of default functions.

Definition at line 150 of file script.py.

◆ update() [2/4]

def script.Domain.update (   self)
Update the model. A call to parent function is sent to take care of default functions.

Definition at line 157 of file script.py.

◆ update() [3/4]

def script.Domain.update (   self)
Update the model. A call to parent function is sent to take care of default functions.

Definition at line 146 of file script.py.

◆ update() [4/4]

def script.Domain.update (   self)
Update the model. A call to parent function is sent to take care of default functions.

Definition at line 157 of file script.py.

◆ update_repo() [1/4]

def script.Domain.update_repo (   self)
Updates the repository to remove inactive agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 91 of file script.py.

◆ update_repo() [2/4]

def script.Domain.update_repo (   self)
Updates the repository to remove inactive agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 98 of file script.py.

◆ update_repo() [3/4]

def script.Domain.update_repo (   self)
Updates the repository to remove inactive agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 87 of file script.py.

◆ update_repo() [4/4]

def script.Domain.update_repo (   self)
Updates the repository to remove inactive agents

Reimplemented in script.pyDomain, and script.pyDomain.

Definition at line 98 of file script.py.

Member Data Documentation

◆ agents_repo

script.Domain.agents_repo

Definition at line 65 of file script.py.

◆ data

script.Domain.data

Definition at line 68 of file script.py.

◆ memory_usage_max [1/2]

int Domain.memory_usage_max = 0
static

Definition at line 62 of file script.py.

◆ memory_usage_max [2/2]

script.Domain.memory_usage_max
static

Definition at line 75 of file script.py.

◆ output_flag

script.Domain.output_flag

Definition at line 69 of file script.py.

◆ patches_repo

script.Domain.patches_repo

Definition at line 66 of file script.py.

◆ tick

script.Domain.tick

Definition at line 67 of file script.py.


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