travesim::RobotState Class Reference

Data structure to hold the state of a robot in the simulation. More...

#include "robot_state.hpp"

Inheritance diagram for travesim::RobotState:

Collaboration diagram for travesim::RobotState:

Public Member Functions
	RobotState ()
	Construct a new Robot State object. More...
	RobotState (Vector2D position, double angular_position, Vector2D velocity, double angular_velocity, bool is_yellow, int id)
	Construct a new Robot State object. More...
	RobotState (EntityState *entity_state, bool is_yellow, int id)
	Construct a new Robot State object from EntityState object. More...
Public Member Functions inherited from travesim::EntityState
	EntityState ()
	Construct a new Entity State object. More...
	EntityState (Vector2D position, double angular_position, Vector2D velocity, double angular_velocity)
	Construct a new Entity State object. More...
virtual	~EntityState ()=default

Public Attributes
bool	is_yellow
	Public attributes. More...
int	id
Public Attributes inherited from travesim::EntityState
Vector2D	position
	Position in meters. More...
Vector2D	velocity
	Velocity in m/s. More...
double	angular_position
	Angular position in radinans. More...
double	angular_velocity
	Angular velocity in rad/s. More...

Friends
std::ostream &	operator<< (std::ostream &output, const RobotState &robot_state)
	Output stream operator overloading. More...

Detailed Description

Data structure to hold the state of a robot in the simulation.

Definition at line 23 of file robot_state.hpp.

Constructor & Destructor Documentation

RobotState() [1/3]

travesim::RobotState::RobotState

(

)

Construct a new Robot State object.

Definition at line 20 of file robot_state.cpp.

                       : RobotState(Vector2D(), 0, Vector2D(), 0, true, 0) {
}

RobotState() [2/3]

travesim::RobotState::RobotState	(	Vector2D	position,
		double	angular_position,
		Vector2D	velocity,
		double	angular_velocity,
		bool	is_yellow,
		int	id
	)

Construct a new Robot State object.

Parameters

position	Position in meters
angular_position	Angular position in radinans
velocity	Velocity in m/s
angular_velocity	Angular velocity in rad/s
is_yellow	Wheter the robot is from the yellow team or not
id	Identification number

Definition at line 23 of file robot_state.cpp.

                                               :
    EntityState(position, angular_position, velocity, angular_velocity) {
    this->is_yellow = is_yellow;
    this->id = id;
}

References id, and is_yellow.

RobotState() [3/3]

travesim::RobotState::RobotState	(	EntityState *	entity_state,
		bool	is_yellow,
		int	id
	)

Construct a new Robot State object from EntityState object.

Parameters

entity_state	Object to be promoted
is_yellow	Wheter the robot is from the yellow team or not
id	Identification number

Definition at line 30 of file robot_state.cpp.

                                                                        :
    EntityState(entity_state->position,
                entity_state->angular_position,
                entity_state->velocity,
                entity_state->angular_velocity) {
    this->is_yellow = is_yellow;
    this->id = id;
}

References id, and is_yellow.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  output, const RobotState &  robot_state  )

friend

Output stream operator overloading.

Definition at line 39 of file robot_state.cpp.

                                                                           {
    output << std::fixed << std::setprecision(PRINTING_DECIMAL_PRECISION);

    output << "TEAM YELLOW: " << robot_state.is_yellow << std::endl;
    output << "ROBOT ID: " << robot_state.id << std::endl;

    output << "POSITION: ";
    output << robot_state.position << " | ";
    output << "THETA: "<< std::setw(PRINTING_MIN_WIDTH) << robot_state.angular_position << std::endl;

    output << "VELOCITY: ";
    output << robot_state.velocity << " | ";
    output << "THETA: "<< std::setw(PRINTING_MIN_WIDTH) << robot_state.angular_velocity << std::endl;

    return output;
}

Member Data Documentation

id

int travesim::RobotState::id

Definition at line 65 of file robot_state.hpp.

is_yellow

bool travesim::RobotState::is_yellow

Public attributes.

Definition at line 64 of file robot_state.hpp.

---

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

• include/travesim_adapters/data/robot_state.hpp
• src/lib/data/robot_state.cpp