wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P > Class Template Reference

Module implementing GPS-free Network Coordinate System building. More...

#include <localization_gpsfree_ncs_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 Clock_P	Clock
typedef Debug_P	Debug
typedef SharedData_P	SharedData
typedef LocalizationGpsFreeNcsModule < OsModel, Radio, Clock, Debug, SharedData >	self_type
typedef LocalizationModule < OsModel, Radio, SharedData >	base_type
typedef Radio::size_t	size_t
typedef Radio::node_id_t	node_id_t
typedef Radio::block_data_t	block_data_t
typedef Clock_P::time_t	time_t
typedef SharedData::LocalCoordinateSystem	LocalCoordinateSystem
typedef LocalCoordinateSystem::CorrectionData	CorrectionData
typedef LocalizationGpsFreeNcsLcsMessage < OsModel, Radio, LocalCoordinateSystem >	GpsFreeNcsLcsMessage
typedef SharedData::Neighborhood::NeighborhoodIterator	NeighborhoodIterator
typedef SharedData::Neighborhood	Neighborhood
Public Member Functions
void	rollback (void)
void	init (Radio &radio, Clock &clock, Debug &debug, SharedData &shared_data)
void	set_root_node (bool root)
bool	set_root_node (void)
construction / destruction
	LocalizationGpsFreeNcsModule ()
	~LocalizationGpsFreeNcsModule ()
standard methods startup/simulation steps
void	receive (node_id_t from, size_t len, block_data_t *data)
	Handling of GPS-free-NCS-Messages.
void	work (void)
	Check, whether state can be set to finished or not.
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)
Protected Member Functions
processing gpsfree ncs messages
bool	process_gpsfree_ncs_lcs_message (node_id_t from, size_t len, block_data_t *data)

---

Detailed Description

template<typename OsModel_P, typename Radio_P, typename Clock_P, typename Debug_P, typename SharedData_P>
class wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >

Module implementing GPS-free Network Coordinate System building.

...

---

Member Typedef Documentation

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef LocalizationModule<OsModel, Radio, SharedData> wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::base_type

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Radio::block_data_t wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::block_data_t

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Clock_P wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::Clock

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef LocalCoordinateSystem::CorrectionData wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::CorrectionData

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Debug_P wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::Debug

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef LocalizationGpsFreeNcsLcsMessage<OsModel, Radio, LocalCoordinateSystem> wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::GpsFreeNcsLcsMessage

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef SharedData::LocalCoordinateSystem wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::LocalCoordinateSystem

Reimplemented from wiselib::LocalizationModule< OsModel_P, Radio_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 Clock_P , typename Debug_P , typename SharedData_P >

typedef SharedData::Neighborhood::NeighborhoodIterator wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::NeighborhoodIterator

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Radio::node_id_t wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::node_id_t

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef OsModel_P wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::OsModel

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Radio_P wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::Radio

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef LocalizationGpsFreeNcsModule<OsModel, Radio, Clock, Debug, SharedData> wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::self_type

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef SharedData_P wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::SharedData

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Radio::size_t wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::size_t

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

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

typedef Clock_P::time_t wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::time_t

---

Constructor & Destructor Documentation

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::LocalizationGpsFreeNcsModule

(

)

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::~LocalizationGpsFreeNcsModule

(

)

---

Member Function Documentation

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

bool wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::finished

(

void

)

Returns:

true, if module is finished. false otherwise

See also:

LocalizationModule::finished()

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

void wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::init	(	Radio &	radio,
		Clock &	clock,
		Debug &	debug,
		SharedData &	shared_data
	)		[inline]

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 Clock_P , typename Debug_P , typename SharedData_P >

bool wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::process_gpsfree_ncs_lcs_message	(	node_id_t	from,
		size_t	len,
		block_data_t *	data
	)		[protected]

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

void wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::receive	(	node_id_t	from,
		size_t	len,
		block_data_t *	data
	)

Handling of GPS-free-NCS-Messages.

See also:

LocalizationModule::process_message()

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

void wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::rollback

(

void

)

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

bool wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::set_root_node

(

void

)

[inline]

template<typename OsModel_P , typename Radio_P , typename Clock_P , typename Debug_P , typename SharedData_P >

void wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::set_root_node

(

bool

root

)

[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 Clock_P , typename Debug_P , typename SharedData_P >

void wiselib::LocalizationGpsFreeNcsModule< OsModel_P, Radio_P, Clock_P, Debug_P, SharedData_P >::work

(

void

)

Check, whether state can be set to finished or not.

Moreover, send local coordinate system, compute correction angle and build network coordinate system.

See also:

LocalizationModule::work()

---

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

• wiselib.testing/algorithms/localization/distance_based/modules/position/localization_gpsfree_ncs_module.h