frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > > Class Template Reference

Inheritance diagram for frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >:

Public Member Functions
	VALUEmsg ()
	Empty constructor.
	VALUEmsg (MessageType type, String sender, String receiver, String[] variables, V[] values)
	Constructor.
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
String	getSender ()
String	getReceiver ()
String[]	getVariables ()
V[]	getValues ()
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.
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 ()
void	fakeSerialize ()
	Pretends to serialize the message.

Static Public Attributes
static Addable<?>	DOMAIN_VALUE
	Used for externalization of messages.

Private Attributes
String[]	variables
	The variable names.
V[]	values
	The context in which sampling must occur.

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

Detailed Description

Author

Brammert Ottens, 7 jul. 2011

Parameters

<V>	the type used for domain values

Constructor & Destructor Documentation

VALUEmsg() [1/2]

frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.VALUEmsg

(

)

Empty constructor.

VALUEmsg() [2/2]

frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.VALUEmsg	(	MessageType	type,
		String	sender,
		String	receiver,
		String[]	variables,
		V[]	values )

Constructor.

Parameters

type	the type of the message
sender	the sender of the message
receiver	the name of the variable that is to receive this message
variables	the names of the variables
values	the reported values

References frodo2.communication.Message.type, values, and variables.

Member Function Documentation

getReceiver()

String frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.getReceiver

(

)

Author

Brammert Ottens, 7 jul. 2011

Returns

the name of the variable that is to receive this message

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

Referenced by frodo2.algorithms.duct.Sampling< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChild< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChildSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruning< V extends Addable< V > >.notifyIn(), and frodo2.algorithms.duct.SamplingPruningSearch< V extends Addable< V > >.notifyIn().

Here is the call graph for this function:

getSender()

String frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.getSender

(

)

Author

Brammert Ottens, 7 jul. 2011

Returns

the sender of the message

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

Referenced by frodo2.algorithms.duct.Sampling< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChild< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChildSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruning< V extends Addable< V > >.notifyIn(), and frodo2.algorithms.duct.SamplingPruningSearch< V extends Addable< V > >.notifyIn().

Here is the call graph for this function:

getValues()

V[] frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.getValues

(

)

Author

Brammert Ottens, 7 jul. 2011

Returns

the value that has been sampled

References values.

Referenced by frodo2.algorithms.duct.Sampling< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChild< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChildSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruning< V extends Addable< V > >.notifyIn(), and frodo2.algorithms.duct.SamplingPruningSearch< V extends Addable< V > >.notifyIn().

getVariables()

String[] frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.getVariables

(

)

Author

Brammert Ottens, 29 aug. 2011

Returns

the variable names

Referenced by frodo2.algorithms.duct.Sampling< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChild< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChildSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruning< V extends Addable< V > >.notifyIn(), and frodo2.algorithms.duct.SamplingPruningSearch< V extends Addable< V > >.notifyIn().

readExternal()

void frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.readExternal

(

ObjectInput

in

)

throws IOException, ClassNotFoundException

See also

Message.readExternal(java.io.ObjectInput)

Reimplemented from frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.

References DOMAIN_VALUE, values, and variables.

writeExternal()

void frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.writeExternal

(

ObjectOutput

out

)

throws IOException

See also

Message.writeExternal(java.io.ObjectOutput)

Reimplemented from frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.

References values, and variables.

Member Data Documentation

DOMAIN_VALUE

Addable<?> frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.DOMAIN_VALUE

static

Used for externalization of messages.

Referenced by readExternal(), and frodo2.algorithms.duct.Sampling< V extends Addable< V > >.Sampling().

values

V [] frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.values

private

The context in which sampling must occur.

Referenced by getValues(), readExternal(), VALUEmsg(), and writeExternal().

variables

String [] frodo2.algorithms.duct.VALUEmsg< V extends Addable< V > >.variables

private

The variable names.

Referenced by readExternal(), VALUEmsg(), and writeExternal().

---

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

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