Eclipse SUMO - Simulation of Urban MObility
LIBSUMO_NAMESPACE::POI Class Reference

#include <POI.h>

Collaboration diagram for LIBSUMO_NAMESPACE::POI:
[legend]

Static Public Member Functions

static bool add (const std::string &poiID, double x, double y, const libsumo::TraCIColor &color, const std::string &poiType="", int layer=0, const std::string &imgFile="", double width=1, double height=1, double angle=0, const std::string &icon="")
 
static void cleanup ()
 
static double getAngle (const std::string &poiID)
 
static libsumo::TraCIColor getColor (const std::string &poiID)
 
static double getHeight (const std::string &poiID)
 
static std::string getImageFile (const std::string &poiID)
 
static libsumo::TraCIPosition getPosition (const std::string &poiID, const bool includeZ=false)
 
static NamedRTreegetTree ()
 Returns a tree filled with PoI instances. More...
 
static std::string getType (const std::string &poiID)
 
static double getWidth (const std::string &poiID)
 
static bool handleVariable (const std::string &objID, const int variable, VariableWrapper *wrapper, tcpip::Storage *paramData)
 
static void highlight (const std::string &poiID, const libsumo::TraCIColor &col=libsumo::TraCIColor(255, 0, 0, 255), double size=-1, const int alphaMax=-1, const double duration=-1, const int type=0)
 
static std::shared_ptr< VariableWrapper > makeWrapper ()
 
static bool remove (const std::string &poiID, int layer=0)
 
static void setAngle (const std::string &poiID, double angle)
 
static void setColor (const std::string &poiID, const libsumo::TraCIColor &color)
 
static void setHeight (const std::string &poiID, double height)
 
static void setImageFile (const std::string &poiID, const std::string &imageFile)
 
static void setPosition (const std::string &poiID, double x, double y)
 
LIBSUMO_ID_PARAMETER_API static LIBSUMO_SUBSCRIPTION_API void setType (const std::string &poiID, const std::string &poiType)
 
static void setWidth (const std::string &poiID, double width)
 
static void storeShape (const std::string &id, PositionVector &shape)
 Saves the shape of the requested object in the given container. More...
 

Private Member Functions

 POI ()=delete
 invalidated standard constructor More...
 

Static Private Member Functions

static PointOfInterestgetPoI (const std::string &id)
 

Static Private Attributes

static ContextSubscriptionResults myContextSubscriptionResults
 
static SubscriptionResults mySubscriptionResults
 
static NamedRTreemyTree
 

Detailed Description

Definition at line 46 of file POI.h.

Constructor & Destructor Documentation

◆ POI()

LIBSUMO_NAMESPACE::POI::POI ( )
privatedelete

invalidated standard constructor

Member Function Documentation

◆ add()

bool POI::add ( const std::string &  poiID,
double  x,
double  y,
const libsumo::TraCIColor color,
const std::string &  poiType = "",
int  layer = 0,
const std::string &  imgFile = "",
double  width = 1,
double  height = 1,
double  angle = 0,
const std::string &  icon = "" 
)
static

◆ cleanup()

void POI::cleanup ( )
static

Definition at line 278 of file libsumo/POI.cpp.

◆ getAngle()

double POI::getAngle ( const std::string &  poiID)
static

Definition at line 93 of file libsumo/POI.cpp.

◆ getColor()

libsumo::TraCIColor POI::getColor ( const std::string &  poiID)
static

Definition at line 69 of file libsumo/POI.cpp.

References libsumo::Helper::makeTraCIColor().

◆ getHeight()

double POI::getHeight ( const std::string &  poiID)
static

Definition at line 87 of file libsumo/POI.cpp.

◆ getImageFile()

std::string POI::getImageFile ( const std::string &  poiID)
static

Definition at line 99 of file libsumo/POI.cpp.

◆ getPoI()

PointOfInterest * POI::getPoI ( const std::string &  id)
staticprivate

◆ getPosition()

libsumo::TraCIPosition POI::getPosition ( const std::string &  poiID,
const bool  includeZ = false 
)
static

Definition at line 75 of file libsumo/POI.cpp.

References libsumo::Helper::makeTraCIPosition().

◆ getTree()

NamedRTree * POI::getTree ( )
static

Returns a tree filled with PoI instances.

Returns
The rtree of PoIs

Definition at line 264 of file libsumo/POI.cpp.

References MSNet::getInstance(), ShapeContainer::getPOIs(), and MSNet::getShapeContainer().

◆ getType()

std::string POI::getType ( const std::string &  poiID)
static

Definition at line 63 of file libsumo/POI.cpp.

◆ getWidth()

double POI::getWidth ( const std::string &  poiID)
static

Definition at line 81 of file libsumo/POI.cpp.

◆ handleVariable()

◆ highlight()

void POI::highlight ( const std::string &  poiID,
const libsumo::TraCIColor col = libsumo::TraCIColor(255, 0, 0, 255),
double  size = -1,
const int  alphaMax = -1,
const double  duration = -1,
const int  type = 0 
)
static

◆ makeWrapper()

std::shared_ptr< VariableWrapper > POI::makeWrapper ( )
static

Definition at line 291 of file libsumo/POI.cpp.

◆ remove()

bool POI::remove ( const std::string &  poiID,
int  layer = 0 
)
static

◆ setAngle()

void POI::setAngle ( const std::string &  poiID,
double  angle 
)
static

Definition at line 146 of file libsumo/POI.cpp.

◆ setColor()

void POI::setColor ( const std::string &  poiID,
const libsumo::TraCIColor color 
)
static

Definition at line 128 of file libsumo/POI.cpp.

References libsumo::Helper::makeRGBColor().

◆ setHeight()

void POI::setHeight ( const std::string &  poiID,
double  height 
)
static

Definition at line 140 of file libsumo/POI.cpp.

◆ setImageFile()

void POI::setImageFile ( const std::string &  poiID,
const std::string &  imageFile 
)
static

Definition at line 152 of file libsumo/POI.cpp.

◆ setPosition()

void POI::setPosition ( const std::string &  poiID,
double  x,
double  y 
)
static

◆ setType()

void POI::setType ( const std::string &  poiID,
const std::string &  poiType 
)
static

Definition at line 114 of file libsumo/POI.cpp.

◆ setWidth()

void POI::setWidth ( const std::string &  poiID,
double  width 
)
static

Definition at line 134 of file libsumo/POI.cpp.

◆ storeShape()

void POI::storeShape ( const std::string &  id,
PositionVector shape 
)
static

Saves the shape of the requested object in the given container.

Parameters
idThe id of the poi to retrieve
shapeThe container to fill

Definition at line 285 of file libsumo/POI.cpp.

Field Documentation

◆ myContextSubscriptionResults

ContextSubscriptionResults POI::myContextSubscriptionResults
staticprivate

Definition at line 98 of file POI.h.

◆ mySubscriptionResults

SubscriptionResults POI::mySubscriptionResults
staticprivate

Definition at line 97 of file POI.h.

◆ myTree

NamedRTree * POI::myTree
staticprivate

Definition at line 99 of file POI.h.


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