This concrete class implements MApp the polls a model point for a temperature value and periodically writes the value to the trace output. More...

Detailed Description

This concrete class implements MApp the polls a model point for a temperature value and periodically writes the value to the trace output.

The MApp also collects some metrics and has the option to display temperature in degrees Fahrenheit or Celsius.

NOTE: Multiple of instance of the class can be created - as long as each instance has a unique 'name'.

The class is intended to be example/template for an MApp - not that it does anything particular noteworthy.

#include <Api.h>

Inheritance diagram for Cpl::MApp::Temperature::Api:

[legend]

Collaboration diagram for Cpl::MApp::Temperature::Api:

[legend]

Public Member Functions
	Api (Cpl::Container::Map< MAppApi > &mappList, Cpl::Dm::MailboxServer &myMbox, Cpl::Dm::Mp::Float &srcTemperatureMp, const char *name=DEFAULT_NAME)
	Constructor. Note: The myMbox argument is only needed because the class uses a SW timer.

Public Member Functions inherited from Cpl::MApp::MApp_
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	~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.

Public Member Functions inherited from Cpl::System::Timer
	Timer (TimerManager &timingSource)
	Constructor

	Timer ()
	Constructor. Alternate constructor - that defers the assignment of the timing source

virtual void	start (unsigned long timerDurationInMilliseconds) noexcept
	Starts the timer with an initial count down count duration of 'timerDurationInMilliseconds'.

virtual void	stop () noexcept
	Stops the timer.

unsigned long	count () const noexcept
	Returns the current count (in milliseconds)

virtual void	setTimingSource (TimerManager &timingSource) noexcept
	Sets the timing source.

Public Member Functions inherited from Cpl::System::CounterCallback_
virtual	~CounterCallback_ ()
	Virtual Destructor.

Static Public Attributes
static constexpr const char *	DEFAULT_NAME = "temperature"
	The default MApp Name.

static constexpr const char *	USAGE
	Usage string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

static constexpr const char *	DESCRIPTION = "Periodically Samples temperature and displays sample/metric values."
	Description string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

Protected Member Functions
void	intialize_ () noexcept
	See Cpl::MApp::Api.

bool	start_ (char *args) noexcept
	See Cpl::MApp::Api.

void	stop_ () noexcept
	See Cpl::MApp::Api.

void	shutdown_ () noexcept
	See Cpl::MApp::Api.

bool	parse (char *args) noexcept
	Helper method to parse the 'command line' options.

void	expired (void) noexcept
	Timer expired callback.

Protected Member Functions inherited from Cpl::MApp::MApp_
	MApp_ (Cpl::Container::Map< MAppApi > &mappList, const char mappName, const char description, const char *usage)
	Constructor.

const Cpl::Container::Key &	getKey () const noexcept
	See Cpl::Container::Key.

Protected Member Functions inherited from Cpl::Container::MapItem
	MapItem ()
	Constructor.

	MapItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor -->special constructor to allow a Map to be statically allocated.

void	initialize (MapItem *parent)
	Initialize the node when being inserted in the tree.

MapItem *	getParent () const
	Get tree connection/pointer.

void	setParent (MapItem *n)
	Set tree connection/pointer.

MapItem *	getLeft () const
	Get tree connection/pointer.

void	setLeft (MapItem *n)
	Set tree connection/pointer.

MapItem *	getRight () const
	Get tree connection/pointer.

void	setRight (MapItem *n)
	Set tree connection/pointer.

Protected Member Functions inherited from Cpl::Container::DictItem
	DictItem ()
	Constructor.

	DictItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.

	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

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 Member Functions inherited from Cpl::System::Timer
void	decrement (unsigned long milliseconds=1) noexcept
	See Cpl::System::CounterCallback_.

void	increment (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.

Protected Attributes
Cpl::Dm::Mp::Float &	m_temperature
	Temperature Input. Assumed units is Celsius.

float	m_maxTemp
	Maximum Temp. sampled.

float	m_minTemp
	Minimum Temp. sampled.

float	m_sumTemp
	Cumulative sum Temp.

uint32_t	m_numSamples
	Number of samples.

uint32_t	m_sampleMs
	Sample time in msecs.

uint32_t	m_displayMs
	Display time in msecs.

uint32_t	m_timeMarkerMs
	Time marker of last display action.

bool	m_fahrenheit
	When true the values are displayed in Fahrenheit.

bool	m_invalidData
	Flag that tracks when I have invalid data.

Protected Attributes inherited from Cpl::MApp::MApp_
Cpl::Container::KeyLiteralString	m_name
	Command name.

const char *	m_description
	Description.

const char *	m_usage
	Usage.

bool	m_started
	Started state.

Protected Attributes inherited from Cpl::Container::MapItem
void *	m_parentPtr_
	Link field to the parent node.

bool	m_is_NOT_root_
	I am the root node.

Balance_T	m_balance_
	Balance status.

Protected Attributes inherited from Cpl::Container::DictItem
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Protected Attributes inherited from Cpl::System::Timer
TimerManager *	m_timingSource
	The timer's tick source.

unsigned long	m_count
	Current count.

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::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Types inherited from Cpl::Container::MapItem
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...

Constructor & Destructor Documentation

◆ Api()

Cpl::MApp::Temperature::Api::Api	(	Cpl::Container::Map< MAppApi > &	mappList,
		Cpl::Dm::MailboxServer &	myMbox,
		Cpl::Dm::Mp::Float &	srcTemperatureMp,
		const char *	name = `DEFAULT_NAME`
	)

Constructor. Note: The myMbox argument is only needed because the class uses a SW timer.

Member Function Documentation

◆ expired()

void Cpl::MApp::Temperature::Api::expired ( void )

protectedvirtualnoexcept

Timer expired callback.

Implements Cpl::System::CounterCallback_.

◆ intialize_()

void Cpl::MApp::Temperature::Api::intialize_ ( )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

◆ parse()

bool Cpl::MApp::Temperature::Api::parse ( char * args )

protectednoexcept

Helper method to parse the 'command line' options.

◆ shutdown_()

void Cpl::MApp::Temperature::Api::shutdown_ ( )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

◆ start_()

bool Cpl::MApp::Temperature::Api::start_ ( char * args )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

◆ stop_()

void Cpl::MApp::Temperature::Api::stop_ ( )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

Member Data Documentation

◆ DEFAULT_NAME

constexpr const char* Cpl::MApp::Temperature::Api::DEFAULT_NAME = "temperature"

staticconstexpr

The default MApp Name.

◆ DESCRIPTION

constexpr const char* Cpl::MApp::Temperature::Api::DESCRIPTION = "Periodically Samples temperature and displays sample/metric values."

staticconstexpr

Description string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

◆ m_displayMs

uint32_t Cpl::MApp::Temperature::Api::m_displayMs

protected

Display time in msecs.

◆ m_fahrenheit

bool Cpl::MApp::Temperature::Api::m_fahrenheit

protected

When true the values are displayed in Fahrenheit.

◆ m_invalidData

bool Cpl::MApp::Temperature::Api::m_invalidData

protected

Flag that tracks when I have invalid data.

◆ m_maxTemp

float Cpl::MApp::Temperature::Api::m_maxTemp

protected

Maximum Temp. sampled.

◆ m_minTemp

float Cpl::MApp::Temperature::Api::m_minTemp

protected

Minimum Temp. sampled.

◆ m_numSamples

uint32_t Cpl::MApp::Temperature::Api::m_numSamples

protected

Number of samples.

◆ m_sampleMs

uint32_t Cpl::MApp::Temperature::Api::m_sampleMs

protected

Sample time in msecs.

◆ m_sumTemp

float Cpl::MApp::Temperature::Api::m_sumTemp

protected

Cumulative sum Temp.

◆ m_temperature

Cpl::Dm::Mp::Float& Cpl::MApp::Temperature::Api::m_temperature

protected

Temperature Input. Assumed units is Celsius.

◆ m_timeMarkerMs

uint32_t Cpl::MApp::Temperature::Api::m_timeMarkerMs

protected

Time marker of last display action.

◆ USAGE

constexpr const char* Cpl::MApp::Temperature::Api::USAGE

staticconstexpr

Initial value:

= "args: [<samplems> [<displayms> [F|C]]]\n"
                                               "  <samplems>   milliseconds between samples. Default is  100ms\n"
                                               "  <displayms>  milliseconds between outputs. Default is 5000ms\n"
                                               "  F|C          'F' use Fahrenheit, 'C' use Celsius. Default is 'F'"

Usage string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

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

Cpl/MApp/Temperature/Api.h

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ expired()

◆ intialize_()

◆ parse()

◆ shutdown_()

◆ start_()

◆ stop_()

Member Data Documentation

◆ DEFAULT_NAME

◆ DESCRIPTION

◆ m_displayMs

◆ m_fahrenheit

◆ m_invalidData

◆ m_maxTemp

◆ m_minTemp

◆ m_numSamples

◆ m_sampleMs

◆ m_sumTemp

◆ m_temperature

◆ m_timeMarkerMs

◆ USAGE