wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P > Class Template Reference

Module that does nothing. More...

#include <localization_nop_module.h>

Inherits wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

List of all members.

Public Types
typedef OsModel_P	OsModel
typedef Radio_P	Radio
typedef SharedData_P	SharedData
typedef LocalizationNopModule < OsModel, Radio, SharedData >	self_type
typedef Radio::size_t	size_t
typedef Radio::node_id_t	node_id_t
typedef Radio::block_data_t	block_data_t
typedef SharedData::Neighborhood	Neighborhood
typedef SharedData::LocalCoordinateSystem	LocalCoordinateSystem
Public Member Functions
construction / destruction
	LocalizationNopModule ()
	~LocalizationNopModule ()
dummy methods - do nothing in nop module
void	enable (void)
void	receive (node_id_t from, size_t len, block_data_t *data)
void	work (void)
void	rollback (void)
module status info
bool	finished (void)
basic access to owner, observer, neighborhood and local coordinate system
void	set_shared_data (SharedData &shared_data)
	This method sets the shared data object, which can be accessed by all available modules.
SharedData &	shared_data (void)
Neighborhood &	neighborhood (void)
LocalCoordinateSystem &	local_coord_sys (void)

---

Detailed Description

template<typename OsModel_P, typename Radio_P, typename SharedData_P>
class wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >

Module that does nothing.

This module is just a place holder, that has no special task. It just returns, that it is finished, and is used, e.g., if there is no refinement algorithm selected.

---

Member Typedef Documentation

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef Radio::block_data_t wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::block_data_t

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef SharedData::LocalCoordinateSystem wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >::LocalCoordinateSystem [inherited]

Reimplemented in wiselib::LocalizationGpsFreeLcsModule< OsModel_P, Radio_P, Clock_P, Distance_P, Debug_P, SharedData_P >, and wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef SharedData::Neighborhood wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >::Neighborhood [inherited]

Reimplemented in wiselib::LocalizationLaterationModule< OsModel_P, Radio_P, Debug_P, SharedData_P, Arithmatic_P >, wiselib::LocalizationMinMaxModule< OsModel_P, Radio_P, Debug_P, SharedData_P, Arithmatic_P >, and wiselib::LocalizationIterLaterationModule< OsModel_P, Radio_P, Distance_P, Debug_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef Radio::node_id_t wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::node_id_t

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef OsModel_P wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::OsModel

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef Radio_P wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::Radio

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef LocalizationNopModule<OsModel, Radio, SharedData> wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::self_type

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef SharedData_P wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::SharedData

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

typedef Radio::size_t wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::size_t

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >.

---

Constructor & Destructor Documentation

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::LocalizationNopModule

(

)

[inline]

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::~LocalizationNopModule

(

)

[inline]

---

Member Function Documentation

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

void wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::enable

(

void

)

[inline]

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

bool wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::finished

(

void

)

[inline]

Returns:

true

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

LocalCoordinateSystem& wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >::local_coord_sys

(

void

)

[inline, inherited]

Returns:

Writable shared LocalizationLocalCoordinateSystem.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

Neighborhood& wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >::neighborhood

(

void

)

[inline, inherited]

Returns:

Writable shared LocalizationNeighborhood.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

void wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::receive	(	node_id_t	from,
		size_t	len,
		block_data_t *	data
	)		[inline]

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

void wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::rollback

(

void

)

[inline]

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

void wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >::set_shared_data

(

SharedData &

shared_data

)

[inline, inherited]

This method sets the shared data object, which can be accessed by all available modules.

Parameters:

LocalizationSharedData

Shared data between all modules.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

SharedData& wiselib::LocalizationModule< OsModel_P, Radio_P, SharedData_P >::shared_data

(

void

)

[inline, inherited]

Returns:

LocalizationSharedData shared by all modules.

writable LocalizationSharedData shared by all modules.

template<typename OsModel_P , typename Radio_P , typename SharedData_P >

void wiselib::LocalizationNopModule< OsModel_P, Radio_P, SharedData_P >::work

(

void

)

[inline]

---

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

• wiselib.testing/algorithms/localization/distance_based/modules/localization_nop_module.h