On this page
article
peary::hal::Board
peary::hal::Board
Base class for a hardware board. More…
#include <peary/hal/Board.hpp>
Public Functions
| Name | |
|---|---|
| Board() =defaultDefault constructor. | |
| virtual | ~Board() =defaultDefault destructor. |
| template <typename T > std::shared_ptr< T > | getResource(R res)Get a resource by name. |
Protected Functions
| Name | |
|---|---|
| template <typename T ,typename… Args> void | register_resource(R res, Args &&… args)Register a resource with the board. |
Protected Attributes
| Name | |
|---|---|
| utils::enum_hash_map< R, std::shared_ptr< Resource > > | _resources |
Detailed Description
template <typename R >
class peary::hal::Board;
Base class for a hardware board.
Public Functions Documentation
function Board
Board() =default
Default constructor.
function ~Board
virtual ~Board() =default
Default destructor.
function getResource
template <typename T >
inline std::shared_ptr< T > getResource(
R res
)
Get a resource by name.
Parameters:
- res Resource to be retrieved
Template Parameters:
- T Type of the resource to be retrieved
Return: Shared pointer to the requested resource
Protected Functions Documentation
function register_resource
template <typename T ,
typename... Args>
inline void register_resource(
R res,
Args &&... args
)
Register a resource with the board.
Parameters:
- res Resource to be registered
- args Arguments to be passed to the resource constructor
Protected Attributes Documentation
variable _resources
utils::enum_hash_map< R, std::shared_ptr< Resource > > _resources;
Updated on 2026-01-30 at 22:01:05 +0100