votca::xtp::StateApplication Class Reference

#include <stateapplication.h>

Inheritance diagram for votca::xtp::StateApplication:

Collaboration diagram for votca::xtp::StateApplication:

Public Member Functions
	StateApplication ()=default
	~StateApplication () override=default
Public Member Functions inherited from votca::xtp::XtpApplication
	XtpApplication ()
	~XtpApplication () override
void	Initialize () final
	Adds program options to the executable.
bool	EvaluateOptions () final
	Process command line options.
void	Run () final
	Main body of application.
void	ShowHelpText (std::ostream &out) final
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

Protected Member Functions
virtual bool	savetoStateFile () const =0
virtual void	ConfigCalculator ()=0
virtual bool	EvaluateFrame (Topology &top)=0
void	EvaluateSpecificOptions () final
virtual void	CheckOptions ()=0
void	execute () final
void	AddCommandLineOptions () final
virtual void	AddCommandLineOpt ()=0
Protected Member Functions inherited from votca::xtp::XtpApplication
virtual void	execute ()=0
virtual std::string	CalculatorType () const =0
virtual void	EvaluateSpecificOptions ()=0
virtual std::vector< std::string >	CalculatorNames () const =0
virtual void	CreateCalculator (const std::string &name)=0
virtual void	AddCommandLineOptions ()=0
virtual void	ShowHelpText (std::ostream &out)

Additional Inherited Members
Protected Attributes inherited from votca::xtp::XtpApplication
votca::tools::Property	options_
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 32 of file stateapplication.h.

Constructor & Destructor Documentation

StateApplication()

votca::xtp::StateApplication::StateApplication ( )

default

~StateApplication()

votca::xtp::StateApplication::~StateApplication ( )

overridedefault

Member Function Documentation

AddCommandLineOpt()

virtual void votca::xtp::StateApplication::AddCommandLineOpt ( )

protectedpure virtual

Implemented in XtpParallel, and XtpRun.

AddCommandLineOptions()

void votca::xtp::StateApplication::AddCommandLineOptions ( )

finalprotectedvirtual

Implements votca::xtp::XtpApplication.

Definition at line 32 of file stateapplication.cc.

CheckOptions()

virtual void votca::xtp::StateApplication::CheckOptions ( )

protectedpure virtual

Implemented in XtpParallel, and XtpRun.

ConfigCalculator()

virtual void votca::xtp::StateApplication::ConfigCalculator ( )

protectedpure virtual

Implemented in XtpParallel, and XtpRun.

EvaluateFrame()

virtual bool votca::xtp::StateApplication::EvaluateFrame ( Topology &  top )

protectedpure virtual

Implemented in XtpParallel, and XtpRun.

EvaluateSpecificOptions()

void votca::xtp::StateApplication::EvaluateSpecificOptions ( )

finalprotectedvirtual

Implements votca::xtp::XtpApplication.

Definition at line 48 of file stateapplication.cc.

execute()

void votca::xtp::StateApplication::execute ( )

finalprotectedvirtual

Implements votca::xtp::XtpApplication.

Definition at line 53 of file stateapplication.cc.

savetoStateFile()

virtual bool votca::xtp::StateApplication::savetoStateFile ( ) const

protectedpure virtual

Implemented in XtpParallel, and XtpRun.

---

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

• xtp/include/votca/xtp/stateapplication.h
• xtp/src/libxtp/stateapplication.cc