Residential Class Reference

Abstract class representing a residential building. More...

#include <Buildings.h>

Inheritance diagram for Residential:

Public Member Functions
	Residential (std::string name, int numRooms, int m_squared, float value, int numBedrooms, int numBathrooms, int capacity, std::string type)
	Constructor for a Residential building.
virtual void	build ()=0
	Pure virtual function to build the residential building.
virtual Residential *	clone ()=0
	Pure virtual function to clone the residential building.
void	addCitizen (Citizen *human) override
	Adds a citizen to the residential building.
void	displayCitizens () override
	Displays the list of citizens in the residential building.
int	getLeftOverCapacity () override
	Gets the remaining capacity of the residential building.
int	getCapacity ()
	Gets the maximum capacity of the residential building.
std::vector< Citizen * >	getCitizens ()
	Gets the list of citizens in the residential building.
virtual std::string	getType () const =0
	Pure virtual function to get the type of the residential building.
Public Member Functions inherited from Building
	Building (std::string name, int numRooms, int m_squared, float value, std::string type)
	Constructor to initialize a Building object.
virtual	~Building ()
	Virtual destructor for the Building class.
std::vector< Citizen * >	getCitizens () const
	Gets the list of citizens in the building.
std::string	getName ()
	Gets the name of the building.
std::string	getBuildingType ()
	Gets the building's type description.
bool	getBuilt () const
	Checks if the building is built.
void	renovate ()
	Renovates the building, updating any necessary properties.

Protected Attributes
int	numBedrooms
	Number of bedrooms in the residential building.
int	numBathrooms
	Number of bathrooms in the residential building.
int	capacity
	Maximum occupancy capacity of the building.
Protected Attributes inherited from Building
std::string	name
	Name of the building.
std::string	type
	Type of the building (e.g., Residential, Commercial)
int	numRooms
	Number of rooms in the building.
int	m_squared
	Area of the building in square meters.
float	value
	Value of the building.
bool	built = false
	Flag indicating if the building is built.
Budget *	budget
	Pointer to a Budget object for managing building finances.
Concrete *	concrete
	Pointer to a Concrete object for building materials.
Steel *	steel
	Pointer to a Steel object for building materials.
Wood *	wood
	Pointer to a Wood object for building materials.
std::vector< Citizen * >	citizens
	List of citizens associated with the building.

Detailed Description

Abstract class representing a residential building.

The Residential class is derived from the Building class and serves as a base class for different types of residential buildings. It includes attributes specific to residential buildings, such as bedrooms, bathrooms, and capacity.

Constructor & Destructor Documentation

Residential()

Residential::Residential	(	std::string	name,
		int	numRooms,
		int	m_squared,
		float	value,
		int	numBedrooms,
		int	numBathrooms,
		int	capacity,
		std::string	type )

Constructor for a Residential building.

Parameters

name	Name of the building.
numRooms	Number of rooms in the building.
m_squared	Area of the building in square meters.
value	Value of the building.
numBedrooms	Number of bedrooms.
numBathrooms	Number of bathrooms.
capacity	Maximum capacity of the building.
type	Type of the building.

Member Function Documentation

addCitizen()

void Residential::addCitizen ( Citizen * human )

overridevirtual

Adds a citizen to the residential building.

Parameters

human

Pointer to the Citizen to be added.

Implements Building.

build()

virtual void Residential::build ( )

pure virtual

Pure virtual function to build the residential building.

Implements Building.

Implemented in Apartment, House, and Mansion.

clone()

virtual Residential * Residential::clone ( )

pure virtual

Pure virtual function to clone the residential building.

Returns

A pointer to a new Residential object that is a clone of the current instance.

Implements Building.

Implemented in Apartment, House, and Mansion.

displayCitizens()

void Residential::displayCitizens ( )

overridevirtual

Displays the list of citizens in the residential building.

Reimplemented from Building.

getCapacity()

int Residential::getCapacity

(

)

Gets the maximum capacity of the residential building.

Returns

The capacity of the building.

getCitizens()

std::vector< Citizen * > Residential::getCitizens

(

)

Gets the list of citizens in the residential building.

Returns

A vector of Citizen pointers.

getLeftOverCapacity()

int Residential::getLeftOverCapacity ( )

overridevirtual

Gets the remaining capacity of the residential building.

Returns

The number of additional citizens the building can accommodate.

Implements Building.

getType()

virtual std::string Residential::getType ( ) const

pure virtual

Pure virtual function to get the type of the residential building.

Returns

The type of the building as a string.

Implements Building.

Implemented in Apartment, House, and Mansion.