UG

Ubiquity Generator framework

Public Member Functions | List of all members
ParaSolverState Class Referenceabstract

class ParaSolverState (ParaSolver state object for notification message) More...

#include <paraSolverState.h>

Inheritance diagram for ParaSolverState:
BbParaSolverState BbParaSolverStateMpi BbParaSolverStateTh

Public Member Functions

 ParaSolverState ()
 
virtual ~ParaSolverState ()
 
virtual bool isRacingStage ()=0
 getter of isRacingStage More...
 
virtual unsigned int getNotificaionId ()=0
 getter of notification id More...
 
virtual int getLcId ()=0
 getter of LoadCoordintor id More...
 
virtual int getGlobalSubtreeId ()=0
 getter of global subtree id More...
 
virtual double getDeterministicTime ()=0
 getter of deterministic time More...
 
virtual std::string toString ()=0
 stringfy ParaSolverState More...
 
virtual void send (ParaComm *comm, int destination, int tag)=0
 send this object More...
 
virtual void receive (ParaComm *comm, int source, int tag)=0
 receive this object More...
 

Detailed Description

class ParaSolverState (ParaSolver state object for notification message)

Definition at line 50 of file paraSolverState.h.

Constructor & Destructor Documentation

◆ ParaSolverState()

ParaSolverState ( )

Definition at line 54 of file paraSolverState.h.

◆ ~ParaSolverState()

virtual ~ParaSolverState ( )
virtual

Definition at line 59 of file paraSolverState.h.

Member Function Documentation

◆ getDeterministicTime()

virtual double getDeterministicTime ( )
pure virtual

getter of deterministic time

Returns
deterministic time

Implemented in BbParaSolverState.

◆ getGlobalSubtreeId()

virtual int getGlobalSubtreeId ( )
pure virtual

getter of global subtree id

Returns
global subtree id

Implemented in BbParaSolverState.

◆ getLcId()

virtual int getLcId ( )
pure virtual

getter of LoadCoordintor id

Returns
LoadCoordinator id

Implemented in BbParaSolverState.

◆ getNotificaionId()

virtual unsigned int getNotificaionId ( )
pure virtual

getter of notification id

Returns
notification id

Implemented in BbParaSolverState.

◆ isRacingStage()

virtual bool isRacingStage ( )
pure virtual

getter of isRacingStage

Returns
true if the Solver notified this message is in racing stage, false otherwise

Implemented in BbParaSolverState.

◆ receive()

virtual void receive ( ParaComm *  comm,
int  source,
int  tag 
)
pure virtual

receive this object

Parameters
commcommunicator used
sourcesource rank
tagTagSolverState

Implemented in BbParaSolverStateMpi, and BbParaSolverStateTh.

Referenced by BbParaLoadCoordinator::processRacingRampUpTagSolverState(), and BbParaLoadCoordinator::processTagSolverState().

◆ send()

virtual void send ( ParaComm *  comm,
int  destination,
int  tag 
)
pure virtual

send this object

Parameters
commcommunicator used
destinationdestination rank
tagTagSolverState

Implemented in BbParaSolverStateMpi, and BbParaSolverStateTh.

Referenced by BbParaSolver::sendSolverState().

◆ toString()

virtual std::string toString ( )
pure virtual

stringfy ParaSolverState

Returns
string to show inside of ParaSolverState

Implemented in BbParaSolverState.