InOutFramework Class Template Reference
[Framework for Applications]

#include <InOutFramework.hpp>

Inheritance diagram for InOutFramework:

[legend]Collaboration diagram for InOutFramework:

[legend]List of all members.

---

Detailed Description

template<class IType, class OType>
class gpstk::InOutFramework< IType, OType >

This is a framework for programs that take a single type of input data and output a single stream of output.

The end user should define subclasses of this class, implementing those methods described as being meant to be overridden.

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 71 of file InOutFramework.hpp.

Public Member Functions
	InOutFramework (const std::string &applName, const std::string &applDesc) throw ()
	Constructor for InOutFramework.
virtual	~InOutFramework ()
	Destructor.
bool	initialize (int argc, char *argv[], bool pretty=true) throw ()
	Process command line arguments.
Public Attributes
IType	input
OType	output
std::string	inputFn
std::string	outputFn

---

Constructor & Destructor Documentation

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

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

virtual ~InOutFramework (   )  [inline, virtual]

Destructor. Definition at line 90 of file InOutFramework.hpp.

---

Member Function Documentation

bool initialize (  int  argc, char *  argv[], bool  pretty = true )  throw () [inline, virtual]

Process command line arguments. When this method is overridden, make sure to call the parent class's initialize(). Parameters: argc  same as main() argc. argv  same as main() argv. pretty  Whether the 'pretty print' option will be used when printing descriptions. It is 'TRUE' by default. Returns: true if normal processing should proceed (i.e. no command line errors or help requests). Reimplemented from BasicFramework. Definition at line 93 of file InOutFramework.hpp. References CommandOption::getCount(), and CommandOption::getValue().

---

Member Data Documentation

IType input

Definition at line 161 of file InOutFramework.hpp.

std::string inputFn

Definition at line 165 of file InOutFramework.hpp.

OType output

Definition at line 163 of file InOutFramework.hpp.

std::string outputFn

Definition at line 165 of file InOutFramework.hpp.

---

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

• InOutFramework.hpp

---