LoopedFramework Class Reference
[Framework for Applications]

#include <LoopedFramework.hpp>

Inheritance diagram for LoopedFramework:

[legend]Collaboration diagram for LoopedFramework:

[legend]List of all members.

---

Detailed Description

This is a basic framework for programs processing in loops in the GPSTK.

The end user should define subclasses of this class, implementing those methods described as being meant to be overridden; initialize(), additionalSetup(), spinUp(), process(), and shutDown(). In the process() method, simply set variable timeToDie true prior to returning for the program to call shutDown() and then terminate.

In use, the user will construct an object of the class derived from this, then call the initialize() and run() methods in that order.

Definition at line 69 of file LoopedFramework.hpp.

Public Member Functions
	LoopedFramework (const std::string &applName, const std::string &applDesc) throw ()
	Constructor for LoopedFramework.
virtual	~LoopedFramework ()
	Destructor.
Protected Member Functions
virtual void	completeProcessing ()
	Called by the run() method, calls additionalSetup(), spinUp(), and process(), in that order.
Protected Attributes
bool	timeToDie
	if set to true, the loop will terminate

---

Constructor & Destructor Documentation

LoopedFramework (  const std::string &  applName, const std::string &  applDesc )  throw () [inline]

Constructor for LoopedFramework. Parameters: applName  name of the program (argv[0]). applDesc  text description of program's function (used by CommandOption help). Definition at line 78 of file LoopedFramework.hpp.

virtual ~LoopedFramework (   )  [inline, virtual]

Destructor. Definition at line 85 of file LoopedFramework.hpp.

---

Member Function Documentation

void completeProcessing (   )  [protected, virtual]

Called by the run() method, calls additionalSetup(), spinUp(), and process(), in that order. Generally should not be overridden. Reimplemented from BasicFramework. Definition at line 50 of file LoopedFramework.cpp. References BasicFramework::additionalSetup(), BasicFramework::process(), and BasicFramework::spinUp().

---

Member Data Documentation

bool timeToDie [protected]

if set to true, the loop will terminate Definition at line 88 of file LoopedFramework.hpp.

---

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

• LoopedFramework.hpp
• LoopedFramework.cpp

---