frodo2.algorithms.dpop.restart.UTILreuse Class Reference

UTIL message storage for warm restarts of S-DPOP. More...

Inheritance diagram for frodo2.algorithms.dpop.restart.UTILreuse:

Public Member Functions
	UTILreuse (DCOPProblemInterface<?, ?> problem, Element parameters)
	Constructor from XML descriptions.
Decision	notifyOut (Message msg)
Collection< MessageType >	getMsgTypes ()
void	setQueue (Queue queue)
void	notifyIn (Message msg)
Public Member Functions inherited from frodo2.communication.IncomingMsgPolicyInterface< T >
default void	notifyIn (Message msg, Object toAgent)
	Notifies the listener of an incoming message.
Public Member Functions inherited from frodo2.communication.OutgoingMsgPolicyInterface< T >
default Decision	notifyOut (Object fromAgent, Message msg)
	Notifies the listener of an outgoing message.
default Decision	notifyOut (Object fromAgent, Message msg, Collection<? extends Object > toAgents)
	Notifies the listener of an outgoing message.
default Decision	notifyOut (Message msg, Collection<? extends Object > toAgents)
	Notifies the listener of an outgoing message.

Static Public Attributes
static MessageType	REUSE_MSG_TYPE = new MessageType ("S-DPOP", "UTILreuse")
	Type used for empty util reuse messages.

Private Member Functions
void	init ()
	Parses the problem.
void	reset ()
	Forgets information about the problem, but not too much :).

Private Attributes
Queue	queue
	The queue on which it should call sendMessage().
DCOPProblemInterface<?, ?>	problem
	The problem.
Map< String, String >	owners
	For each known variable, the name of the agent that owns it.
String	myID
	This agent's name.
HashMap< String, UTILmsg<?, ?> >	StorageIn = new HashMap< String, UTILmsg<?, ?> >()
	For storing incoming messages.
HashMap< String, Message >	StorageOut = new HashMap<String,Message>()
	For storing outgoing messages, key is the sender.
boolean	started = false
	Whether the algorithm has started.

Detailed Description

UTIL message storage for warm restarts of S-DPOP.

Author

Jonas Helfer, Thomas Leaute

Constructor & Destructor Documentation

UTILreuse()

frodo2.algorithms.dpop.restart.UTILreuse.UTILreuse	(	DCOPProblemInterface<?, ?>	problem,
		Element	parameters )

Constructor from XML descriptions.

Parameters

problem	description of the problem
parameters	description of the parameters of UTILpropagation

References problem.

Member Function Documentation

getMsgTypes()

Collection< MessageType > frodo2.algorithms.dpop.restart.UTILreuse.getMsgTypes

(

)

See also

IncomingMsgPolicyInterface.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, REUSE_MSG_TYPE, frodo2.algorithms.AgentInterface< V extends Addable< V > >.START_AGENT, and frodo2.algorithms.dpop.UTILpropagation< Val extends Addable< Val >, U extends Addable< U > >.UTIL_MSG_TYPE.

init()

void frodo2.algorithms.dpop.restart.UTILreuse.init ( )

private

Parses the problem.

References problem.

Referenced by notifyIn(), and notifyOut().

notifyIn()

void frodo2.algorithms.dpop.restart.UTILreuse.notifyIn

(

Message

msg

)

See also

IncomingMsgPolicyInterface.notifyIn(Message)

Todo

: implement the restart util message!

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.communication.MessageType.equals(), frodo2.algorithms.dpop.restart.Token.getSender(), frodo2.algorithms.dpop.UTILmsg< Val extends Addable< Val >, U extends Addable< U > >.getSender(), frodo2.communication.Message.getType(), init(), owners, queue, reset(), REUSE_MSG_TYPE, StorageIn, and frodo2.algorithms.dpop.UTILpropagation< Val extends Addable< Val >, U extends Addable< U > >.UTIL_MSG_TYPE.

Here is the call graph for this function:

notifyOut()

Decision frodo2.algorithms.dpop.restart.UTILreuse.notifyOut

(

Message

msg

)

See also

OutgoingMsgPolicyInterface.notifyOut(Message)

Implements frodo2.communication.OutgoingMsgPolicyInterface< T >.

References frodo2.communication.OutgoingMsgPolicyInterface< T >.Decision.DISCARD, frodo2.communication.OutgoingMsgPolicyInterface< T >.Decision.DONTCARE, frodo2.algorithms.dpop.UTILmsg< Val extends Addable< Val >, U extends Addable< U > >.equals(), frodo2.communication.MessageType.equals(), frodo2.algorithms.dpop.UTILmsg< Val extends Addable< Val >, U extends Addable< U > >.getDestination(), frodo2.algorithms.dpop.UTILmsg< Val extends Addable< Val >, U extends Addable< U > >.getSender(), frodo2.communication.Message.getType(), init(), owners, queue, StorageOut, and frodo2.algorithms.dpop.UTILpropagation< Val extends Addable< Val >, U extends Addable< U > >.UTIL_MSG_TYPE.

Here is the call graph for this function:

reset()

void frodo2.algorithms.dpop.restart.UTILreuse.reset ( )

private

Forgets information about the problem, but not too much :).

Referenced by notifyIn().

setQueue()

void frodo2.algorithms.dpop.restart.UTILreuse.setQueue

(

Queue

queue

)

See also

IncomingMsgPolicyInterface.setQueue(Queue)

Implements frodo2.communication.MessageListener< T >.

References queue.

Member Data Documentation

myID

String frodo2.algorithms.dpop.restart.UTILreuse.myID

private

This agent's name.

owners

Map<String, String> frodo2.algorithms.dpop.restart.UTILreuse.owners

private

For each known variable, the name of the agent that owns it.

Referenced by notifyIn(), and notifyOut().

problem

DCOPProblemInterface<?, ?> frodo2.algorithms.dpop.restart.UTILreuse.problem

private

The problem.

Referenced by init(), and UTILreuse().

queue

Queue frodo2.algorithms.dpop.restart.UTILreuse.queue

private

The queue on which it should call sendMessage().

Referenced by notifyIn(), notifyOut(), and setQueue().

REUSE_MSG_TYPE

MessageType frodo2.algorithms.dpop.restart.UTILreuse.REUSE_MSG_TYPE = new MessageType ("S-DPOP", "UTILreuse")

static

Type used for empty util reuse messages.

Referenced by getMsgTypes(), notifyIn(), frodo2.algorithms.dpop.restart.Token.Token(), and frodo2.algorithms.dpop.restart.Token.Token().

started

boolean frodo2.algorithms.dpop.restart.UTILreuse.started = false

private

Whether the algorithm has started.

StorageIn

HashMap< String, UTILmsg<?, ?> > frodo2.algorithms.dpop.restart.UTILreuse.StorageIn = new HashMap< String, UTILmsg<?, ?> >()

private

For storing incoming messages.

Referenced by notifyIn().

StorageOut

HashMap<String,Message> frodo2.algorithms.dpop.restart.UTILreuse.StorageOut = new HashMap<String,Message>()

private

For storing outgoing messages, key is the sender.

Referenced by notifyOut().

---

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

• src/frodo2/algorithms/dpop/restart/UTILreuse.java