A message containing statistics about messages sent. More...

Inheritance diagram for frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage:

[legend]

Public Member Functions
	ComStatsMessage ()
	Empty constructor used for externalization.
	ComStatsMessage (Serializable sender, HashMap< MessageType, Integer > msgNbrs, HashMap< Object, Integer > msgNbrsSent, HashMap< MessageType, Long > msgSizes, HashMap< Object, Long > msgSizesSent, HashMap< MessageType, Long > maxMsgSizes)
	Constructor.
Object	getSender ()
void	setSender (Serializable sender)
	Sets the sender agent.
HashMap< MessageType, Integer >	getMsgNbrs ()
HashMap< MessageType, Long >	getMsgSizes ()
HashMap< MessageType, Long >	getMaxMsgSizes ()
HashMap< Object, Integer >	getMsgNbrsSent ()
void	setMsgNbrsSent (HashMap< Object, Integer > msgNbrsSent)
	Sets the number of messages sent to each other agent.
HashMap< Object, Long >	getMsgSizesSent ()
void	setMsgSizesSent (HashMap< Object, Long > msgSizesSent)
	Sets the amount of information sent to each other agent, in bytes.
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
String	toString ()
Public Member Functions inherited from frodo2.communication.MessageWith3Payloads< T1 extends Serializable, T2 extends Serializable, T3 extends Serializable >
	MessageWith3Payloads ()
	Empty constructor.
	MessageWith3Payloads (MessageType type, T1 payload1, T2 payload2, T3 payload3)
	Constructor.
MessageWith3Payloads< T1, T2, T3 >	clone ()
T1	getPayload1 ()
void	setPayload1 (T1 payload1)
T2	getPayload2 ()
void	setPayload2 (T2 payload2)
T3	getPayload3 ()
void	setPayload3 (T3 payload3)
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 final MessageType	COM_STATS_MSG_TYPE = MessageType.SYSTEM.newChild("AgentInterface", "Communication statistics")
	The type of this message.

Private Attributes
Serializable	sender
	The sender agent.
HashMap< Object, Integer >	msgNbrsSent
	The number of messages sent to each other agent.
HashMap< Object, Long >	msgSizesSent
	The amount of information sent to each other agent, in bytes.

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

Detailed Description

A message containing statistics about messages sent.

Author: Thomas Leaute

Constructor & Destructor Documentation

◆ ComStatsMessage() [1/2]

frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.ComStatsMessage ( )

Empty constructor used for externalization.

◆ ComStatsMessage() [2/2]

frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.ComStatsMessage	(	Serializable	sender,
		HashMap< MessageType, Integer >	msgNbrs,
		HashMap< Object, Integer >	msgNbrsSent,
		HashMap< MessageType, Long >	msgSizes,
		HashMap< Object, Long >	msgSizesSent,
		HashMap< MessageType, Long >	maxMsgSizes )

Constructor.

Parameters

sender	the sender agent
msgNbrs	for each message type, the number of messages sent of that type
msgNbrsSent	the number of messages sent to each other agent
msgSizes	for each message type, the total amount of information sent in messages of that type, in bytes
msgSizesSent	the amount of information sent to each other agent, in bytes
maxMsgSizes	for each message type, the size (in bytes) of the largest message of this type

References COM_STATS_MSG_TYPE, msgNbrsSent, msgSizesSent, and sender.

Member Function Documentation

◆ getMaxMsgSizes()

HashMap< MessageType, Long > frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.getMaxMsgSizes ( )

Returns: for each message type, the size (in bytes) of the largest message of this type

References frodo2.communication.MessageWith3Payloads< T1 extends Serializable, T2 extends Serializable, T3 extends Serializable >.getPayload3().

Referenced by toString().

Here is the call graph for this function:

◆ getMsgNbrs()

HashMap< MessageType, Integer > frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.getMsgNbrs ( )

Returns: for each message type, the number of messages sent of that type

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

Referenced by toString().

Here is the call graph for this function:

◆ getMsgNbrsSent()

HashMap< Object, Integer > frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.getMsgNbrsSent ( )

Returns: the number of messages sent to each other agent

References msgNbrsSent.

◆ getMsgSizes()

HashMap< MessageType, Long > frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.getMsgSizes ( )

Returns: for each message type, the total amount of information sent in messages of that type, in bytes

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

Referenced by toString().

Here is the call graph for this function:

◆ getMsgSizesSent()

HashMap< Object, Long > frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.getMsgSizesSent ( )

Returns: the amount of information sent to each other agent, in bytes

References msgSizesSent.

◆ getSender()

Object frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.getSender ( )

Returns: the sender agent

References sender.

◆ readExternal()

void frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.readExternal ( ObjectInput in ) throws IOException, ClassNotFoundException

See also: MessageWith3Payloads.readExternal(java.io.ObjectInput)

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

◆ setMsgNbrsSent()

void frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.setMsgNbrsSent ( HashMap< Object, Integer > msgNbrsSent )

Sets the number of messages sent to each other agent.

Parameters

msgNbrsSent the number of messages sent

References msgNbrsSent.

◆ setMsgSizesSent()

void frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.setMsgSizesSent ( HashMap< Object, Long > msgSizesSent )

Sets the amount of information sent to each other agent, in bytes.

Parameters

msgSizesSent the amount of information sent

References msgSizesSent.

◆ setSender()

void frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.setSender ( Serializable sender )

Sets the sender agent.

Parameters

sender the sender agent

References sender.

◆ toString()

String frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.toString ( )

See also: MessageWith3Payloads.toString()

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

References getMaxMsgSizes(), getMsgNbrs(), getMsgSizes(), and frodo2.communication.Message.getType().

Here is the call graph for this function:

◆ writeExternal()

void frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.writeExternal ( ObjectOutput out ) throws IOException

See also: MessageWith3Payloads.writeExternal(java.io.ObjectOutput)

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

Member Data Documentation

◆ COM_STATS_MSG_TYPE

final MessageType frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.COM_STATS_MSG_TYPE = MessageType.SYSTEM.newChild("AgentInterface", "Communication statistics")

static

The type of this message.

Referenced by ComStatsMessage(), and frodo2.algorithms.AgentFactory< V extends Addable< V >, U extends Addable< U > >.getMsgTypes().

◆ msgNbrsSent

HashMap<Object, Integer> frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.msgNbrsSent

private

The number of messages sent to each other agent.

Referenced by ComStatsMessage(), getMsgNbrsSent(), and setMsgNbrsSent().

◆ msgSizesSent

HashMap<Object, Long> frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.msgSizesSent

private

The amount of information sent to each other agent, in bytes.

Referenced by ComStatsMessage(), getMsgSizesSent(), and setMsgSizesSent().

◆ sender

Serializable frodo2.algorithms.AgentInterface< V extends Addable< V > >.ComStatsMessage.sender

private

The sender agent.

Referenced by ComStatsMessage(), getSender(), and setSender().

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

src/frodo2/algorithms/AgentInterface.java

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComStatsMessage() [1/2]

◆ ComStatsMessage() [2/2]

Member Function Documentation

◆ getMaxMsgSizes()

◆ getMsgNbrs()

◆ getMsgNbrsSent()

◆ getMsgSizes()

◆ getMsgSizesSent()

◆ getSender()

◆ readExternal()

◆ setMsgNbrsSent()

◆ setMsgSizesSent()

◆ setSender()

◆ toString()

◆ writeExternal()

Member Data Documentation

◆ COM_STATS_MSG_TYPE

◆ msgNbrsSent

◆ msgSizesSent

◆ sender