Atollrun Class Reference

#include <atollrun.h>

Collaboration diagram for Atollrun:

[legend]

Public Member Functions
void	Init (int *pArgc, char **pArgv[])
void	setEstablishConnectionsOnInit (bool pAutoSetup=true)
void	setPerformConnectionTestOnInit (bool pSelfTest=true)
void	setAcquirePortOnSingle (bool pAcquireOnSingle=false)
int	getCommRank ()
int	getCommSize ()
port_id	getPort (int pRank)
atoll_handle	getHandle (int pRank)
	~Atollrun ()
Static Public Member Functions
Atollrun &	getReference ()

---

Detailed Description

Management singleton class for the ATOLL network, communicates with 'atollrun.py'

Definition at line 79 of file atollrun.h.

---

Constructor & Destructor Documentation

Atollrun::~Atollrun (   )

Destructor: This destructor closes all open connections and the ATOLL port. It's similar to MPI_Finish(), but implicit

---

Member Function Documentation

int Atollrun::getCommRank (   )

Return my rank. It's similar to MPI_Comm_Rank() of MPI Returns: my rank in the current process group Exceptions: AtollrunException  on any error

int Atollrun::getCommSize (   )

Return the size of the current process group. It's similar to MPI_Comm_Size() of MPI Returns: the size of the current process group Exceptions: AtollrunException  on any error

atoll_handle Atollrun::getHandle (  int  pRank  )

Return the ATOLL handle for communicating to a certain Rank ID Parameters: pRank  the rank to resolve the ATOLL handle for Returns: the ATOLL handle of the Rank ID pRank Exceptions: AtollrunException  on any error

port_id Atollrun::getPort (  int  pRank  )

Return the ATOLL port of a certain Rank ID Parameters: pRank  the rank to resolve the ATOLL port for Returns: the ATOLL port of the Rank ID pRank Exceptions: AtollrunException  on any error

Atollrun& Atollrun::getReference (   )  [static]

Return the reference to the singleton instance of Atollrun Returns: the reference to the Atollrun instance

void Atollrun::Init (  int *  pArgc, char **  pArgv[] )

Initializes the network by communicating with 'atollrun.py'. It's similar to MPI_Init() of MPI. NOTE: It's essential that the user program did not write anything to the console before this function !!! Parameters: pArgc  pointer to the argument counter pArgv  pointer to the argument vector Exceptions: AtollrunException  on any error

void Atollrun::setAcquirePortOnSingle (  bool  pAcquireOnSingle = false  )  [inline]

This function sets a flag for the Init() method. When set to true, on initialization the method opens a ATOLL port even when the current process is the only one and having nobody to communicate to. This flag only makes sense when setting it before calling Init() Parameters: pAcquireOnSingle  flag indicating if the Init() method will open an ATOLL port when the process is alone Definition at line 128 of file atollrun.h.

void Atollrun::setEstablishConnectionsOnInit (  bool  pAutoSetup = true  )  [inline]

This function sets a flag for the Init() method. When set to true, on initialization Init() establishes connections to all peers and performs a little communication test. If set to false, on initialization Init() will only open an ATOLL port, but nothing more. Settings this flag to false implies setPerformConnectionTestOnInit(false). This flag only makes sense when setting it before calling Init() Parameters: pAutoSetup  flag indicating if the Init() method will establish connections and perform a test Definition at line 102 of file atollrun.h. References setPerformConnectionTestOnInit(). Referenced by setPerformConnectionTestOnInit().

Here is the call graph for this function:

void Atollrun::setPerformConnectionTestOnInit (  bool  pSelfTest = true  )  [inline]

This functions sets a flag for the Init() method. When set to true, on initialization Init() performs a little connections test after establishing the connections. If set to false, on initialization Init() will not test the communication between the ports. Setting this flag to true implies setEstablishConnectionsOnInit(true). This flag only makes sense when setting it before calling Init() Parameters: pSelfTest  flag indicating if the Init() method will perform a selftest Definition at line 116 of file atollrun.h. References setEstablishConnectionsOnInit(). Referenced by setEstablishConnectionsOnInit().

Here is the call graph for this function:

---

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

• atollrun.h

---