PeopleLaserFrame#

class PeopleLaserFrame(*args, **kwargs)[source]#

Bases: WrappedClass

Laserframe for people (e.g., agent) properties

Initialize a LaserFrame object.

Parameters:
  • capacity (int) – The maximum capacity of the frame. Must be a positive integer.

  • initial_count (int) – The initial number of active elements in the frame. Must be a positive integer <= capacity.

  • **kwargs (dict) – Additional keyword arguments to set as attributes of the object.

Raises:

ValueError – If capacity or initial_count is not a positive integer, or if initial_count is greater than capacity.

Attributes

capacity

Returns the capacity of the laser frame (total possible entries for dynamic properties).

count

Returns the current count (equivalent to len()).

patch_id

state

susceptibility

Methods