frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > > Class Template Reference

The message used to send a VALUE message to a variable's pseudochildren. More...

Inheritance diagram for frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >:

Public Member Functions
	VALUEmsg ()
	Empty constructor.
	VALUEmsg (String sender, String receiver, Val value, U threshold)
	Constructor.
String	toString ()
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
boolean	equals (Object msg)
String	getSender ()
	Getter function.
String	getReceiver ()
	Getter function.
Val	getValue ()
	Getter function.
U	getThreshold ()
	Getter function.
Public Member Functions inherited from frodo2.communication.Message
	Message (MessageType type)
	Constructor.
	Message ()
	Empty constructor.
MessageType	getType ()
void	fakeSerialize ()
	Pretends to serialize the message.

Package Attributes
String	receiver
	The receiving variable.

Private Attributes
String	sender
	The sending variable.
Val	value
	The context in which this message was created.
U	threshold
	The threshold belonging to this value.

Static Private Attributes
static final long	serialVersionUID = 2153239219905600645L
	Used for serialization.

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

Detailed Description

The message used to send a VALUE message to a variable's pseudochildren.

Parameters

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

Constructor & Destructor Documentation

VALUEmsg() [1/2]

frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.VALUEmsg

(

)

Empty constructor.

References frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.VALUE_MSG_TYPE.

Referenced by equals().

VALUEmsg() [2/2]

frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.VALUEmsg	(	String	sender,
		String	receiver,
		Val	value,
		U	threshold )

Constructor.

Parameters

sender	the sender variable
receiver	the recipient variable
value	the context
threshold	the threshold

References receiver, sender, threshold, value, and frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.VALUE_MSG_TYPE.

Member Function Documentation

equals()

boolean frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.equals

(

Object

msg

)

See also

java.lang.Object#equals(java.lang.Object)

References equals(), frodo2.communication.Message.getType(), frodo2.communication.Message.Message(), receiver, sender, threshold, value, and VALUEmsg().

Referenced by equals().

Here is the call graph for this function:

getReceiver()

String frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.getReceiver

(

)

Getter function.

Returns

the variable that is to receive this message

References receiver.

getSender()

String frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.getSender

(

)

Getter function.

Returns

the variable that sent this message

References sender.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleVALUEmessage().

getThreshold()

U frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.getThreshold

(

)

Getter function.

Returns

the threshold

References threshold.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleVALUEmessage().

getValue()

Val frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.getValue

(

)

Getter function.

Returns

the value

References value.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleVALUEmessage().

readExternal()

void frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.readExternal

(

ObjectInput

in

)

throws IOException, ClassNotFoundException

See also

java.io.Externalizable#readExternal(java.io.ObjectInput)

Reimplemented from frodo2.communication.Message.

References readExternal().

Referenced by readExternal().

Here is the call graph for this function:

toString()

String frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.toString

(

)

See also

Message.toString()

Reimplemented from frodo2.communication.Message.

writeExternal()

void frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.writeExternal

(

ObjectOutput

out

)

throws IOException

See also

java.io.Externalizable#writeExternal(java.io.ObjectOutput)

Reimplemented from frodo2.communication.Message.

Member Data Documentation

receiver

String frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.receiver

package

The receiving variable.

Referenced by equals(), getReceiver(), and VALUEmsg().

sender

String frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.sender

private

The sending variable.

Referenced by equals(), getSender(), and VALUEmsg().

serialVersionUID

final long frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.serialVersionUID = 2153239219905600645L

staticprivate

Used for serialization.

threshold

U frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.threshold

private

The threshold belonging to this value.

Referenced by equals(), getThreshold(), and VALUEmsg().

value

Val frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable< U > >.value

private

The context in which this message was created.

Referenced by equals(), getValue(), and VALUEmsg().

---

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

• src/frodo2/algorithms/adopt/VALUEmsg.java