SUMO - Simulation of Urban MObility
TraCIAPI::GUIScope Class Reference

Scope for interaction with the gui. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::GUIScope:
Inheritance graph
Collaboration diagram for TraCIAPI::GUIScope:
Collaboration graph

Public Member Functions

TraCIBoundary getBoundary (const std::string &viewID=DEFAULT_VIEW) const
 
std::vector< std::string > getIDList () const
 
TraCIPosition getOffset (const std::string &viewID=DEFAULT_VIEW) const
 
std::string getSchema (const std::string &viewID=DEFAULT_VIEW) const
 
double getZoom (const std::string &viewID=DEFAULT_VIEW) const
 
 GUIScope (TraCIAPI &parent)
 
void screenshot (const std::string &viewID, const std::string &filename) const
 
void setBoundary (const std::string &viewID, double xmin, double ymin, double xmax, double ymax) const
 
void setOffset (const std::string &viewID, double x, double y) const
 
void setSchema (const std::string &viewID, const std::string &schemeName) const
 
void setZoom (const std::string &viewID, double zoom) const
 
void trackVehicle (const std::string &viewID, const std::string &vehID) const
 
virtual ~GUIScope ()
 

Protected Attributes

TraCIAPImyParent
 The parent TraCI client which offers the connection. More...
 

Private Member Functions

 GUIScope (const GUIScope &src)
 invalidated copy constructor More...
 
GUIScopeoperator= (const GUIScope &src)
 invalidated assignment operator More...
 

Detailed Description

Scope for interaction with the gui.

Definition at line 195 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ GUIScope() [1/2]

TraCIAPI::GUIScope::GUIScope ( TraCIAPI parent)
inline

Definition at line 197 of file TraCIAPI.h.

◆ ~GUIScope()

virtual TraCIAPI::GUIScope::~GUIScope ( )
inlinevirtual

Definition at line 198 of file TraCIAPI.h.

References DEFAULT_VIEW, and TraCIAPI::TraCIScopeWrapper::operator=().

◆ GUIScope() [2/2]

TraCIAPI::GUIScope::GUIScope ( const GUIScope src)
private

invalidated copy constructor

Member Function Documentation

◆ getBoundary()

TraCIBoundary TraCIAPI::GUIScope::getBoundary ( const std::string &  viewID = DEFAULT_VIEW) const

Definition at line 753 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_BOUNDARY.

◆ getIDList()

std::vector< std::string > TraCIAPI::GUIScope::getIDList ( ) const

Definition at line 733 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and ID_LIST.

◆ getOffset()

TraCIPosition TraCIAPI::GUIScope::getOffset ( const std::string &  viewID = DEFAULT_VIEW) const

Definition at line 743 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_OFFSET.

◆ getSchema()

std::string TraCIAPI::GUIScope::getSchema ( const std::string &  viewID = DEFAULT_VIEW) const

Definition at line 748 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_SCHEMA.

Referenced by TraCITestClient::testAPI().

◆ getZoom()

double TraCIAPI::GUIScope::getZoom ( const std::string &  viewID = DEFAULT_VIEW) const

Definition at line 738 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_ZOOM.

◆ operator=()

GUIScope& TraCIAPI::GUIScope::operator= ( const GUIScope src)
private

invalidated assignment operator

◆ screenshot()

void TraCIAPI::GUIScope::screenshot ( const std::string &  viewID,
const std::string &  filename 
) const

◆ setBoundary()

void TraCIAPI::GUIScope::setBoundary ( const std::string &  viewID,
double  xmin,
double  ymin,
double  xmax,
double  ymax 
) const

◆ setOffset()

void TraCIAPI::GUIScope::setOffset ( const std::string &  viewID,
double  x,
double  y 
) const

◆ setSchema()

void TraCIAPI::GUIScope::setSchema ( const std::string &  viewID,
const std::string &  schemeName 
) const

◆ setZoom()

void TraCIAPI::GUIScope::setZoom ( const std::string &  viewID,
double  zoom 
) const

Definition at line 759 of file TraCIAPI.cpp.

References CMD_SET_GUI_VARIABLE, VAR_VIEW_ZOOM, and tcpip::Storage::writeDouble().

◆ trackVehicle()

void TraCIAPI::GUIScope::trackVehicle ( const std::string &  viewID,
const std::string &  vehID 
) const

Field Documentation

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 131 of file TraCIAPI.h.


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