Class skydata::behaviour::SKD::FreezeLocal

ClassList > skydata > behaviour > SKD > FreezeLocal

More...

Inherits the following classes: SKAgentBehaviour

Inherited by the following classes: skydata::behaviour::SKD::FreezeLeaderDeletion

Public Functions

Type	Name
	FreezeLocal (SKAgent agent)
void	action ()
boolean	isFinished (Data data)

Protected Functions

Type	Name
void	afterFreeze (Data data)
void	unfreeze (Data data)

Detailed Description

This behaviour aims to freeze the agent of the same family to do some action synchronously

When the freeze is ended, the method "afterFreeze" is called.

Public Functions Documentation

function FreezeLocal

inline skydata::behaviour::SKD::FreezeLocal::FreezeLocal (
    SKAgent agent
) 

Add this behaviour to an agent

Parameters:

• agent : the agent

---

function action

inline void skydata::behaviour::SKD::FreezeLocal::action () 

Start the behaviour

---

function isFinished

inline boolean skydata::behaviour::SKD::FreezeLocal::isFinished (
    Data data
) 

Test if the freeze algorithm is finished

Parameters:

• data : the data of the algorithm

Returns:

true if the algorithm is finished, else false

---

Protected Functions Documentation

function afterFreeze

inline void skydata::behaviour::SKD::FreezeLocal::afterFreeze (
    Data data
) 

The function called when the freeze is ended

Parameters:

• data : the data of the algorithm

---

function unfreeze

inline void skydata::behaviour::SKD::FreezeLocal::unfreeze (
    Data data
) 

The function to call to end the freeze

Parameters:

• data : the data of the algorithm

---

---

The documentation for this class was generated from the following file /home/maxime/Desktop/skd_proto_v2/skd/src/main/java/skydata/behaviour/SKD/FreezeLocal.java