GM6000 Digital Heater Controller Build: 16 (Branch = develop)
SDX-1330
MApp_.h
Go to the documentation of this file.
1#ifndef Cpl_MApp_MApp_h_
2#define Cpl_MApp_MApp_h_
3/*-----------------------------------------------------------------------------
4* COPYRIGHT_HEADER_TO_BE_FILLED_LATER
5*----------------------------------------------------------------------------*/
6/** @file */
7
8
9#include "Cpl/MApp/MAppApi.h"
10#include "Cpl/Container/SList.h"
11
12/*----------------------------------------------------------------------------*/
13///
14namespace Cpl {
15///
16namespace MApp {
17
18
19/** This partial concrete class provide common infrastructure that is common
20 to all MApp instances.
21 */
22class MApp_ : public MAppApi
23{
24protected:
25 /// Constructor.
27 const char* mappName,
28 const char* description,
29 const char* usage );
30
31public:
32 /// See Cpl::MApp::Api
33 const char* getName() const noexcept;
34
35 /// See Cpl::MApp::Api
36 const char* getDescription() const noexcept;
37
38 /// See Cpl::MApp::Api
39 const char* getUsage() const noexcept;
40
41protected:
42 /// Command name
43 const char* m_name;
44
45 /// Description
46 const char* m_description;
47
48 /// Usage
49 const char* m_usage;
50
51 /// Started state
53};
54
55}; // end namespaces
56};
57#endif // end header latch
This template class implements a THREAD SAFE Ring Buffer.
Definition RingBufferMT.h:33
This partial concrete class provide common infrastructure that is common to all MApp instances.
Definition MApp_.h:23
MApp_(Cpl::Container::SList< MAppApi > &mappList, const char *mappName, const char *description, const char *usage)
Constructor.
const char * getUsage() const noexcept
See Cpl::MApp::Api.
const char * m_usage
Usage.
Definition MApp_.h:49
const char * getName() const noexcept
See Cpl::MApp::Api.
const char * m_description
Description.
Definition MApp_.h:46
bool m_started
Started state.
Definition MApp_.h:52
const char * m_name
Command name.
Definition MApp_.h:43
const char * getDescription() const noexcept
See Cpl::MApp::Api.
This abstract class defines the interface for a Micro Application (MApp).
Definition MAppApi.h:37
The 'Cpl' namespace is the root name space for the Colony.
Definition Api16.h:20