Main MRPT website > C++ reference for MRPT 1.4.0
CWirelessPower.h
Go to the documentation of this file.
1/* +---------------------------------------------------------------------------+
2 | Mobile Robot Programming Toolkit (MRPT) |
3 | http://www.mrpt.org/ |
4 | |
5 | Copyright (c) 2005-2016, Individual contributors, see AUTHORS file |
6 | See: http://www.mrpt.org/Authors - All rights reserved. |
7 | Released under BSD License. See details in http://www.mrpt.org/License |
8 +---------------------------------------------------------------------------+ */
9#ifndef CWirelessPower_H
10#define CWirelessPower_H
11
15
16namespace mrpt
17{
18 namespace hwdrivers
19 {
20 /** This class implements a wireless power probe.
21 * \sa mrpt::maps::CWirelessPowerGridMap2D, mrpt::obs::CObservationWirelessPower
22 * \ingroup mrpt_hwdrivers_grp
23 */
25 {
27
28 private:
29 /** SSID of the WiFi network
30 */
31 std::string ssid;
32
33 /** GUID of the WiFi interface
34 */
35 std::string guid;
36
37 /** Handle to the WLAN server (Windows)
38 */
39 void* hClient;
40
41 /** Poses
42 */
43 float pose_x, pose_y, pose_z, pose_yaw, pose_pitch, pose_roll;
44
45 public:
46 /** Default constructor.
47 */
49 virtual ~CWirelessPower(){};
50
51 /** Set the SSID and GUID of the target network.
52 * \exception std::exception In case there is a failure
53 * \param ssid_ SSID of the target network
54 * \param guid_ GUID of the network interface
55 */
56 void setNet(std::string ssid_, std::string guid_);
57
58 void doProcess();
60 const mrpt::utils::CConfigFileBase &configSource,
61 const std::string &section);
62
63 /** Gets a list of the interfaces
64 * \exception std::exception In case there is a failure
65 * \return std::vector returns the identifiers (GUID) of the available interfaces
66 */
67 std::vector<std::string> ListInterfaces();
68
69
70 /** Gets the power of a given network
71 * \exception std::exception In case there is a failure
72 * \return Returns the power (0-100).
73 */
74 int GetPower();
75
76
77 /** Gets the power of a given network as a timestamped observation
78 * NOTE: Deprecated, use getObservations instead. See CGenericSensor documentation. This function is kept for internal use of the module
79 * \return Returns true if the observation was correct, and false otherwise
80 * \sa mrpt::hwdrivers::CGenericSensor
81 */
82
84
85
86 /** Gets a list of the networks available for an interface
87 * \exception std::exception In case there is a failure
88 * \return std::vector returns handles to the available networks of a given interface
89 */
90 std::vector<std::string> ListNetworks();
91
92 }; // End of class def.
93
94 } // End of namespace
95} // End of namespace
96#endif
#define DEFINE_GENERIC_SENSOR(class_name)
This declaration must be inserted in all CGenericSensor classes definition, within the class declarat...
A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...
This class implements a wireless power probe.
void * hClient
Handle to the WLAN server (Windows)
std::vector< std::string > ListNetworks()
Gets a list of the networks available for an interface.
std::vector< std::string > ListInterfaces()
Gets a list of the interfaces.
int GetPower()
Gets the power of a given network.
void loadConfig_sensorSpecific(const mrpt::utils::CConfigFileBase &configSource, const std::string &section)
Loads specific configuration for the device from a given source of configuration parameters,...
void setNet(std::string ssid_, std::string guid_)
Set the SSID and GUID of the target network.
void doProcess()
This method will be invoked at a minimum rate of "process_rate" (Hz)
bool getObservation(mrpt::obs::CObservationWirelessPower &outObservation)
Gets the power of a given network as a timestamped observation NOTE: Deprecated, use getObservations ...
std::string guid
GUID of the WiFi interface.
std::string ssid
SSID of the WiFi network.
CWirelessPower()
Default constructor.
This represents a measurement of the wireless strength perceived by the robot.
This class allows loading and storing values and vectors of different types from a configuration text...
#define HWDRIVERS_IMPEXP
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.



Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Thu Dec 14 16:54:58 UTC 2023