SubtaskId Class Reference

SubtaskId class. More...

#include <paraTask.h>

Public Member Functions
	SubtaskId ()
	default constructor More...
	SubtaskId (const SubtaskId &subtreeId)
	copy constructor More...
	SubtaskId (int inLcId, int inGlobalSubtreeIdInLc, int inSolverId)
	constructor More...
	~SubtaskId ()
	destructor More...
SubtaskId &	operator= (const UG::SubtaskId &subTreeId)
	= operator definition More...
bool	operator== (const SubtaskId &inSid) const
	== operator definition More...
bool	operator!= (const SubtaskId &inSid) const
	!= operator definition More...
bool	operator< (const SubtaskId &inSid) const
	< operator definition More...
int	getLcId () const
	getter of LoadCoordinator id More...
int	getGlobalSubtreeIdInLc () const
	getter of global subtree id in Solvers managed by the LoadCoordinator More...
int	getSolverId () const
	getter of Solver id More...
std::string	toString ()
	Stringfy SubtreeId. More...

Public Attributes
int	lcId
	LoadCoordinator ID. More...
int	globalSubtaskIdInLc
	Global Subtask ID in Solvers managed by LoadCoordinator. More...
int	solverId
	Solver ID. More...

Detailed Description

SubtaskId class.

Definition at line 60 of file paraTask.h.

Constructor & Destructor Documentation

SubtaskId() [1/3]

SubtaskId

(

)

default constructor

Definition at line 70 of file paraTask.h.

SubtaskId() [2/3]

SubtaskId

(

const SubtaskId &

subtreeId

)

copy constructor

Definition at line 81 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc, SubtaskId::lcId, and SubtaskId::solverId.

SubtaskId() [3/3]

SubtaskId	(	int	inLcId,
		int	inGlobalSubtreeIdInLc,
		int	inSolverId
	)

constructor

Definition at line 93 of file paraTask.h.

~SubtaskId()

~SubtaskId

(

)

destructor

Definition at line 107 of file paraTask.h.

Member Function Documentation

getGlobalSubtreeIdInLc()

int getGlobalSubtreeIdInLc

(

)

const

getter of global subtree id in Solvers managed by the LoadCoordinator

Returns

global subtree id in LC

Definition at line 190 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc.

getLcId()

int getLcId

(

)

const

getter of LoadCoordinator id

Returns

LoadCoordinator id

Definition at line 180 of file paraTask.h.

References SubtaskId::lcId.

getSolverId()

int getSolverId

(

)

const

getter of Solver id

Returns

Solver id

Definition at line 200 of file paraTask.h.

References SubtaskId::solverId.

operator!=()

bool operator!=

(

const SubtaskId &

inSid

)

const

!= operator definition

Returns

true if this task subtree id is not that given by argument

Parameters

inSid

subtree id

Definition at line 146 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc, SubtaskId::lcId, and SubtaskId::solverId.

operator<()

bool operator<

(

const SubtaskId &

inSid

)

const

< operator definition

Returns

true if this task subtree id is less than that given by argument

Parameters

inSid

subtree id

Definition at line 162 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc, SubtaskId::lcId, and SubtaskId::solverId.

operator=()

SubtaskId & operator=

(

const UG::SubtaskId &

subTreeId

)

= operator definition

Returns

reference to SubtreeId

Definition at line 116 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc, SubtaskId::lcId, and SubtaskId::solverId.

operator==()

bool operator==

(

const SubtaskId &

inSid

)

const

== operator definition

Returns

true if this task subtree id is equla to that given by argument

Parameters

inSid

subtree id

Definition at line 130 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc, SubtaskId::lcId, and SubtaskId::solverId.

toString()

std::string toString

(

)

Stringfy SubtreeId.

Returns

sting to show inside of this object

Definition at line 210 of file paraTask.h.

References SubtaskId::globalSubtaskIdInLc, SubtaskId::lcId, and SubtaskId::solverId.

Referenced by TaskId::toString().

Member Data Documentation

globalSubtaskIdInLc

int globalSubtaskIdInLc

Global Subtask ID in Solvers managed by LoadCoordinator.

Definition at line 64 of file paraTask.h.

Referenced by BbParaNodeMpi::createDatatype(), BbParaNodeMpi::createDatatypeForNodeId(), ParaTask::getGlobalSubtaskIdInLc(), SubtaskId::getGlobalSubtreeIdInLc(), ParaTask::isRootTask(), ParaTask::isSameGlobalSubtaskIdInLcAs(), BbParaSolver::keepParaNode(), SubtaskId::operator!=(), SubtaskId::operator<(), SubtaskId::operator=(), SubtaskId::operator==(), BbParaNode::read(), BbParaSolver::sendParaNode(), ParaTask::setGlobalSubtaskId(), SubtaskId::SubtaskId(), SubtaskId::toString(), and BbParaNode::write().

lcId

int lcId

LoadCoordinator ID.

Definition at line 63 of file paraTask.h.

Referenced by BbParaNodeMpi::bcast(), BbParaNodeMpi::createDatatype(), BbParaNodeMpi::createDatatypeForNodeId(), ParaTask::getLcId(), SubtaskId::getLcId(), ParaTask::isRootTask(), ParaTask::isSameLcIdAs(), BbParaSolver::keepParaNode(), SubtaskId::operator!=(), SubtaskId::operator<(), SubtaskId::operator=(), SubtaskId::operator==(), BbParaNode::read(), BbParaNodeMpi::receive(), BbParaNodeMpi::receiveNewSubtreeRoot(), BbParaNodeMpi::receiveSubtreeRootNodeId(), BbParaNodeMpi::send(), BbParaNodeMpi::sendNewSubtreeRoot(), BbParaSolver::sendParaNode(), BbParaNodeMpi::sendSubtreeRootNodeId(), ParaTask::setGlobalSubtaskId(), SubtaskId::SubtaskId(), SubtaskId::toString(), and BbParaNode::write().

solverId

int solverId

Solver ID.

Definition at line 65 of file paraTask.h.

Referenced by BbParaNodeMpi::createDatatype(), BbParaNodeMpi::createDatatypeForNodeId(), ParaTask::getSolverId(), SubtaskId::getSolverId(), ParaTask::isRootTask(), SubtaskId::operator!=(), SubtaskId::operator<(), SubtaskId::operator=(), SubtaskId::operator==(), BbParaNode::read(), ParaTask::setSolverId(), SubtaskId::SubtaskId(), SubtaskId::toString(), and BbParaNode::write().