GM6000 Digital Heater Controller Build: 16 (Branch = develop)
SDX-1330
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
Cpl::MApp::MApp_ Class Reference

This partial concrete class provide common infrastructure that is common to all MApp instances. More...

Detailed Description

This partial concrete class provide common infrastructure that is common to all MApp instances.

#include <MApp_.h>

Inheritance diagram for Cpl::MApp::MApp_:
[legend]
Collaboration diagram for Cpl::MApp::MApp_:
[legend]

Public Member Functions

const char * getName () const noexcept
 See Cpl::MApp::Api.
 
const char * getDescription () const noexcept
 See Cpl::MApp::Api.
 
const char * getUsage () const noexcept
 See Cpl::MApp::Api.
 
- Public Member Functions inherited from Cpl::MApp::MAppApi
virtual void intialize_ () noexcept=0
 This method has PACKAGE Scope, i.e.
 
virtual void shutdown_ () noexcept=0
 This method has PACKAGE Scope, i.e.
 
virtual bool start_ (char *optionalArgs) noexcept=0
 This method has PACKAGE Scope, i.e.
 
virtual void stop_ () noexcept=0
 This method has PACKAGE Scope, i.e.
 
virtual ~MAppApi ()
 Virtual destructor.
 
- Public Member Functions inherited from Cpl::Container::Item
bool insert_ (void *newContainerPtr)
 Helper method to trap when inserting an item in multiple containers.
 
bool isInContainer_ (const void *containerPtr) const noexcept
 Returns 'true' if the instance is in the specified container.
 

Protected Member Functions

 MApp_ (Cpl::Container::SList< MAppApi > &mappList, const char *mappName, const char *description, const char *usage)
 Constructor.
 
- Protected Member Functions inherited from Cpl::Container::Item
 Item ()
 Constructor.
 
 Item (const char *)
 Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
 

Protected Attributes

const char * m_name
 Command name.
 
const char * m_description
 Description.
 
const char * m_usage
 Usage.
 
bool m_started
 Started state.
 

Additional Inherited Members

- Static Public Member Functions inherited from Cpl::Container::Item
static void remove_ (Item *itemPtr) noexcept
 Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
 
- Public Attributes inherited from Cpl::Container::Item
voidm_nextPtr_
 The link field.
 
voidm_inListPtr_
 Debug field.
 

Constructor & Destructor Documentation

◆ MApp_()

Cpl::MApp::MApp_::MApp_ ( Cpl::Container::SList< MAppApi > & mappList,
const char * mappName,
const char * description,
const char * usage )
protected

Constructor.

Member Function Documentation

◆ getDescription()

const char * Cpl::MApp::MApp_::getDescription ( ) const
virtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

◆ getName()

const char * Cpl::MApp::MApp_::getName ( ) const
virtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

◆ getUsage()

const char * Cpl::MApp::MApp_::getUsage ( ) const
virtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

Member Data Documentation

◆ m_description

const char* Cpl::MApp::MApp_::m_description
protected

Description.

◆ m_name

const char* Cpl::MApp::MApp_::m_name
protected

Command name.

◆ m_started

bool Cpl::MApp::MApp_::m_started
protected

Started state.

◆ m_usage

const char* Cpl::MApp::MApp_::m_usage
protected

Usage.


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