Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openfluid::buddies::OpenFLUIDBuddy Class Referenceabstract

#include <buddies/OpenFLUIDBuddy.hpp>

Inheritance diagram for openfluid::buddies::OpenFLUIDBuddy:
Inheritance graph
[legend]
Collaboration diagram for openfluid::buddies::OpenFLUIDBuddy:
Collaboration graph
[legend]

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::BuddiesListenermp_Listener
 

Constructor & Destructor Documentation

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

Member Function Documentation

std::string openfluid::buddies::OpenFLUIDBuddy::getYesNoFromOneZero ( std::string  VStr)
protected
void openfluid::buddies::OpenFLUIDBuddy::invokeHelp ( )
bool openfluid::buddies::OpenFLUIDBuddy::parseOptions ( std::string  OptsStr)
virtual bool openfluid::buddies::OpenFLUIDBuddy::run ( )
pure virtual
void openfluid::buddies::OpenFLUIDBuddy::setOptionIfNotSet ( std::string  OptionName,
std::string  OptionValue 
)
protected
void openfluid::buddies::OpenFLUIDBuddy::streamOptions ( std::ostream &  OStream)

Member Data Documentation

std::map<std::string,std::string> openfluid::buddies::OpenFLUIDBuddy::m_Options
protected
std::map<std::string,std::string> openfluid::buddies::OpenFLUIDBuddy::m_OtherOptionsHelp
protected
std::map<std::string,std::string> openfluid::buddies::OpenFLUIDBuddy::m_RequiredOptionsHelp
protected
openfluid::buddies::BuddiesListener* openfluid::buddies::OpenFLUIDBuddy::mp_Listener
protected

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