Public Member Functions | List of all members
rokubimini::BaseManager Class Referenceabstract

The Base Manager class. More...

#include <Manager.hpp>

Inheritance diagram for rokubimini::BaseManager:
Inheritance graph
[legend]

Public Member Functions

 BaseManager ()
 Default constructor. More...
 
virtual bool loadSetup ()=0
 Loads the Setup. More...
 
virtual void shutdown ()=0
 Shuts down the communication with the devices. More...
 
virtual bool startup ()=0
 Starts up the communication with the devices. More...
 
virtual bool update ()=0
 Updates (Readings) the communication with the devices. More...
 
virtual ~BaseManager ()=default
 

Detailed Description

The Base Manager class.

Base abstract class. It provides the basic API needed for a Manager which loads a configuration file and starts/updates/shuts down the communication with the devices.

Definition at line 28 of file Manager.hpp.

Constructor & Destructor Documentation

rokubimini::BaseManager::BaseManager ( )
inline

Default constructor.

This method constructs a BaseManager.

Definition at line 39 of file Manager.hpp.

virtual rokubimini::BaseManager::~BaseManager ( )
virtualdefault

Member Function Documentation

bool rokubimini::BaseManager::loadSetup ( )
pure virtual

Loads the Setup.

This pure virtual method is used as a reference for future implementations.

Parameters
setupFileThe file to load the Setup from.

Implemented in rokubimini::RokubiminiManager.

bool rokubimini::BaseManager::shutdown ( )
pure virtual

Shuts down the communication with the devices.

This pure virtual method is used as a reference for future implementations.

Implemented in rokubimini::RokubiminiManager.

bool rokubimini::BaseManager::startup ( )
pure virtual

Starts up the communication with the devices.

This pure virtual method is used as a reference for future implementations.

Implemented in rokubimini::RokubiminiManager.

bool rokubimini::BaseManager::update ( )
pure virtual

Updates (Readings) the communication with the devices.

This pure virtual method is used as a reference for future implementations.

Implemented in rokubimini::RokubiminiManager.


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


rokubimini_manager
Author(s):
autogenerated on Wed Mar 3 2021 03:09:21