C++ mpi module for stochmagnet_main Package
Public Member Functions | Static Public Member Functions | List of all members
SMOMPI_Options Class Reference

This class is the options runner. More...

#include <SMOMPI_Options.h>

Inheritance diagram for SMOMPI_Options:
Inheritance graph
[legend]
Collaboration diagram for SMOMPI_Options:
Collaboration graph
[legend]

Public Member Functions

 SMOMPI_Options (void)
 create class instance
 
virtual ~SMOMPI_Options (void)
 destroy class instance
 
virtual tMemSize getMemorySize () const
 return the memory size of the class and the memory size of all its attributes/associations More...
 
virtual void initManOptions (CORE_OptionsList &manParameters) const override
 init the man of the options More...
 
virtual void initOptions (CORE_OptionsList &options) const override
 default initialization of the options More...
 
- Public Member Functions inherited from CORE_Options
 CORE_Options (void)
 create class instance
 
virtual ~CORE_Options (void)
 destroy class instance
 
- 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...
 
virtual tMemSize getContentsMemorySize () const
 return nthe memory size of the included associations 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 CORE_UniquePointer< SMOMPI_OptionsNew ()
 return a new unique pointer of this More...
 
- Static Public Member Functions inherited from SM_Options
static CORE_UniquePointer< SM_OptionsNew ()
 return a new unique pointer of this More...
 
- Static Public Member Functions inherited from CORE_Options
static CORE_UniquePointer< CORE_OptionsNew ()
 return a new unique pointer of this 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 SM_Options
 SM_Options (void)
 create class instance
 
virtual ~SM_Options (void)
 destroy class instance
 
- 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 the options runner.

Author
Stephane Despreaux
Version
2.0

Member Function Documentation

◆ getMemorySize()

virtual tMemSize SMOMPI_Options::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 SM_Options.

◆ initManOptions()

virtual void SMOMPI_Options::initManOptions ( CORE_OptionsList manParameters) const
inlineoverridevirtual

init the man of the options

Parameters
[in]manParametersman of the options

Reimplemented from SM_Options.

◆ initOptions()

virtual void SMOMPI_Options::initOptions ( CORE_OptionsList options) const
inlineoverridevirtual

default initialization of the options

Parameters
[in]optionsdefault values of the options

Reimplemented from SM_Options.

◆ New()

static CORE_UniquePointer<SMOMPI_Options> SMOMPI_Options::New ( )
inlinestatic

return a new unique pointer of this

Returns
an unique pointer of this class

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