This class is a Run class for core package. More...

#include <CORE_Run.h>

Inheritance diagram for CORE_Run:

[legend]

Collaboration diagram for CORE_Run:

Public Member Functions
	CORE_Run (void)
	create

virtual	~CORE_Run (void)
	destroy

virtual tMemSize	getMemorySize () const override
	return the memory size of the class More...

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...

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

virtual void	setLogOptions (const CORE_OptionsList &options) const

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

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

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

virtual tBoolean	makeTests (const CORE_OptionsList &options) const
	make tests command More...

virtual tBoolean	printHelp (const CORE_OptionsList &options) const
	print the help 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...

Static Public Member Functions
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...

Additional Inherited Members
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 Run class for core package.

The program is launch as follow:

core.exe [options] make [args]

options={–optionName[=optionValue]}
args= [ type | tests | run ]

with options:

help : print this help, no value"+end;
args-file : take the args-file

wuih type:

type: print the type used in program
test: make the test of the program
run : run the program with args

execute core.exe –help to show the man

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ createClassFactories()

void CORE_Run::createClassFactories ( const CORE_OptionsList & options ) const

virtual

create the class factories from options

Parameters

[in] options the options of the program

Reimplemented in SMOMPI_Run, OMP_Run, and EXPR_Run.

◆ executeRun()

tBoolean CORE_Run::executeRun	(	int	argc,
		char *	argv[]
	)		const

run the program from main class

Parameters

[in]	argc	number of arguments
[in]	argv	the char* value of the arguments

Returns: true if the running has succeeded

◆ GetClassFactory()

static CORE_ClassFactory& CORE_Run::GetClassFactory ( )

inlinestatic

return the class factory

Returns: the output stream

◆ getContentsMemorySize()

virtual tMemSize CORE_Run::getContentsMemorySize ( ) const

inlineoverridevirtual

return the memory size in byte

Returns: the memory size of the storage in bytes 1 Kb = 1024 bytes 1 Mb = 1024 Kb 1 Gb = 1024 Mb 1 Tb = 1024 Gb 1 Hb = 1024 Tb

Reimplemented from CORE_Object.

◆ getManCommands()

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

inlinevirtual

return the man of commands

Parameters

[in,out] commandsMan help on commank keys with its man as a map

Reimplemented in SMOMPI_Run.

◆ getMemorySize()

virtual tMemSize CORE_Run::getMemorySize ( ) const

inlineoverridevirtual

return the memory size of the class

Returns: the memory size of the class in bytes 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from CORE_Object.

Reimplemented in MPI_Run, EXPR_Run, and SMOMPI_Run.

◆ getOut()

static CORE_Out& CORE_Run::getOut ( )

inlinestatic

return the output stream

Returns: the output stream

◆ GetSoftName()

static const tString& CORE_Run::GetSoftName ( )

inlinestatic

get soft name

Returns: the soft name

◆ GetVersion()

static const tString& CORE_Run::GetVersion ( )

inlinestatic

get the version

Returns: the version in string form

◆ initOptions()

void CORE_Run::initOptions ( CORE_OptionsList & options ) const

inline

default initialization of the options

Parameters

[in] options default values of the options

◆ InitSeed()

static void CORE_Run::InitSeed ( const unsigned int & seed )

inlinestatic

init the seed for uniform random generator

Parameters

[in] seed : seed for uniform random generator

◆ Is32Architecture()

static tBoolean CORE_Run::Is32Architecture ( )

inlinestatic

return true if the machine is a 32 bits machine

Returns: true is the computing is done in a 32 bits machine

◆ Is64Architecture()

static tBoolean CORE_Run::Is64Architecture ( )

inlinestatic

return true if the machine is a 64 bits machine

Returns: true is the computing is done in a 64 bits machine

◆ makeRun()

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

virtual

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 program has succeeded

Reimplemented in SMOMPI_Run.

◆ makeTests()

tBoolean CORE_Run::makeTests ( const CORE_OptionsList & options ) const

virtual

make tests command

Parameters

[in] options the options of the program

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

Reimplemented in SMOMPI_Run, OMP_Run, and EXPR_Run.

◆ Out()

static CORE_Out& CORE_Run::Out ( )

inlinestatic

return the output stream

Returns: the output stream

◆ printHelp()

tBoolean CORE_Run::printHelp ( const CORE_OptionsList & options ) const

virtual

print the help

Parameters

[in] options the options of the program

Returns: always true

Reimplemented in MPI_Run.

◆ ReadInputOptions()

void CORE_Run::ReadInputOptions	(	const CORE_OptionsList &	options,
		tString &	inputPath,
		tString &	inputPrefix
	)

static

read the input path & prefix from options

Parameters

[in]	options	: options of the program
[out]	inputPath	output path from options "input-path" and "current-path"
[out]	inputPrefix	output prefix from options "input-prefix" or "prefix"

◆ ReadOutputOptions()

void CORE_Run::ReadOutputOptions	(	const CORE_OptionsList &	options,
		tString &	outputPath,
		tString &	outputPrefix
	)

static

read the output path &prefix from options

Parameters

[in]	options	: options of the program
[out]	outputPath	output path from options "output-path" and "current-path"
[out]	outputPrefix	output prefix from options "output-prefix" or "prefix"

◆ ReadPath()

tString CORE_Run::ReadPath	(	const CORE_OptionsList &	options,
		const tString &	optName
	)

static

read the path from options with optName

Parameters

[in]	options	: options of the program
[in]	optName	: name of the option

Returns: the path

◆ SetDebugOptions()

static void CORE_Run::SetDebugOptions ( const CORE_OptionsList & options )

inlinestatic

set the log options

Parameters

[in] options options of the program

◆ SetLogOptions()

void CORE_Run::SetLogOptions ( const CORE_OptionsList & options )

static

set the the log options

Parameters

[in] options options of the program

◆ setLogOptions()

virtual void CORE_Run::setLogOptions ( const CORE_OptionsList & options ) const

inlinevirtual

set the the log options

Parameters

[in] options options of the program

Reimplemented in MPI_Run.

◆ setOptionsClassName()

void CORE_Run::setOptionsClassName ( const tString & c )

inline

set the options class name

Parameters

[in] c : name of the options class name

◆ SetSoftName()

static void CORE_Run::SetSoftName ( const tString & soft )

inlinestatic

set soft name

Parameters

[in] soft name of the soft

◆ SetVersion()

static void CORE_Run::SetVersion ( const tString & version )

inlinestatic

set the version

Parameters

version name of the version set the version of the code

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

/home/despreau/Developpement/CPP/devcpp20/include/core/CORE_Run.h
/home/despreau/Developpement/CPP/devcpp20/src/core/CORE_Run.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createClassFactories()

◆ executeRun()

◆ GetClassFactory()

◆ getContentsMemorySize()

◆ getManCommands()

◆ getMemorySize()

◆ getOut()

◆ GetSoftName()

◆ GetVersion()

◆ initOptions()

◆ InitSeed()

◆ Is32Architecture()

◆ Is64Architecture()

◆ makeRun()

◆ makeTests()

◆ Out()

◆ printHelp()

◆ ReadInputOptions()

◆ ReadOutputOptions()

◆ ReadPath()

◆ SetDebugOptions()

◆ SetLogOptions()

◆ setLogOptions()

◆ setOptionsClassName()

◆ SetSoftName()

◆ SetVersion()