openfluid::buddies::OpenFLUIDBuddy Class Reference

#include <buddies/OpenFLUIDBuddy.hpp>

Inheritance diagram for openfluid::buddies::OpenFLUIDBuddy:

Collaboration diagram for openfluid::buddies::OpenFLUIDBuddy:

Public Member Functions
	OpenFLUIDBuddy (openfluid::buddies::BuddiesListener *Listener)
virtual	~OpenFLUIDBuddy ()
bool	parseOptions (std::string OptsStr)
void	streamOptions (std::ostream &OStream)
virtual bool	run ()=0
void	invokeHelp ()

Protected Member Functions
void	setOptionIfNotSet (std::string OptionName, std::string OptionValue)
std::string	getYesNoFromOneZero (std::string VStr)

Protected Attributes
std::map< std::string, std::string >	m_Options
std::map< std::string, std::string >	m_RequiredOptionsHelp
std::map< std::string, std::string >	m_OtherOptionsHelp
openfluid::buddies::BuddiesListener *	mp_Listener

Constructor & Destructor Documentation

OpenFLUIDBuddy()

openfluid::buddies::OpenFLUIDBuddy::OpenFLUIDBuddy

(

openfluid::buddies::BuddiesListener *

Listener

)

~OpenFLUIDBuddy()

virtual openfluid::buddies::OpenFLUIDBuddy::~OpenFLUIDBuddy ( )

virtual

Member Function Documentation

getYesNoFromOneZero()

std::string openfluid::buddies::OpenFLUIDBuddy::getYesNoFromOneZero ( std::string  VStr )

protected

invokeHelp()

void openfluid::buddies::OpenFLUIDBuddy::invokeHelp

(

)

parseOptions()

bool openfluid::buddies::OpenFLUIDBuddy::parseOptions

(

std::string

OptsStr

)

run()

virtual bool openfluid::buddies::OpenFLUIDBuddy::run ( )

pure virtual

Implemented in openfluid::buddies::Sim2DocBuddy, openfluid::buddies::NewDataBuddy, openfluid::buddies::NewSimulatorBuddy, and openfluid::buddies::ExamplesBuddy.

setOptionIfNotSet()

void openfluid::buddies::OpenFLUIDBuddy::setOptionIfNotSet ( std::string  OptionName, std::string  OptionValue  )

protected

streamOptions()

void openfluid::buddies::OpenFLUIDBuddy::streamOptions

(

std::ostream &

OStream

)

Member Data Documentation

m_Options

std::map<std::string,std::string> openfluid::buddies::OpenFLUIDBuddy::m_Options

protected

m_OtherOptionsHelp

std::map<std::string,std::string> openfluid::buddies::OpenFLUIDBuddy::m_OtherOptionsHelp

protected

m_RequiredOptionsHelp

std::map<std::string,std::string> openfluid::buddies::OpenFLUIDBuddy::m_RequiredOptionsHelp

protected

mp_Listener

openfluid::buddies::BuddiesListener* openfluid::buddies::OpenFLUIDBuddy::mp_Listener

protected

---

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

• buddies/OpenFLUIDBuddy.hpp