BioDynaMo  v1.05.0-137fdb15
Public Member Functions | Public Attributes | List of all members
bdm::UniformGridEnvironment::Box::Iterator Struct Reference

An iterator that iterates over the cells in this box. More...

#include <uniform_grid_environment.h>

Collaboration diagram for bdm::UniformGridEnvironment::Box::Iterator:
[legend]

Public Member Functions

 Iterator (UniformGridEnvironment *grid, const Box *box)
 
bool IsAtEnd ()
 
Iteratoroperator++ ()
 
AgentHandle operator* () const
 

Public Attributes

UniformGridEnvironmentgrid_
 Pointer to the neighbor grid; for accessing the successor_ list. More...
 
AgentHandle current_value_
 The current agent to be considered. More...
 
int countdown_ = 0
 The remain number of agents to consider. More...
 

Detailed Description

An iterator that iterates over the cells in this box.

Definition at line 125 of file uniform_grid_environment.h.

Constructor & Destructor Documentation

◆ Iterator()

bdm::UniformGridEnvironment::Box::Iterator::Iterator ( UniformGridEnvironment grid,
const Box box 
)
inline

Definition at line 126 of file uniform_grid_environment.h.

Member Function Documentation

◆ IsAtEnd()

bool bdm::UniformGridEnvironment::Box::Iterator::IsAtEnd ( )
inline

Definition at line 133 of file uniform_grid_environment.h.

◆ operator*()

AgentHandle bdm::UniformGridEnvironment::Box::Iterator::operator* ( ) const
inline

Definition at line 143 of file uniform_grid_environment.h.

◆ operator++()

Iterator& bdm::UniformGridEnvironment::Box::Iterator::operator++ ( )
inline

Definition at line 135 of file uniform_grid_environment.h.

Member Data Documentation

◆ countdown_

int bdm::UniformGridEnvironment::Box::Iterator::countdown_ = 0

The remain number of agents to consider.

Definition at line 150 of file uniform_grid_environment.h.

◆ current_value_

AgentHandle bdm::UniformGridEnvironment::Box::Iterator::current_value_

The current agent to be considered.

Definition at line 148 of file uniform_grid_environment.h.

◆ grid_

UniformGridEnvironment* bdm::UniformGridEnvironment::Box::Iterator::grid_

Pointer to the neighbor grid; for accessing the successor_ list.

Definition at line 146 of file uniform_grid_environment.h.


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