Display NavSat messages coming through a Gazebo Transport topic on top of a map. More...

#include <NavSatMap.hh>

Public Slots
void	OnRefresh ()
	Callback when refresh button is pressed. More...

void	OnTopic (const QString _topic)
	Callback when a new topic is chosen on the combo box. More...

Signals
void	newMessage (double _latitudeDeg, double _longitudeDeg)
	Notify that a new message has been received. More...

void	TopicListChanged ()
	Notify that topic list has changed. More...

Public Member Functions
	NavSatMap ()
	Constructor. More...

virtual	~NavSatMap ()
	Destructor. More...

virtual void	LoadConfig (const tinyxml2::XMLElement *_pluginElem)
	Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations. More...

Q_INVOKABLE void	SetTopicList (const QStringList &_topicList)
	Set the topic list. More...

Q_INVOKABLE QStringList	TopicList () const
	Get the list of topics publishing NavSat messages. More...

Public Member Functions inherited from Plugin
	Plugin ()
	Constructor. More...

virtual	~Plugin ()
	Destructor. More...

QQuickItem *	CardItem () const
	Get the card item which contains this plugin. The item is generated the first time this function is run. More...

virtual std::string	ConfigStr ()
	Get the configuration XML as a string. More...

QQmlContext *	Context () const
	Get the QML context where the plugin was created. More...

bool	DeleteLaterRequested () const
	Get the value of the the `delete_later` element from the configuration file, which defaults to false. More...

void	Load (const tinyxml2::XMLElement *_pluginElem)
	Load the plugin with a configuration file. This loads the default parameters and then calls LoadConfig(), which should be overridden to load custom parameters. More...

QQuickItem *	PluginItem () const
	Get the plugin item. More...

void	PostParentChanges ()
	Apply changes which should come after the plugin already has a parent. More...

virtual std::string	Title () const
	Get title. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Properties
QStringList	topicList
	Topic list. More...

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from Plugin
void	DeleteLater ()
	Wait until the plugin has a parent, then close and delete the parent. More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from Plugin
std::string	configStr
	XML configuration. More...

std::string	title = ""
	Title to be displayed on top of plugin. More...

Detailed Description

Display NavSat messages coming through a Gazebo Transport topic on top of a map.

Configuration

<topic> : Set the topic to receive NavSat messages. <topic_picker> : Whether to show the topic picker, true by default. If this is false, a <topic> must be specified.

Constructor & Destructor Documentation

◆ NavSatMap()

NavSatMap ( )

Constructor.

◆ ~NavSatMap()

virtual ~NavSatMap ( )

virtual

Destructor.

Member Function Documentation

◆ LoadConfig()

virtual void LoadConfig ( const tinyxml2::XMLElement * _pluginElem )

virtual

Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations.

Called when a plugin is first created. This function should not be blocking.

See also: Load

Parameters

[in] _pluginElem Element containing configuration

Reimplemented from Plugin.

◆ newMessage

void newMessage	(	double	_latitudeDeg,
		double	_longitudeDeg
	)

signal

Notify that a new message has been received.

Parameters

[in]	_latitudeDeg	Latitude in degrees
[in]	_longitudeDeg	Longitude in degrees

◆ OnRefresh

void OnRefresh ( )

slot

Callback when refresh button is pressed.

◆ OnTopic

void OnTopic ( const QString _topic )

slot

Callback when a new topic is chosen on the combo box.

◆ SetTopicList()

Q_INVOKABLE void SetTopicList ( const QStringList & _topicList )

Set the topic list.

Parameters

[in] _topicList List of topics

◆ TopicList()

Q_INVOKABLE QStringList TopicList ( ) const

Get the list of topics publishing NavSat messages.

Returns: List of topics

◆ TopicListChanged

void TopicListChanged ( )

signal

Notify that topic list has changed.

Property Documentation

◆ topicList

QStringList topicList

readwrite

Topic list.

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

NavSatMap.hh

Gazebo Gui

API Reference

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Configuration

Constructor & Destructor Documentation

◆ NavSatMap()

◆ ~NavSatMap()

Member Function Documentation

◆ LoadConfig()

◆ newMessage

◆ OnRefresh

◆ OnTopic

◆ SetTopicList()

◆ TopicList()

◆ TopicListChanged

Property Documentation

◆ topicList