FRODO Version 2.19.1
An open-source framework for Distributed Constraint Optimization (DCOP)
Loading...
Searching...
No Matches
frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > > Class Template Reference

Message sent by roots containing the optimal utility value of their DFS tree, conditioned on the values of the parameters (if any). More...

Inheritance diagram for frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > >:

Public Member Functions

 OptUtilMessage ()
 Empty constructor used for externalization.
 OptUtilMessage (UtilitySolutionSpace< Val, U > value, String rootVar)
 Constructor.
UtilitySolutionSpace< Val, U > getUtility ()
String getRoot ()
void fakeSerialize ()
Public Member Functions inherited from frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >
 MessageWith2Payloads (MessageType type, T1 payload1, T2 payload2)
 Constructor.
 MessageWith2Payloads ()
 Empty constructor.
void writeExternal (ObjectOutput out) throws IOException
void readExternal (ObjectInput in) throws IOException, ClassNotFoundException
MessageWith2Payloads< T1, T2 > clone ()
T1 getPayload1 ()
void setPayload1 (T1 payload1)
T2 getPayload2 ()
void setPayload2 (T2 payload2)
String toString ()
Public Member Functions inherited from frodo2.communication.Message
 Message (MessageType type)
 Constructor.
 Message ()
 Empty constructor.
MessageType getType ()

Additional Inherited Members

Protected Attributes inherited from frodo2.communication.Message
MessageType type
 The type of this message.

Detailed Description

Message sent by roots containing the optimal utility value of their DFS tree, conditioned on the values of the parameters (if any).

Parameters
<Val>the type used for variable values
<U>the type used for utility values

Constructor & Destructor Documentation

◆ OptUtilMessage() [1/2]

frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage ( )

Empty constructor used for externalization.

◆ OptUtilMessage() [2/2]

frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage ( UtilitySolutionSpace< Val, U > value,
String rootVar )

Constructor.

Parameters
valueoptimal utility value, conditioned on the values of the parameters (if any)
rootVarthe name of the root variable reporting its optimal utility value

References frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OPT_PARAM_UTIL_MSG_TYPE.

Member Function Documentation

◆ fakeSerialize()

void frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > >.fakeSerialize ( )

◆ getRoot()

String frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > >.getRoot ( )
Returns
the name of the root variable reporting its optimal utility value

References frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.getPayload2().

Referenced by frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.notifyIn().

Here is the call graph for this function:

◆ getUtility()

UtilitySolutionSpace< Val, U > frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.OptUtilMessage< Val extends Addable< Val >, U extends Addable< U > >.getUtility ( )
Returns
the optimal utility value, conditioned on the values of the parameters (if any)

References frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.getPayload1().

Referenced by frodo2.algorithms.dpop.param.ParamUTIL< Val extends Addable< Val >, U extends Addable< U > >.notifyIn().

Here is the call graph for this function:

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