This class is a MPI Runner class for StochMagnet package. More...

#include <SMOMPI_Run.h>

Inheritance diagram for SMOMPI_Run:

[legend]

Collaboration diagram for SMOMPI_Run:

[legend]

Public Member Functions
	SMOMPI_Run ()
	create

virtual	~SMOMPI_Run (void)
	destroy

virtual tMemSize	getMemorySize () const
	return the memory size of the class and the memory size of all its attributes/associations More...

virtual void	getManCommands (std::map< tString, tString > &commandsMan) const
	return the man of commands More...

virtual void	createClassFactories (const CORE_OptionsList &options) const override
	create the class factories from options More...

virtual tBoolean	makeRun (const tString &command, const CORE_OptionsList &options) const override
	make run command More...

virtual tBoolean	makeTests (const CORE_OptionsList &options) const override
	make run test More...

Public Member Functions inherited from MPI_Run
	MPI_Run ()
	create

virtual	~MPI_Run (void)
	destroy

virtual void	setLogOptions (const CORE_OptionsList &options) const override
	create the output stream from the options More...

virtual tBoolean	printHelp (const CORE_OptionsList &options) const override
	print the help More...

Public Member Functions inherited from CORE_Run
	CORE_Run (void)
	create

virtual	~CORE_Run (void)
	destroy

virtual tMemSize	getContentsMemorySize () const override
	return the memory size in byte More...

void	setOptionsClassName (const tString &c)
	set the options class name More...

void	initOptions (CORE_OptionsList &options) const
	default initialization of the options More...

tBoolean	executeRun (int argc, char *argv[]) const
	run the program from main class More...

Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T >	getSharedPointer ()
	return the shared pointer for this More...

template<class T >
std::shared_ptr< const T >	getConstSharedPointer () const
	return a const shared pointer for this More...

template<class T >
tBoolean	isInstanceOf () const
	test if the clas T is an instance of this class More...

tString	getClassName () const
	return the name of the class More...

tString	getPointerString () const
	retrun the pointer of the class as a string More...

tString	getIdentityString () const
	retrun the string identification of the class More...

virtual tString	toString () const
	return the string representation of the object node More...

Additional Inherited Members
Static Public Member Functions inherited from MPI_Run
static void	InitializeEnvironment (int argc, char *argv[], const tBoolean &isOpenMPEnabled)
	initialize the environment

static void	InitializeEnvironment (int argc, char *argv[])
	initialize the environment

static void	FinalizeEnvironment ()
	finalize the environment

static MPI_Environment &	GetEnvironment ()
	get the environment

static void	SetLogOptions (const CORE_OptionsList &options)
	create the output stream from the options More...

Static Public Member Functions inherited from CORE_Run
static void	SetSoftName (const tString &soft)
	set soft name More...

static const tString &	GetSoftName ()
	get soft name More...

static void	SetVersion (const tString &version)
	set the version More...

static const tString &	GetVersion ()
	get the version More...

static tBoolean	Is64Architecture ()
	return true if the machine is a 64 bits machine More...

static tBoolean	Is32Architecture ()
	return true if the machine is a 32 bits machine More...

static void	InitSeed (const unsigned int &seed)
	init the seed for uniform random generator More...

static void	InitSeed ()
	init the seed for uniform random generator

static CORE_Out &	Out ()
	return the output stream More...

static CORE_Out &	getOut ()
	return the output stream More...

static CORE_ClassFactory &	GetClassFactory ()
	return the class factory More...

static tString	ReadPath (const CORE_OptionsList &options, const tString &optName)
	read the path from options with optName More...

static void	ReadOutputOptions (const CORE_OptionsList &options, tString &outputPath, tString &outputPrefix)
	read the output path &prefix from options More...

static void	ReadInputOptions (const CORE_OptionsList &options, tString &inputPath, tString &inputPrefix)
	read the input path & prefix from options More...

static void	SetLogOptions (const CORE_OptionsList &options)

static void	SetDebugOptions (const CORE_OptionsList &options)
	set the log options More...

Static Public Member Functions inherited from CORE_Object
static tBoolean	EnableMemoryStack (const tBoolean &isMemoryChecked)
	enable the memory stack More...

static void	EnableMemoryStack ()
	enable the memory stack

static void	DisableMemoryStack ()
	disable the memory stack

static tBoolean	IsMemoryStackEnabled ()
	return trur if the memory stack is enabled

static tString	MemoryStackToString ()
	get the memory stack in string More...

static tIndex	GetRegisteredClassesNumber ()
	get the memory stack in string More...

Protected Member Functions inherited from CORE_Object
	CORE_Object ()
	build an instance of the object

virtual	~CORE_Object ()
	destroy the instance of object std

Detailed Description

This class is a MPI Runner class for StochMagnet package.

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ createClassFactories()

virtual void SMOMPI_Run::createClassFactories ( const CORE_OptionsList & options ) const

overridevirtual

create the class factories from options

Parameters

[in] options the options

Reimplemented from CORE_Run.

◆ getManCommands()

virtual void SMOMPI_Run::getManCommands ( std::map< tString, tString > & commandsMan ) const

inlinevirtual

return the man of commands

Parameters

[in,out] commands with its man as a map

Reimplemented from CORE_Run.

◆ getMemorySize()

virtual tMemSize SMOMPI_Run::getMemorySize ( ) const

inlinevirtual

return the memory size of the class and the memory size of all its attributes/associations

Returns

the memory size of the class and the memory size of its attributes/associations in bytes The mamory size is :

the added size of the base classes which contains:
- the primary attributes size depends on the order: (first delare the smallest attributes size
- all virtual functions costs <pointer-size> (4 32xor 8 64x) bytes by virtual function
- virtual inherihtance will increase of (4 or 8) bytes
we add the size of the contains values of the attributes : for example the size of a string is the length of the string 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from MPI_Run.

◆ makeRun()

virtual tBoolean SMOMPI_Run::makeRun	(	const tString &	command,
		const CORE_OptionsList &	options
	)		const

overridevirtual

make run command

Parameters

[in]	command	the command to run
[in]	options	the options of the program

Returns: true if the the executing of the runing of program has succeeded

Reimplemented from CORE_Run.

◆ makeTests()

virtual tBoolean SMOMPI_Run::makeTests ( const CORE_OptionsList & options ) const

overridevirtual

make run test

Parameters

[in] options the options of the program

Returns: true if the the executing of the tests of program has succeeded

Reimplemented from CORE_Run.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/main/mpi/SMOMPI_Run.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createClassFactories()

◆ getManCommands()

◆ getMemorySize()

◆ makeRun()

◆ makeTests()