Hex  1.0
Hydrogen-electron collision solver
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions
Variable Class Referenceabstract

Base class for scatering variables. More...

#include <variables.h>

Public Member Functions

virtual ~Variable ()
 destructor More...
 
virtual std::string const & id () const =0
 String identification of the variable. More...
 
virtual std::string const & description () const =0
 Longer description text for use in program help. More...
 
virtual std::vector
< std::string > const & 
SQL_CreateTable () const =0
 SQL statements that create the required table, or empty vector if not needed. More...
 
virtual std::vector
< std::string > const & 
SQL_Update () const =0
 SQL statements that update the table after insetion of new data. More...
 
virtual std::vector
< std::string > const & 
deps () const =0
 List of all scattering event parameters that have to be specified by user. More...
 
virtual std::vector
< std::string > const & 
vdeps () const =0
 List of vectorizable scattering event parameters that have to be specified by user. More...
 
virtual bool initialize (sqlitepp::session &db) const =0
 initialize (e.g.) by defining external routines for SQLite More...
 
virtual bool run (sqlitepp::session &db, std::map< std::string, std::string > const &params) const =0
 write out requested data More...
 

Detailed Description

This is the heritage base for all scattering quantities that can be computed by hex-db.

Constructor & Destructor Documentation

virtual Variable::~Variable ( )
inlinevirtual

Member Function Documentation

virtual std::vector<std::string> const& Variable::deps ( ) const
pure virtual
virtual std::string const& Variable::description ( ) const
pure virtual
virtual std::string const& Variable::id ( ) const
pure virtual
virtual bool Variable::initialize ( sqlitepp::session &  db) const
pure virtual
virtual bool Variable::run ( sqlitepp::session &  db,
std::map< std::string, std::string > const &  params 
) const
pure virtual
virtual std::vector<std::string> const& Variable::SQL_CreateTable ( ) const
pure virtual
virtual std::vector<std::string> const& Variable::SQL_Update ( ) const
pure virtual
virtual std::vector<std::string> const& Variable::vdeps ( ) const
pure virtual

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