Class EasyFullControl::RobotState

Nested Relationships

This class is a nested type of Class EasyFullControl.

Class Documentation

class RobotState

The current state of a robot, passed into EasyRobotUpdateHandle::update.

Public Functions

RobotState(std::string map_name, Eigen::Vector3d position, double battery_soc)

Constructor

Parameters:

  • map_name – [in] The name of the map the robot is currently on

  • position – [in] The current position of the robot

  • battery_soc – [in] the current battery level of the robot, specified by its state of charge as a fraction of its total charge capacity, i.e. a value from 0.0 to 1.0.

const std::string &map() const

Current map the robot is on.

void set_map(std::string value)

Set the current map the robot is on.

Eigen::Vector3d position() const

Current position of the robot.

void set_position(Eigen::Vector3d value)

Set the current position of the robot.

double battery_state_of_charge() const

Current state of charge of the battery, as a fraction from 0.0 to 1.0.

void set_battery_state_of_charge(double value)

Set the state of charge of the battery, as a fraction from 0.0 to 1.0.