travesim::EntityState Class Reference

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

#include "entity_state.hpp"

Inheritance diagram for travesim::EntityState:

Collaboration diagram for travesim::EntityState:

Public Member Functions
	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
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 EntityState &entity_state)
	Output stream operator overloading. More...

Detailed Description

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

Definition at line 56 of file entity_state.hpp.

Constructor & Destructor Documentation

EntityState() [1/2]

travesim::EntityState::EntityState

(

)

Construct a new Entity State object.

Definition at line 46 of file entity_state.cpp.

                         : EntityState(Vector2D(), 0.0, Vector2D(), 0.0) {
}

EntityState() [2/2]

travesim::EntityState::EntityState	(	Vector2D	position,
		double	angular_position,
		Vector2D	velocity,
		double	angular_velocity
	)

Construct a new Entity 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

Definition at line 49 of file entity_state.cpp.

                                                                                                               {
    this->position = position;
    this->angular_position = angular_position;
    this->velocity = velocity;
    this->angular_velocity = angular_velocity;
}

References angular_position, angular_velocity, position, and velocity.

~EntityState()

virtual travesim::EntityState::~EntityState ( )

virtualdefault

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  output, const EntityState &  entity_state  )

friend

Output stream operator overloading.

Definition at line 56 of file entity_state.cpp.

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

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

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

    return output;
}

Member Data Documentation

angular_position

double travesim::EntityState::angular_position

Angular position in radinans.

Definition at line 98 of file entity_state.hpp.

angular_velocity

double travesim::EntityState::angular_velocity

Angular velocity in rad/s.

Definition at line 104 of file entity_state.hpp.

position

Vector2D travesim::EntityState::position

Position in meters.

Definition at line 86 of file entity_state.hpp.

velocity

Vector2D travesim::EntityState::velocity

Velocity in m/s.

Definition at line 92 of file entity_state.hpp.

---

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

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