Skip to content

ClassDefinition_step2

RoiArthurB edited this page Jul 30, 2026 · 3 revisions

Attributes and Actions

Dot Notation

Reading an attribute

counter c <- counter(label: "clicks", value: 0, step: 1);
int val <- c.value;  // val = 0

Writing an attribute

c.value <- 42;    // direct write
c.step <- 5;      // change the step size

Note: Objects are NOT agents. They have no reflex, no schedule, no population. All state changes must be driven by explicit calls from the outside — either direct attribute assignment or via actions.

Calling Actions

Actions that return a value

int val <- c.increment();  // val = 43 (value becomes 45 after +step=5*1=5... wait, step is 5, so increment adds 5)
// After c.value <- 42, c.increment() adds step(5) → value becomes 47

Actions that modify state

c.reset();       // sets value back to 0, no meaningful return
write c.to_string();  // clicks = 0  (step=5)

Chained Action Calls

Use the return value directly as an operand:

bool big <- c.increment() > 50;
// This calls increment() which returns the new value,
// then compares it to 50 — all in one expression.

Passing Objects as Arguments

Actions can take object arguments — the type is declared in the signature:

class counter {
	int value <- 0;
	
	bool same_value_as(counter other) {
		return value = other.value;
	}
}

counter c <- counter(value: 10);
counter d <- counter(value: 20);
c.same_value_as(d);        // false after both have value 10 → true after reset

Object Comparison

Two objects of the same type can be compared using the = operator. In the counter example, same_value_as checks if the value attributes match.

Aggregate Operations Over Lists of Objects

Objects stored in lists can be processed using GAML's collection operations:

list<counter> counters <- [];
loop i from: 1 to: 5 {
	counters <+ counter(label: "c" + i, value: rnd(10), step: 1);
}

// Collect an attribute from every object
write "Counters: " + (counters collect each.to_string());

// Compute aggregate values
int max_val <- max(counters collect each.value);
float mean_val <- mean(counters collect each.value);
write "Max value: " + max_val;
write "Mean value: " + (mean_val with_precision 2);

// Iterate and mutate
loop cnt over: counters {
	if float(cnt.value) < mean_val {
		cnt.increment();
	}
}

Example: Bank Account

class bank_account {
	string owner <- "unknown";
	float balance <- 0.0;
	float min_balance <- 0.0;
	
	bool deposit(float amount) {
		if amount <= 0.0 { return false; }
		balance <- balance + amount;
		return true;
	}
	
	bool withdraw(float amount) {
		if amount <= 0.0 { return false; }
		if balance - amount < min_balance { return false; }
		balance <- balance - amount;
		return true;
	}
	
	bool transfer(float amount, bank_account target) {
		if withdraw(amount) {
			bool ok <- target.deposit(amount);
			return ok;
		}
		return false;
	}
	
	string to_string() {
		return owner + ": balance=" + (balance with_precision 2);
	}
}

global {
	init {
		bank_account alice <- bank_account(owner: "Alice", balance: 500.0);
		bank_account bob   <- bank_account(owner: "Bob",   balance:  50.0);
		
		bool ok1 <- alice.deposit(200.0);        // true
		bool ok2 <- alice.withdraw(100.0);       // true
		bool ok4 <- alice.transfer(300.0, bob);  // true (Alice:200, Bob:350)
		
		bool ok5 <- alice.transfer(999.0, bob);  // false (insufficient funds)
	}
}

Key Takeaways

Operation Syntax
Read attribute obj.attr
Write attribute obj.attr <- value
Call action obj.action(args)
Chain action results bool ok <- obj.action() > threshold
Pass object as argument obj.method(other_object)
Collect attribute list collect each.attr
  1. What's new (Changelog)
  2. Migration Guide (2025-06 → 2026-06)
  1. Installation and Launching
    1. Installation
    2. Launching GAMA
    3. Updating GAMA
    4. Installing Plugins
  2. Workspace, Projects and Models
    1. Navigating in the Workspace
    2. Changing Workspace
    3. Importing Models
  3. Editing Models
    1. GAML Editor (Generalities)
    2. GAML Editor Tools
    3. Validation of Models
  4. Running Experiments
    1. Launching Experiments
    2. Experiments User interface
    3. Controls of experiments
    4. Parameters view
    5. Inspectors and monitors
    6. Displays
    7. Batch Specific UI
    8. Errors View
  5. Running Headless
    1. Getting Started
    2. Headless Legacy
    3. Headless Batch
  6. Preferences
  7. Troubleshooting
  1. Introduction
    1. Start with GAML
    2. Organization of a Model
    3. Basic programming concepts in GAML
  2. Manipulate basic Species
  3. Global Species
    1. Regular Species
    2. Defining Actions and Behaviors
    3. Interaction between Agents
    4. Attaching Skills
    5. Inheritance
  4. Defining Advanced Species
    1. Grid Species
    2. Graph Species
    3. Mirror Species
    4. Multi-Level Architecture
  5. Defining GUI Experiment
    1. Defining Parameters
    2. Defining Displays Generalities
    3. Defining 3D Displays
    4. Defining Charts
    5. Defining Monitors and Inspectors
    6. Defining Export files
    7. Defining User Interaction
  6. Classes and Objects
    1. Class Definition and Instantiation
    2. Attributes and Actions
    3. Inheritance
    4. Virtual Classes
    5. Advanced Features
  7. Exploring Models
    1. Run Several Simulations
    2. Batch Experiments
    3. Exploration Methods
  8. Optimizing Models
    1. Runtime Concepts
    2. Analyzing code performance
    3. Optimizing Models
  9. Multi-Paradigm Modeling
    1. Control Architecture
    2. Defining Differential Equations
  1. Manipulate OSM Data
  2. Cleaning OSM Data
  3. Diffusion
  4. Using Database
  5. Using Dataframes
  6. Using FIPA ACL
  7. Using BDI with BEN
  8. Using Driving Skill
  9. Manipulate dates
  10. Manipulate lights
  11. Using comodel
  12. Save and restore Simulations
  13. Using network
  14. Writing Unit Tests
  15. Ensure model's reproducibility
  16. Going further with extensions
    1. Calling R
    2. Using Graphical Editor
    3. Using Git from GAMA
  1. Built-in Species
  2. Built-in Skills
  3. Built-in Architecture
  4. Statements
  5. Data Type
  6. File Type
  7. Stats Extension
  8. Sound Extension
  9. BDI Extension
  10. FIPA Skill
  11. Expressions
    1. Literals
    2. Units and Constants
    3. Pseudo Variables
    4. Variables And Attributes
    5. Operators (Definition)
    6. Operators [A-A]
    7. Operators [B-C]
    8. Operators [D-H]
    9. Operators [I-M]
    10. Operators [N-R]
    11. Operators [S-Z]
  12. Exhaustive list of GAMA Keywords
  1. Installing the development version
    1. Install GAMA source code with Eclipse plugin
  2. Developing Extensions
    1. Developing Plugins
    2. Developing Skills
    3. Developing Statements
    4. Developing Operators
    5. Developing Types
    6. Developing Species
    7. Developing Control Architectures
    8. Index of annotations
  3. Introduction to GAMA Java API
    1. Architecture of GAMA
    2. IScope
  4. Using GAMA flags
  5. Creating a release of GAMA
  6. Documentation generation

  1. Predator Prey
  2. Road Traffic
  3. Incremental Model
  4. Luneray's flu
  5. BDI Agents
  6. Forager RL
  7. SIR Analysis
  8. 3D Model

  1. Team
  2. Projects using GAMA
  3. Scientific References
  4. Training Sessions

Resources

  1. Videos
  2. Conferences
  3. Pedagogical materials

Clone this wiki locally