GranOO3::PlugIn::Step Class Reference

#include <Step.hpp>

Inheritance diagram for GranOO3::PlugIn::Step:

Public Member Functions
	Step ()
	~Step ()
void	parse_xml ()
void	run ()
void	init ()
Public Member Functions inherited from GranOO3::Core::PlugInInterface< Step >
virtual	~PlugInInterface ()
Public Member Functions inherited from GranOO3::Core::PlugIn
	PlugIn (const std::string &id)
virtual	~PlugIn ()
const std::string &	get_ID () const
void	verbose ()
void	run_and_init ()
void	trigger_signal_run ()
double	get_elapsed_time ()
int	get_instance_number ()
void	trigger_signal (const std::string &sigID)
virtual void	read_xml_element (const TiXmlElement *el, bool verbose=false)
bool	is_multi_thread () const
bool	is_trigger () const
bool	is_stop () const
void	stop ()
void	unstop ()
void	set_tot_iter_number (unsigned int)

Static Public Member Functions
static Step &	get (const std::string &)
Static Public Member Functions inherited from GranOO3::Core::PlugInInterface< Step >
static PlugIn *	build ()
static Step &	get (unsigned int=0)
static bool	exist (unsigned int rank=0)
static bool	record (const std::string file, const std::string desc="")
Static Public Member Functions inherited from GranOO3::Core::PlugIn
static PlugIn &	get (const std::string &id, unsigned int rank=0)
static std::map< std::string, std::vector< PlugIn * > >	get_all_plugin ()
static std::vector< PlugIn * >	get_all_plugin_vector ()
static bool	exist (const std::string &id, unsigned int rank=0)
static const std::string	class_ID ()
Static Public Member Functions inherited from GranOO3::Core::ObjectFactoryInterface< BaseClass, ChildClass >
static BaseClass *	build ()
static bool	record (const std::string &id, std::string file_name="", std::string desc="")
Static Public Member Functions inherited from GranOO3::Core::ObjectFactory< BaseClass >
static void	record (std::function< BaseClass *()>, const std::string &, const std::string file="", const std::string desc="")
static BaseClass *	new_object (const std::string &)
static std::vector< std::string >	get_ID ()
static std::map< const std::string, std::function< BaseClass *()> > &	get_map ()

Private Member Functions
	DECLARE_STD_GRANOO_PLUGIN (STEP)

Private Attributes
Core::ProgressBar	_bar
std::string	_label
double	_time_step
bool	_display_progression
bool	_reset_iteration

Static Private Attributes
static std::map< std::string, Step * >	_all = std::map<std::string, Step*>()

Additional Inherited Members
Protected Member Functions inherited from GranOO3::Core::PlugInInterface< Step >
	PlugInInterface ()
Protected Member Functions inherited from GranOO3::Core::ObjectFactoryInterface< BaseClass, ChildClass >
	ObjectFactoryInterface ()
virtual	~ObjectFactoryInterface ()
Protected Member Functions inherited from GranOO3::Core::ObjectFactory< BaseClass >
	ObjectFactory ()
virtual	~ObjectFactory ()
Protected Attributes inherited from GranOO3::Core::PlugIn
std::vector< PlugIn * >	_subplugin
PlugIn *	_current_subplugin
const std::string	_ID
const std::string	_description
PlugIn *	_parent
bool	_init
bool	_can_run
bool	_verbose
unsigned int	_current_iter_number
unsigned int	_iter_number
double	_total_time
bool	_stop
unsigned int	_every_iter
double	_step_time
unsigned int	_nb_outputs
Math::Expression *	_trigger_if_expr
Math::Expression *	_init_if_expr
std::chrono::microseconds	_elapsed_time

Constructor & Destructor Documentation

Step()

GranOO3::PlugIn::Step::Step

(

)

~Step()

GranOO3::PlugIn::Step::~Step

(

)

Member Function Documentation

DECLARE_STD_GRANOO_PLUGIN()

GranOO3::PlugIn::Step::DECLARE_STD_GRANOO_PLUGIN ( STEP  )

private

get()

Step & GranOO3::PlugIn::Step::get ( const std::string &  label )

static

init()

void GranOO3::PlugIn::Step::init ( )

virtual

Reimplemented from GranOO3::Core::PlugIn.

parse_xml()

void GranOO3::PlugIn::Step::parse_xml ( )

virtual

Reimplemented from GranOO3::Core::PlugIn.

run()

void GranOO3::PlugIn::Step::run ( )

virtual

Reimplemented from GranOO3::Core::PlugIn.

Member Data Documentation

_all

std::map< std::string, Step * > GranOO3::PlugIn::Step::_all = std::map<std::string, Step*>()

staticprivate

_bar

Core::ProgressBar GranOO3::PlugIn::Step::_bar

private

_display_progression

bool GranOO3::PlugIn::Step::_display_progression

private

_label

std::string GranOO3::PlugIn::Step::_label

private

_reset_iteration

bool GranOO3::PlugIn::Step::_reset_iteration

private

_time_step

double GranOO3::PlugIn::Step::_time_step

private

---

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

• /home/granoo/granoo/Lib/GranOO3/PlugIn/Step.hpp
• /home/granoo/granoo/Lib/GranOO3/PlugIn/Step.cpp