XtpMap Class Reference

Inheritance diagram for XtpMap:

Collaboration diagram for XtpMap:

Public Member Functions
string	ProgramName () override
	program name
void	HelpText (ostream &out) override
	help text of application without version information
void	ShowHelpText (std::ostream &out) override
void	Initialize () override
	Initialize application data.
bool	EvaluateOptions () override
	Process command line options.
void	Run () override
	Main body of application.
Public Member Functions inherited from votca::tools::Application
	Application ()
virtual	~Application ()
int	Exec (int argc, char **argv)
	executes the program
virtual std::string	ProgramName ()=0
	program name
virtual std::string	VersionString ()
	version string of application
virtual void	HelpText (std::ostream &out)=0
	help text of application without version information
virtual void	Initialize ()=0
	Initialize application data.
virtual bool	EvaluateOptions ()=0
	Process command line options.
void	CheckRequired (const std::string &option_name, const std::string &error_msg="")
	Check weather required option is set.
virtual void	Run ()=0
	Main body of application.
boost::program_options::options_description_easy_init	AddProgramOptions (const std::string &group="")
	add option for command line
boost::program_options::variables_map &	OptionsMap ()
	get available program options & descriptions
boost::program_options::options_description &	OptionsDesc ()
boost::program_options::options_description &	VisibleOptions ()
	filters out the Hidden group from the options descriptions
void	StopExecution ()
	call StopExecution after EvaluateOptions

Additional Inherited Members
virtual void	ShowHelpText (std::ostream &out)
Protected Attributes inherited from votca::tools::Application
std::map< std::string, boost::program_options::options_description >	op_groups_
bool	continue_execution_ = true

Detailed Description

Definition at line 45 of file xtp_map.cc.

Member Function Documentation

EvaluateOptions()

bool XtpMap::EvaluateOptions ( )

overridevirtual

Process command line options.

Returns

true to continue, false to stop

EvaluateOptions is called by Run after parsing the command line. return true if everything is ok, false to stop and show help text.

Implements votca::tools::Application.

Definition at line 86 of file xtp_map.cc.

HelpText()

void XtpMap::HelpText ( ostream &  out )

inlineoverridevirtual

help text of application without version information

Parameters

out	ostream for output

Implements votca::tools::Application.

Definition at line 49 of file xtp_map.cc.

Initialize()

void XtpMap::Initialize ( )

overridevirtual

Initialize application data.

Initialize is called by run before parsing the command line. All necessary command line arguments can be added here

Implements votca::tools::Application.

Definition at line 63 of file xtp_map.cc.

ProgramName()

string XtpMap::ProgramName ( )

inlineoverridevirtual

program name

Returns

string with program name

overload this function to set the program name

Implements votca::tools::Application.

Definition at line 48 of file xtp_map.cc.

Run()

void XtpMap::Run ( )

overridevirtual

Main body of application.

Run is called after command line was parsed + evaluated. All the work should be done in here.

Implements votca::tools::Application.

Definition at line 97 of file xtp_map.cc.

ShowHelpText()

void XtpMap::ShowHelpText ( std::ostream &  out )

overridevirtual

Reimplemented from votca::tools::Application.

Definition at line 296 of file xtp_map.cc.

---

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

• xtp/src/tools/xtp_map.cc