EnvironmentLoader Class Reference

A GUI plugin for a user to load an Environment component into the ECM on a live simulation. More...

#include <EnvironmentLoader.hh>

Signals
void	DataPathChanged ()
	Notify that the path to the data file (potentially) changed.
void	DimensionListChanged ()
	Notify that the list of dimensions has changed.
void	IsConfiguredChanged ()
	Notify configuration status changed.
void	ReferenceChanged () const
	Notify the spatial reference has changed.
void	TimeIndexChanged () const
	Notify the time dimension index has changed.
void	UnitChanged () const
	Notify the unit index has changed.
void	XIndexChanged () const
	Notify the x dimension index has changed.
void	YIndexChanged () const
	Notify the y dimension index has changed.
void	ZIndexChanged () const
	Notify the z dimension index has changed.

Public Member Functions
	EnvironmentLoader ()
	Constructor.
	~EnvironmentLoader () override
	Destructor.
Q_INVOKABLE QString	DataPath () const
	Get path to the data file to be loaded.
Q_INVOKABLE QStringList	DimensionList () const
	Get dimensions available in the data file.
Q_INVOKABLE bool	IsConfigured () const
	Get configuration status.
void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
Q_INVOKABLE QString	Reference () const
	Get spatial reference.
Q_INVOKABLE QStringList	ReferenceList () const
	Get supported spatial references.
Q_INVOKABLE void	ScheduleLoad ()
	Schedule an update.
Q_INVOKABLE void	SetDataPath (QString _dataPath)
	Set the path to the data file to be loaded.
Q_INVOKABLE void	SetDataUrl (QUrl _dataUrl)
	Set the URL pointing to the data file to be loaded.
Q_INVOKABLE void	SetReference (QString _reference)
	Set spatial reference.
Q_INVOKABLE void	SetTimeIndex (int _timeIndex)
	Set index of the time dimension in the list.
Q_INVOKABLE void	SetUnit (QString _unit)
	Set index of the unit in the list.
Q_INVOKABLE void	SetXIndex (int _xIndex)
	Set index of the x dimension in the list.
Q_INVOKABLE void	SetYIndex (int _yIndex)
	Set index of the y dimension in the list.
Q_INVOKABLE void	SetZIndex (int _zIndex)
	Set index of the z dimension in the list.
Q_INVOKABLE int	TimeIndex () const
	Get index of the time dimension in the list.
Q_INVOKABLE QString	Unit () const
	Get index of the unit in the list.
Q_INVOKABLE QStringList	UnitList () const
	Get available units.
void	Update (const UpdateInfo &, EntityComponentManager &_ecm) override
	Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots.
Q_INVOKABLE int	XIndex () const
	Get index of the x dimension in the list.
Q_INVOKABLE int	YIndex () const
	Get index of the y dimension in the list.
Q_INVOKABLE int	ZIndex () const
	Get index of the z dimension in the list.
Public Member Functions inherited from Plugin
	Plugin ()
virtual	~Plugin ()
QQuickItem *	CardItem () const
virtual std::string	ConfigStr ()
QQmlContext *	Context () const
bool	DeleteLaterRequested () const
void	Load (const tinyxml2::XMLElement *_pluginElem)
QQuickItem *	PluginItem () const
void	PostParentChanges ()
virtual std::string	Title () const

Properties
bool	configured
	Configuration ready.
QString	dataPath
	Data path.
QStringList	dimensionList
	Dimension list.
QString	reference
	Spatial reference.
QStringList	referenceList
	Spatial reference type list.
int	timeIndex
	Time index.
QString	unit
	Unit list.
QStringList	unitList
	Unit list.
int	xIndex
	X dimension.
int	yIndex
	Y dimension.
int	zIndex
	Z dimension.

Additional Inherited Members
Protected Member Functions inherited from Plugin
void	DeleteLater ()
Protected Attributes inherited from Plugin
std::string	configStr
std::string	title

Detailed Description

A GUI plugin for a user to load an Environment component into the ECM on a live simulation.

gz/sim/systems/EnvironmentLoader.hh

Constructor & Destructor Documentation

EnvironmentLoader()

EnvironmentLoader

(

)

Constructor.

~EnvironmentLoader()

~EnvironmentLoader ( )

override

Destructor.

Member Function Documentation

DataPath()

Q_INVOKABLE QString DataPath

(

)

const

Get path to the data file to be loaded.

DataPathChanged

void DataPathChanged ( )

signal

Notify that the path to the data file (potentially) changed.

DimensionList()

Q_INVOKABLE QStringList DimensionList

(

)

const

Get dimensions available in the data file.

DimensionListChanged

void DimensionListChanged ( )

signal

Notify that the list of dimensions has changed.

IsConfigured()

Q_INVOKABLE bool IsConfigured

(

)

const

Get configuration status.

IsConfiguredChanged

void IsConfiguredChanged ( )

signal

Notify configuration status changed.

LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem )

overridevirtual

Reimplemented from Plugin.

Reference()

Q_INVOKABLE QString Reference

(

)

const

Get spatial reference.

ReferenceChanged

void ReferenceChanged ( ) const

signal

Notify the spatial reference has changed.

ReferenceList()

Q_INVOKABLE QStringList ReferenceList

(

)

const

Get supported spatial references.

ScheduleLoad()

Q_INVOKABLE void ScheduleLoad

(

)

Schedule an update.

SetDataPath()

Q_INVOKABLE void SetDataPath

(

QString

_dataPath

)

Set the path to the data file to be loaded.

SetDataUrl()

Q_INVOKABLE void SetDataUrl

(

QUrl

_dataUrl

)

Set the URL pointing to the data file to be loaded.

SetReference()

Q_INVOKABLE void SetReference

(

QString

_reference

)

Set spatial reference.

SetTimeIndex()

Q_INVOKABLE void SetTimeIndex

(

int

_timeIndex

)

Set index of the time dimension in the list.

SetUnit()

Q_INVOKABLE void SetUnit

(

QString

_unit

)

Set index of the unit in the list.

SetXIndex()

Q_INVOKABLE void SetXIndex

(

int

_xIndex

)

Set index of the x dimension in the list.

SetYIndex()

Q_INVOKABLE void SetYIndex

(

int

_yIndex

)

Set index of the y dimension in the list.

SetZIndex()

Q_INVOKABLE void SetZIndex

(

int

_zIndex

)

Set index of the z dimension in the list.

TimeIndex()

Q_INVOKABLE int TimeIndex

(

)

const

Get index of the time dimension in the list.

TimeIndexChanged

void TimeIndexChanged ( ) const

signal

Notify the time dimension index has changed.

Unit()

Q_INVOKABLE QString Unit

(

)

const

Get index of the unit in the list.

UnitChanged

void UnitChanged ( ) const

signal

Notify the unit index has changed.

UnitList()

Q_INVOKABLE QStringList UnitList

(

)

const

Get available units.

Update()

void Update ( const UpdateInfo &  _info, EntityComponentManager &  _ecm  )

overridevirtual

Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots.

Parameters

[in]	_info	Current simulation information, such as time.
[in]	_ecm	Mutable reference to the ECM, so the system can read and write entities and their components.

Reimplemented from GuiSystem.

XIndex()

Q_INVOKABLE int XIndex

(

)

const

Get index of the x dimension in the list.

XIndexChanged

void XIndexChanged ( ) const

signal

Notify the x dimension index has changed.

YIndex()

Q_INVOKABLE int YIndex

(

)

const

Get index of the y dimension in the list.

YIndexChanged

void YIndexChanged ( ) const

signal

Notify the y dimension index has changed.

ZIndex()

Q_INVOKABLE int ZIndex

(

)

const

Get index of the z dimension in the list.

ZIndexChanged

void ZIndexChanged ( ) const

signal

Notify the z dimension index has changed.

Property Documentation

configured

bool configured

read

Configuration ready.

dataPath

QString dataPath

readwrite

Data path.

dimensionList

QStringList dimensionList

read

Dimension list.

reference

QString reference

readwrite

Spatial reference.

referenceList

QStringList referenceList

read

Spatial reference type list.

timeIndex

int timeIndex

readwrite

Time index.

unit

QString unit

readwrite

Unit list.

unitList

QStringList unitList

read

Unit list.

xIndex

int xIndex

readwrite

X dimension.

yIndex

int yIndex

readwrite

Y dimension.

zIndex

int zIndex

readwrite

Z dimension.

---

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

• EnvironmentLoader.hh