DisplayModule Class Reference

A class that implements the IDisplayModule interface. More...

#include <DisplayModule.hpp>

Inheritance diagram for DisplayModule:

Collaboration diagram for DisplayModule:

Public Member Functions
	DisplayModule (IDisplayModule *)
	Constructor for the DisplayModule class. More...
	~DisplayModule () override
	Destructor for the DisplayModule class.
void	init () override
	Initializes the display module. More...
void	stop () override
	Stops the currently loaded display module. More...
const std::string &	getName () const override
	Retrieves the name of the display module. More...
Public Member Functions inherited from IDisplayModule
virtual	~IDisplayModule ()=default
	Virtual destructor. More...
virtual void	init ()=0
	Initialize the display module. More...
virtual void	stop ()=0
	Stop the display module. More...
virtual const std::string &	getName () const =0
	Retrieves the name of the display module. More...

Private Attributes
std::unique_ptr< IDisplayModule >	_object

Detailed Description

A class that implements the IDisplayModule interface.

The DisplayModule class is responsible for initializing and stopping the display module. It interacts with a library loader to manage dynamic libraries.

Constructor & Destructor Documentation

DisplayModule()

DisplayModule::DisplayModule

(

IDisplayModule *

mdl

)

Constructor for the DisplayModule class.

Parameters

displayModule

A pointer to an object implementing the IDisplayModule interface. This parameter is used to initialize the DisplayModule instance.

Member Function Documentation

getName()

const std::string & DisplayModule::getName ( ) const

overridevirtual

Retrieves the name of the display module.

This function returns a constant reference to a string representing the name of the display module. It overrides a base class method.

Returns

A constant reference to the name of the display module.

Implements IDisplayModule.

init()

void DisplayModule::init ( )

overridevirtual

Initializes the display module.

This function is responsible for setting up the display module, ensuring that all necessary resources and configurations are properly initialized before use.

Implements IDisplayModule.

stop()

void DisplayModule::stop ( )

overridevirtual

Stops the currently loaded display module.

This function is responsible for calling the stop function of the currently loaded display module, ensuring that any necessary cleanup or termination processes are executed properly.

Implements IDisplayModule.

Member Data Documentation

_object

std::unique_ptr<IDisplayModule> DisplayModule::_object

private

Reference to the library loader.

---

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

• src/DisplayModule.hpp
• src/DisplayModule.cpp