bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex Class Reference

#include <uniform_grid_environment.h>

Inheritance diagram for bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex:

Collaboration diagram for bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex:

Public Member Functions
	GridNeighborMutex (const FixedSizeVector< uint64_t, 27 > &mutex_indices, GridNeighborMutexBuilder *mutex_builder)
	~GridNeighborMutex () override=default
void	lock () override
void	unlock () override
void	SetMutexIndices (const FixedSizeVector< uint64_t, 27 > &indices)
Public Member Functions inherited from bdm::Environment::NeighborMutexBuilder::NeighborMutex
virtual	~NeighborMutex ()=default

Private Attributes
FixedSizeVector< uint64_t, 27 >	mutex_indices_
GridNeighborMutexBuilder *	mutex_builder_

Detailed Description

The NeighborMutex class is a synchronization primitive that can be used to protect agents data from being simultaneously accessed by multiple threads.

Definition at line 545 of file uniform_grid_environment.h.

Constructor & Destructor Documentation

GridNeighborMutex()

bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::GridNeighborMutex ( const FixedSizeVector< uint64_t, 27 > &  mutex_indices, GridNeighborMutexBuilder *  mutex_builder  )

inline

Definition at line 548 of file uniform_grid_environment.h.

~GridNeighborMutex()

bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::~GridNeighborMutex ( )

overridedefault

Member Function Documentation

lock()

void bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::lock ( )

inlineoverridevirtual

Reimplemented from bdm::Environment::NeighborMutexBuilder::NeighborMutex.

Definition at line 559 of file uniform_grid_environment.h.

SetMutexIndices()

void bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::SetMutexIndices ( const FixedSizeVector< uint64_t, 27 > &  indices )

inline

Definition at line 575 of file uniform_grid_environment.h.

unlock()

void bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::unlock ( )

inlineoverridevirtual

Reimplemented from bdm::Environment::NeighborMutexBuilder::NeighborMutex.

Definition at line 568 of file uniform_grid_environment.h.

Member Data Documentation

mutex_builder_

GridNeighborMutexBuilder* bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::mutex_builder_

private

Definition at line 582 of file uniform_grid_environment.h.

mutex_indices_

FixedSizeVector<uint64_t, 27> bdm::UniformGridEnvironment::GridNeighborMutexBuilder::GridNeighborMutex::mutex_indices_

private

Definition at line 581 of file uniform_grid_environment.h.

---

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

• core/environment/uniform_grid_environment.h