Eros::Test::Cycle::Api Class Reference

This concrete class implements MApp the duty cycles the heating equipment based on command arguments. More...

Detailed Description

This concrete class implements MApp the duty cycles the heating equipment based on command arguments.

#include <Api.h>

Inheritance diagram for Eros::Test::Cycle::Api:

Collaboration diagram for Eros::Test::Cycle::Api:

Public Member Functions
	Api (Cpl::Container::SList< MAppApi > &mappList, Cpl::Dm::MailboxServer &myMbox, Driver::DIO::Pwm &heaterPWMDriver, Driver::DIO::Pwm &fanPWMDriver)
	Constructor.
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.

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::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 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 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 Attributes
Driver::DIO::Pwm &	m_heaterDriver
	Driver.
Driver::DIO::Pwm &	m_fanDriver
	Driver.
unsigned	m_heaterPWM
	Heater PWM.
unsigned	m_fanPWM
	Fan PWM.
uint32_t	m_onTimeMs
	On time (in milliseconds)
uint32_t	m_offTimeMs
	Off time (in milliseconds)
unsigned	m_maxCycles
	Max Repeat count.
unsigned	m_cycleCount
	Repeat count.
uint32_t	m_timeMarkerMs
	Time marker for the duty cycle.
bool	m_inOnCycle
	Duty Cycle state.
bool	m_firstCycle
	Flag for initial cycle.
Protected Attributes inherited from Cpl::MApp::MApp_
const char *	m_name
	Command name.
const char *	m_description
	Description.
const char *	m_usage
	Usage.
bool	m_started
	Started state.
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::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Constructor & Destructor Documentation

Api()

Eros::Test::Cycle::Api::Api	(	Cpl::Container::SList< MAppApi > &	mappList,
		Cpl::Dm::MailboxServer &	myMbox,
		Driver::DIO::Pwm &	heaterPWMDriver,
		Driver::DIO::Pwm &	fanPWMDriver )

Constructor.

Member Function Documentation

expired()

void Eros::Test::Cycle::Api::expired ( void )

protectedvirtualnoexcept

Timer expired callback.

Implements Cpl::System::CounterCallback_.

intialize_()

void Eros::Test::Cycle::Api::intialize_ ( )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

parse()

bool Eros::Test::Cycle::Api::parse ( char * args )

protectednoexcept

Helper method to parse the 'command line' options.

shutdown_()

void Eros::Test::Cycle::Api::shutdown_ ( )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

start_()

bool Eros::Test::Cycle::Api::start_ ( char * args )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

stop_()

void Eros::Test::Cycle::Api::stop_ ( )

protectedvirtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

Member Data Documentation

m_cycleCount

unsigned Eros::Test::Cycle::Api::m_cycleCount

protected

Repeat count.

m_fanDriver

Driver::DIO::Pwm& Eros::Test::Cycle::Api::m_fanDriver

protected

Driver.

m_fanPWM

unsigned Eros::Test::Cycle::Api::m_fanPWM

protected

Fan PWM.

m_firstCycle

bool Eros::Test::Cycle::Api::m_firstCycle

protected

Flag for initial cycle.

m_heaterDriver

Driver::DIO::Pwm& Eros::Test::Cycle::Api::m_heaterDriver

protected

Driver.

m_heaterPWM

unsigned Eros::Test::Cycle::Api::m_heaterPWM

protected

Heater PWM.

m_inOnCycle

bool Eros::Test::Cycle::Api::m_inOnCycle

protected

Duty Cycle state.

m_maxCycles

unsigned Eros::Test::Cycle::Api::m_maxCycles

protected

Max Repeat count.

m_offTimeMs

uint32_t Eros::Test::Cycle::Api::m_offTimeMs

protected

Off time (in milliseconds)

m_onTimeMs

uint32_t Eros::Test::Cycle::Api::m_onTimeMs

protected

On time (in milliseconds)

m_timeMarkerMs

uint32_t Eros::Test::Cycle::Api::m_timeMarkerMs

protected

Time marker for the duty cycle.

---

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

• Eros/Test/Cycle/Api.h