SensorsIface.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2012 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16*/
17#ifndef _GAZEBO_SENSORSIFACE_HH_
18#define _GAZEBO_SENSORSIFACE_HH_
19
20#include <string>
21#include <sdf/sdf.hh>
23#include "gazebo/util/system.hh"
24
25namespace gazebo
26{
27 namespace sensors
28 {
31
34 GZ_SENSORS_VISIBLE
35 bool load();
36
42 GZ_SENSORS_VISIBLE
43 std::string create_sensor(sdf::ElementPtr _elem,
44 const std::string &_worldName, const std::string &_parentName,
45 uint32_t _parentId);
46
49 GZ_SENSORS_VISIBLE
50 void remove_sensor(const std::string &_sensorName);
51
55 GZ_SENSORS_VISIBLE
56 void run_once(bool _force = false);
57
59 GZ_SENSORS_VISIBLE
61
63 GZ_SENSORS_VISIBLE
64 void stop();
65
68 GZ_SENSORS_VISIBLE
69 bool init();
70
73 GZ_SENSORS_VISIBLE
74 bool fini();
75
78 GZ_SENSORS_VISIBLE
80
92 GZ_SENSORS_VISIBLE
93 SensorPtr get_sensor(const std::string &_name);
94
96 GZ_SENSORS_VISIBLE
97 void disable();
98
100 GZ_SENSORS_VISIBLE
101 void enable();
102
106 bool running();
108 }
109}
110#endif
sensors
Definition SensorManager.hh:35
Forward declarations and typedefs for sensors.
void run_threads()
Run sensors in a threads. This is a non-blocking call.
void remove_sensor(const std::string &_sensorName)
Remove a sensor by name.
GAZEBO_VISIBLE bool running()
Return true if the manager is running.
bool load()
Load the sensor library.
void run_once(bool _force=false)
Run the sensor generation one step.
void enable()
Enable sensors.
SensorPtr get_sensor(const std::string &_name)
Get a sensor using by name.
std::string create_sensor(sdf::ElementPtr _elem, const std::string &_worldName, const std::string &_parentName, uint32_t _parentId)
Create a sensor using SDF.
void stop()
Stop the sensor generation loop.
void disable()
Disable sensors.
bool fini()
shutdown the sensor generation loop.
bool remove_sensors()
Remove all sensors.
bool init()
initialize the sensor generation loop.
std::shared_ptr< Sensor > SensorPtr
Definition SensorTypes.hh:64
Forward declarations for the common classes.
Definition Animation.hh:27
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition system.hh:59