robot_path Klassenreferenz

#include <module_map.h>

Aufstellung aller Elemente

Öffentliche Methoden
	robot_path (double x1, double y1, double z1, double x2, double y2, double z2, bool permanent=false)
timeval	get_creation_time (void)
void	set_status (bool active)
bool	get_status (void)
void	set_permanent (bool permanent)
bool	get_permanent (void)
double	get_source_x (void)
	Gibt den x-Wert der Startposition zurück.
double	get_source_y (void)
	Gibt den y-Wert der Startposition zurück.
double	get_source_z (void)
	Gibt den z-Wert der Startposition zurück. Momentan nicht verwendet.
double	get_target_x (void)
	Gibt den x-Wert der Zielposition zurck.
double	get_target_y (void)
	Gibt den y-Wert der Zielposition zurück.
double	get_target_z (void)
	Gibt den z-Wert der Zielposition zurück.
Private Attribute
timeval	creation_time
double	source_x
double	source_y
double	source_z
double	target_x
double	target_y
double	target_z
bool	active
bool	permanent
Freundbeziehungen
class	module_map

---

Ausführliche Beschreibung

Verbindungslinien werden bei Positionsänderungen des Roboters erzeugt und gespeichert. Sie zeigen für eine gewisse Zeitspanne, die in der Konfigurationsdatei als PFAD_LEBENSDAUER zu setzen ist, den Weg des Roboters an.

Um die Kommunikation untereinander zu vereinfachen, wurde die Klasse module_map als "befreundet" eingetragen.

---

Beschreibung der Konstruktoren und Destruktoren

robot_path::robot_path	(	double	x1,
		double	y1,
		double	z1,
		double	x2,
		double	y2,
		double	z2,
		bool	permanent = false
	)

Der Konstruktor eines Pfades benötigt nur die zu verbindenden Punkte. Alle anderen Daten werden "automagisch" hinzugefügt.

HINWEIS: z-Werte werden momentan nicht verwendet.

Parameter:

	x1	x-Wert des Startposition.
	y1	y-Wert des Startposition.
	z1	z-Wert des Startposition.
	x2	x-Wert der Zielposition.
	y2	y-Wert der Zielposition.
	z2	z-Wert der Zielposition.
	permanent	Gibt an, ob der Pfad permanent sein soll.

---

Dokumentation der Elementfunktionen

timeval robot_path::get_creation_time

(

void

)

Gibt den Zeitpunkt der "Erschaffung" der Klasse zurück.

Rückgabe:

Eine timeval-Struktur, die die Daten von creation_time enthält.

bool robot_path::get_permanent

(

void

)

Gibt zurück, ob es sich um einen permanenten Pfad handelt oder nicht.

Rückgabe:

True, wenn der Pfad permanent ist. Sonst false.

double robot_path::get_source_x

(

void

)

Gibt den x-Wert der Startposition zurück.

double robot_path::get_source_y

(

void

)

Gibt den y-Wert der Startposition zurück.

double robot_path::get_source_z

(

void

)

Gibt den z-Wert der Startposition zurück. Momentan nicht verwendet.

bool robot_path::get_status

(

void

)

Gibt den Status des Pfades zurück.

Rückgabe:

True, wenn der Pfad noch aktiv ist. Sonst false.

double robot_path::get_target_x

(

void

)

Gibt den x-Wert der Zielposition zurck.

double robot_path::get_target_y

(

void

)

Gibt den y-Wert der Zielposition zurück.

double robot_path::get_target_z

(

void

)

Gibt den z-Wert der Zielposition zurück.

void robot_path::set_permanent

(

bool

permanent

)

Setzt die Permanenzeigenschaft eines Pfades. Permanente Pfade werden nicht nach einer gewissen Zeit gelöscht.

Parameter:

permanent

Gibt an, ob der Pfad transparent sein soll

void robot_path::set_status

(

bool

active

)

Setzt den Status des Pfades. Dieser kann entweder aktiv sein, sodass er noch von der Karte gezeichnet wird, oder inaktiv.

Parameter:

active

Gibt an, ob der Pfad aktiv ist oder nicht.

---

Freundbeziehungen und Funktionsdokumentation

friend class module_map [friend]

---

Dokumentation der Datenelemente

bool robot_path::active [private]

timeval robot_path::creation_time [private]

bool robot_path::permanent [private]

double robot_path::source_x [private]

double robot_path::source_y [private]

double robot_path::source_z [private]

double robot_path::target_x [private]

double robot_path::target_y [private]

double robot_path::target_z [private]

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• module_map.h
• module_map.cpp

---