DSIMA
 All Classes Namespaces Files Functions Variables
StateAgent Class Reference

Abstract class of a state agent. More...

Inheritance diagram for StateAgent:
Collaboration diagram for StateAgent:

Public Member Functions

def __init__
 
def initialize
 Create the set of personal data of the state agent. More...
 
def act
 Perform the action of the agent. More...
 
def rename
 Rename the agent. More...
 
def __str__
 

Public Attributes

 name
 Actor name. More...
 

Static Private Attributes

 __metaclass__ = ABCMeta
 

Detailed Description

Abstract class of a state agent.

A state agent is an agent with a list of numeric state variables which may be checked for convergence.

Constructor & Destructor Documentation

def __init__ (   self,
  name = "" 
)

Member Function Documentation

def __str__ (   self)
def act (   self,
  data,
  layer 
)

Perform the action of the agent.

The data are modified by the actions of the agent.

Parameters
dataData needed for the action.
layerCurrent layer.
def initialize (   self,
  data 
)

Create the set of personal data of the state agent.

In particular it creates its personal dictionary of variables referenced by its name (

See also
Data.personal). One of its personal variables is 'statusVariables' which is a list of identifier of personal variables to check for convergence. These state variables must take the form of a list of floats.
Parameters
dataData.
def rename (   self,
  name = "" 
)

Rename the agent.

Parameters
nameNew name. If an empty name is given the new name is "Agent #id".

Member Data Documentation

__metaclass__ = ABCMeta
staticprivate
name

Actor name.


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