VotcaProperty Class Reference

Inheritance diagram for VotcaProperty:

Collaboration diagram for VotcaProperty:

Public Member Functions
	VotcaProperty ()=default
	~VotcaProperty ()=default
string	ProgramName ()
	program name
void	HelpText (ostream &out)
	help text of application without version information
void	Initialize ()
	Initialize application data.
bool	EvaluateOptions ()
	Process command line options.
void	Run ()
	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

Private Attributes
string	file
string	format
votca::Index	level

Additional Inherited Members
Protected Member Functions inherited from votca::tools::Application
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 37 of file votca_property.cc.

Constructor & Destructor Documentation

VotcaProperty()

VotcaProperty::VotcaProperty ( )

default

~VotcaProperty()

VotcaProperty::~VotcaProperty ( )

default

Member Function Documentation

EvaluateOptions()

bool VotcaProperty::EvaluateOptions ( )

inlinevirtual

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 57 of file votca_property.cc.

HelpText()

void VotcaProperty::HelpText ( ostream &  out )

inlinevirtual

help text of application without version information

Parameters

out	ostream for output

Implements votca::tools::Application.

Definition at line 45 of file votca_property.cc.

Initialize()

void VotcaProperty::Initialize ( )

inlinevirtual

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 47 of file votca_property.cc.

ProgramName()

string VotcaProperty::ProgramName ( )

inlinevirtual

program name

Returns

string with program name

overload this function to set the program name

Implements votca::tools::Application.

Definition at line 43 of file votca_property.cc.

Run()

void VotcaProperty::Run ( )

inlinevirtual

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 62 of file votca_property.cc.

Member Data Documentation

file

string VotcaProperty::file

private

Definition at line 98 of file votca_property.cc.

format

string VotcaProperty::format

private

Definition at line 99 of file votca_property.cc.

level

votca::Index VotcaProperty::level

private

Definition at line 100 of file votca_property.cc.

---

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

• tools/src/tools/votca_property.cc