UnitsParams Class Reference

Configuration parameters shared among multiple units. More...

#include <Unit.hpp>

Inheritance diagram for UnitsParams:

Public Member Functions
	UnitsParams (double moveRadius, const std::shared_ptr< FieldParams > &fieldParams, uint32_t unitsCount)
	Constructs the UnitsParams object.
auto	getMoveRadius () const
	Retrieves the movement radius of the units.
auto	getFieldParams () const
	Retrieves the shared field parameters.
auto	getUnitsCount () const
	Retrieves the total number of units.
virtual Point	generatePos (std::optional< Point > initialPoint)
	Generates a position for a unit, optionally starting from an initial point.
virtual	~UnitsParams ()=default
	Virtual destructor for UnitsParams.
	UnitsParams (const UnitsParams &)=delete
void	operator= (const UnitsParams &)=delete
	UnitsParams (UnitsParams &&)=delete
void	operator= (UnitsParams &&)=delete

Detailed Description

Configuration parameters shared among multiple units.

Constructor & Destructor Documentation

UnitsParams() [1/3]

UnitsParams::UnitsParams	(	double	moveRadius,
		const std::shared_ptr< FieldParams > &	fieldParams,
		uint32_t	unitsCount
	)

Constructs the UnitsParams object.

Parameters

moveRadius	The movement radius for units.
fieldParams	Shared pointer to field parameters.
unitsCount	The number of units in the simulation.

~UnitsParams()

virtual UnitsParams::~UnitsParams ( )

virtualdefault

Virtual destructor for UnitsParams.

UnitsParams() [2/3]

UnitsParams::UnitsParams ( const UnitsParams &  )

delete

UnitsParams() [3/3]

UnitsParams::UnitsParams ( UnitsParams &&  )

delete

Member Function Documentation

generatePos()

Point UnitsParams::generatePos ( std::optional< Point >  initialPoint )

virtual

Generates a position for a unit, optionally starting from an initial point.

Parameters

initialPoint

An optional initial point.

Returns

The generated position.

getFieldParams()

auto UnitsParams::getFieldParams ( ) const

inline

Retrieves the shared field parameters.

Returns

A shared pointer to the field parameters.

getMoveRadius()

auto UnitsParams::getMoveRadius ( ) const

inline

Retrieves the movement radius of the units.

Returns

The movement radius.

getUnitsCount()

auto UnitsParams::getUnitsCount ( ) const

inline

Retrieves the total number of units.

Returns

The number of units.

operator=() [1/2]

void UnitsParams::operator= ( const UnitsParams &  )

delete

operator=() [2/2]

void UnitsParams::operator= ( UnitsParams &&  )

delete

---

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

• model/creeper-simulation-library/units/Unit.hpp
• model/creeper-simulation-library/units/Unit.cpp