MADNESS  0.10.1
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
madness::MacroTaskBase Class Referenceabstract

base class More...

#include <macrotaskq.h>

Inheritance diagram for madness::MacroTaskBase:
Inheritance graph
[legend]

Public Types

enum  Status { Running , Waiting , Complete , Unknown }
 
typedef std::vector< std::shared_ptr< MacroTaskBase > > taskqT
 

Public Member Functions

 MacroTaskBase ()
 
virtual ~MacroTaskBase ()
 
virtual void cleanup ()=0
 
double get_priority () const
 
bool is_complete () const
 
bool is_running () const
 
bool is_waiting () const
 
virtual void print_me (std::string s="") const
 
virtual void print_me_as_table (std::string s="") const
 
std::string print_priority_and_status_to_string () const
 
virtual void run (World &world, Cloud &cloud, taskqT &taskq, const long element, const bool debug)=0
 
void set_complete ()
 
void set_priority (const double p)
 
void set_running ()
 
void set_waiting ()
 

Public Attributes

double priority =1.0
 
enum madness::MacroTaskBase::Status stat =Unknown
 

Friends

std::ostream & operator<< (std::ostream &os, const MacroTaskBase::Status s)
 

Detailed Description

base class

Member Typedef Documentation

◆ taskqT

typedef std::vector<std::shared_ptr<MacroTaskBase> > madness::MacroTaskBase::taskqT

Member Enumeration Documentation

◆ Status

Enumerator
Running 
Waiting 
Complete 
Unknown 

Constructor & Destructor Documentation

◆ MacroTaskBase()

madness::MacroTaskBase::MacroTaskBase ( )
inline

◆ ~MacroTaskBase()

virtual madness::MacroTaskBase::~MacroTaskBase ( )
inlinevirtual

Member Function Documentation

◆ cleanup()

virtual void madness::MacroTaskBase::cleanup ( )
pure virtual

◆ get_priority()

double madness::MacroTaskBase::get_priority ( ) const
inline

References priority.

Referenced by print_priority_and_status_to_string().

◆ is_complete()

bool madness::MacroTaskBase::is_complete ( ) const
inline

References Complete, and stat.

◆ is_running()

bool madness::MacroTaskBase::is_running ( ) const
inline

References Running, and stat.

◆ is_waiting()

bool madness::MacroTaskBase::is_waiting ( ) const
inline

References stat, and Waiting.

◆ print_me()

virtual void madness::MacroTaskBase::print_me ( std::string  s = "") const
inlinevirtual

◆ print_me_as_table()

virtual void madness::MacroTaskBase::print_me_as_table ( std::string  s = "") const
inlinevirtual

◆ print_priority_and_status_to_string()

std::string madness::MacroTaskBase::print_priority_and_status_to_string ( ) const
inline

◆ run()

virtual void madness::MacroTaskBase::run ( World world,
Cloud cloud,
taskqT taskq,
const long  element,
const bool  debug 
)
pure virtual

◆ set_complete()

void madness::MacroTaskBase::set_complete ( )
inline

References Complete, and stat.

◆ set_priority()

void madness::MacroTaskBase::set_priority ( const double  p)
inline

References p(), and priority.

◆ set_running()

void madness::MacroTaskBase::set_running ( )
inline

References Running, and stat.

◆ set_waiting()

void madness::MacroTaskBase::set_waiting ( )
inline

References stat, and Waiting.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const MacroTaskBase::Status  s 
)
friend

Member Data Documentation

◆ priority

double madness::MacroTaskBase::priority =1.0

◆ stat

enum madness::MacroTaskBase::Status madness::MacroTaskBase::stat =Unknown

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