shawn::MultipleCommunicationModel Class Reference

#include <multiple_communication_model.h>

Inheritance diagram for shawn::MultipleCommunicationModel:

[legend]

Collaboration diagram for shawn::MultipleCommunicationModel:

[legend]

List of all members.

Public Member Functions
construction / destruction
	MultipleCommunicationModel ()
virtual	~MultipleCommunicationModel ()
virtual void	init (void) throw ()
void	add_comm_model (CommunicationModel &) throw ()
void	set_default_comm_model (CommunicationModel &) throw ()
CommunicationModel interface
virtual bool	can_communicate_bidi (const Node &, const Node &) const throw ()
virtual bool	can_communicate_uni (const Node &, const Node &) const throw ()
virtual bool	exists_communication_upper_bound (void) const throw ()
	Returns whether communication_upper_bound() returns a useful value.
virtual double	communication_upper_bound (void) const throw ()
virtual bool	is_status_available_on_construction (void) const throw ()

---

Constructor & Destructor Documentation

shawn::MultipleCommunicationModel::MultipleCommunicationModel

(

)

virtual shawn::MultipleCommunicationModel::~MultipleCommunicationModel

(

)

[virtual]

---

Member Function Documentation

virtual void shawn::MultipleCommunicationModel::init

(

void

)

throw () [virtual]

called after world is setup and before first node is created. used by World

Reimplemented from shawn::CommunicationModel.

void shawn::MultipleCommunicationModel::add_comm_model

(

CommunicationModel &

)

throw ()

void shawn::MultipleCommunicationModel::set_default_comm_model

(

CommunicationModel &

)

throw ()

virtual bool shawn::MultipleCommunicationModel::can_communicate_bidi	(	const Node &	,
		const Node &
	)			const throw () [virtual]

Returns:

true iff can_communicate_uni(u,v) and can_communicate_uni(v,u), therefore, whether the two nodes may exchange messages.

Implements shawn::CommunicationModel.

virtual bool shawn::MultipleCommunicationModel::can_communicate_uni	(	const Node &	,
		const Node &
	)			const throw () [virtual]

Returns:

true if the first passed node can send messages to the second.

Warning:

currently, unidirectional links are unsupported. This method is therefore pretty much useless

Implements shawn::CommunicationModel.

virtual bool shawn::MultipleCommunicationModel::exists_communication_upper_bound

(

void

)

const throw () [virtual]

Returns whether communication_upper_bound() returns a useful value.

Implements shawn::CommunicationModel.

virtual double shawn::MultipleCommunicationModel::communication_upper_bound

(

void

)

const throw () [virtual]

If exists_communication_upper_bound(), nodes whose euclidean distance exceeds communication_upper_bound() can never communicate in any direction

Implements shawn::CommunicationModel.

virtual bool shawn::MultipleCommunicationModel::is_status_available_on_construction

(

void

)

const throw () [virtual]

Returns:

whether the status (i.e., whether two nodes can communicate) is available instantly when nodes are created.

Implements shawn::CommunicationModel.

---

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

• src/sys/comm_models/multiple_communication_model.h