rail::interactive_world::PointOfInterest Class Reference

Point of interest configuration information. More...

#include <PointOfInterest.h>

List of all members.

Public Member Functions
const std::string &	getFrameID () const
	Frame ID value accessor.
const std::string &	getName () const
	Name value accessor.
	PointOfInterest (const std::string &name="", const std::string &frame_id="")
	Create a new PointOfInterest.
void	setFrameID (const std::string &frame_id)
	Frame ID value mutator.
void	setName (const std::string &name)
	Name value mutator.
Private Attributes
std::string	frame_id_
std::string	name_

---

Detailed Description

Point of interest configuration information.

A POI contains a name and associated frame.

Definition at line 27 of file PointOfInterest.h.

---

Constructor & Destructor Documentation

PointOfInterest::PointOfInterest	(	const std::string &	name = "",
		const std::string &	frame_id = ""
	)

Create a new PointOfInterest.

Create a new PointOfInterest with the given name and frame ID.

Parameters:

name	The name of the POI (defaults to the empty string).
frame_id	The frame ID of the POI (defaults to the empty string).

Definition at line 16 of file PointOfInterest.cpp.

---

Member Function Documentation

const string & PointOfInterest::getFrameID

(

)

const

Frame ID value accessor.

Get the frame ID value of this PointOfInterest.

Returns:

The frame ID value.

Definition at line 30 of file PointOfInterest.cpp.

const string & PointOfInterest::getName

(

)

const

Name value accessor.

Get the name value of this PointOfInterest.

Returns:

The name value.

Definition at line 20 of file PointOfInterest.cpp.

void PointOfInterest::setFrameID

(

const std::string &

frame_id

)

Frame ID value mutator.

Set the frame ID value of this PointOfInterest.

Parameters:

frame_id

The new frame ID name value.

Definition at line 35 of file PointOfInterest.cpp.

void PointOfInterest::setName

(

const std::string &

name

)

Name value mutator.

Set the name value of this PointOfInterest.

Parameters:

name	The new name value.

Definition at line 25 of file PointOfInterest.cpp.

---

Member Data Documentation

std::string rail::interactive_world::PointOfInterest::frame_id_ [private]

Definition at line 78 of file PointOfInterest.h.

std::string rail::interactive_world::PointOfInterest::name_ [private]

Name of the POI and frame ID.

Definition at line 78 of file PointOfInterest.h.

---

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

• PointOfInterest.h
• PointOfInterest.cpp