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

This class manages MPI Addresses. More...

#include <MPI_Addrs.h>

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

Public Member Functions

 MPI_Addrs (void)
 create
 
virtual ~MPI_Addrs (void)
 destroy
 
virtual tMemSize getMemorySize () const
 return the memory size of the class
 
template<class T >
MPI_Addrsoperator= (const T &variable)
 set operator More...
 
tMPIByte & operator() ()
 get operator More...
 
const tMPIByte & operator() () const
 get operator More...
 
MPI_Addrsoperator+= (const MPI_Addrs &adr)
 add operator More...
 
MPI_Addrsoperator+= (const tMPIByte &adr)
 add operator More...
 
MPI_Addrsoperator-= (const MPI_Addrs &adr)
 sub operator More...
 
MPI_Addrsoperator-= (const tMPIByte &adr)
 sub operator 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...
 
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

template<typename T >
static tMPIError GetAddress (const T *variable, tMPIByte &address)
 get the address More...
 
static tMPIByte Sum (const tMPIByte &address1, const tMPIByte &address2)
 
static tMPIByte Sub (const tMPIByte &address1, const tMPIByte &address2)
 sub the adress 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 MPI_Object
 MPI_Object (void)
 create
 
virtual ~MPI_Object (void)
 destroy
 
- 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 manages MPI Addresses.

Author
Stephane Despreaux
Version
1.0

Member Function Documentation

◆ GetAddress()

template<typename T >
static tMPIError MPI_Addrs::GetAddress ( const T *  variable,
tMPIByte &  address 
)
inlinestatic

get the address

Parameters
[in]variable: variable
[out]address: address of the variable
Returns
an error code if any

address=&variable mut for portability it must be encapsulate

◆ operator()() [1/2]

tMPIByte& MPI_Addrs::operator() ( )
inline

get operator

Returns
the asociated address

◆ operator()() [2/2]

const tMPIByte& MPI_Addrs::operator() ( ) const
inline

get operator

Returns
the associted adress

◆ operator+=() [1/2]

MPI_Addrs& MPI_Addrs::operator+= ( const MPI_Addrs adr)
inline

add operator

Parameters
[in]adraddress to add
Returns
this

◆ operator+=() [2/2]

MPI_Addrs& MPI_Addrs::operator+= ( const tMPIByte &  adr)
inline

add operator

Parameters
[in]adraddress to add
Returns
this

◆ operator-=() [1/2]

MPI_Addrs& MPI_Addrs::operator-= ( const MPI_Addrs adr)
inline

sub operator

Parameters
[in]adraddress to sub
Returns
this

◆ operator-=() [2/2]

MPI_Addrs& MPI_Addrs::operator-= ( const tMPIByte &  adr)
inline

sub operator

Parameters
[in]adraddress to sub
Returns
this

◆ operator=()

template<class T >
MPI_Addrs& MPI_Addrs::operator= ( const T &  variable)
inline

set operator

Parameters
[in]variable: set the address of variable
Returns
this

◆ Sub()

static tMPIByte MPI_Addrs::Sub ( const tMPIByte &  address1,
const tMPIByte &  address2 
)
inlinestatic

sub the adress

Parameters
[in]addresse1: the addresses to sum
[in]addresse2: the addresses to sum
Returns
address1-address2

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