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

void clearSubscriptionResults ()
 
const libsumo::ContextSubscriptionResults getAllContextSubscriptionResults () const
 
const libsumo::SubscriptionResults getAllSubscriptionResults () const
 
libsumo::TraCIPositionVector getBoundary (const std::string &viewID=DEFAULT_VIEW) const
 
const libsumo::SubscriptionResults getContextSubscriptionResults (const std::string &objID) const
 
std::vector< std::string > getIDList () const
 
libsumo::SubscriptionResultsgetModifiableContextSubscriptionResults (const std::string &objID)
 
libsumo::SubscriptionResultsgetModifiableSubscriptionResults ()
 
libsumo::TraCIPosition getOffset (const std::string &viewID=DEFAULT_VIEW) const
 
std::string getParameter (const std::string &objectID, const std::string &key) const
 retrieve generic paramter More...
 
std::string getSchema (const std::string &viewID=DEFAULT_VIEW) const
 
const libsumo::TraCIResults getSubscriptionResults (const std::string &objID) const
 
double getZoom (const std::string &viewID=DEFAULT_VIEW) const
 
 GUIScope (TraCIAPI &parent)
 
void screenshot (const std::string &viewID, const std::string &filename, const int width=-1, const int height=-1) 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 setParameter (const std::string &objectID, const std::string &key, const std::string &value) const
 set generic paramter More...
 
void setSchema (const std::string &viewID, const std::string &schemeName) const
 
void setZoom (const std::string &viewID, double zoom) const
 
void subscribe (const std::string &objID, const std::vector< int > &vars, double beginTime, double endTime) const
 
void subscribeContext (const std::string &objID, int domain, double range, const std::vector< int > &vars, double beginTime, double endTime) const
 
void trackVehicle (const std::string &viewID, const std::string &vehID) const
 
virtual ~GUIScope ()
 

Protected Attributes

int myCmdGetID
 
int myCmdSetID
 
int myContextSubscribeID
 
libsumo::ContextSubscriptionResults myContextSubscriptionResults
 
TraCIAPImyParent
 The parent TraCI client which offers the connection. More...
 
int mySubscribeID
 
libsumo::SubscriptionResults mySubscriptionResults
 

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 217 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ GUIScope() [1/2]

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

Definition at line 219 of file TraCIAPI.h.

◆ ~GUIScope()

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

Definition at line 220 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

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )
inherited

Definition at line 3313 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getAllContextSubscriptionResults()

const libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::getAllContextSubscriptionResults ( ) const
inherited

Definition at line 3297 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getAllSubscriptionResults()

const libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::getAllSubscriptionResults ( ) const
inherited

Definition at line 3281 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getBoundary()

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

Definition at line 801 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_BOUNDARY.

◆ getContextSubscriptionResults()

const libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::getContextSubscriptionResults ( const std::string &  objID) const
inherited

◆ getIDList()

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

Definition at line 781 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and TRACI_ID_LIST.

◆ getModifiableContextSubscriptionResults()

libsumo::SubscriptionResults & TraCIAPI::TraCIScopeWrapper::getModifiableContextSubscriptionResults ( const std::string &  objID)
inherited

Definition at line 3326 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getModifiableSubscriptionResults()

libsumo::SubscriptionResults & TraCIAPI::TraCIScopeWrapper::getModifiableSubscriptionResults ( )
inherited

Definition at line 3320 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getOffset()

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

Definition at line 791 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_OFFSET.

◆ getParameter()

std::string TraCIAPI::TraCIScopeWrapper::getParameter ( const std::string &  objectID,
const std::string &  key 
) const
inherited

◆ getSchema()

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

Definition at line 796 of file TraCIAPI.cpp.

References CMD_GET_GUI_VARIABLE, and VAR_VIEW_SCHEMA.

Referenced by TraCITestClient::testAPI().

◆ getSubscriptionResults()

const libsumo::TraCIResults TraCIAPI::TraCIScopeWrapper::getSubscriptionResults ( const std::string &  objID) const
inherited

◆ getZoom()

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

Definition at line 786 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 int  width = -1,
const int  height = -1 
) 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

◆ setParameter()

void TraCIAPI::TraCIScopeWrapper::setParameter ( const std::string &  objectID,
const std::string &  key,
const std::string &  value 
) const
inherited

◆ 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 807 of file TraCIAPI.cpp.

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

◆ subscribe()

void TraCIAPI::TraCIScopeWrapper::subscribe ( const std::string &  objID,
const std::vector< int > &  vars,
double  beginTime,
double  endTime 
) const
inherited

◆ subscribeContext()

void TraCIAPI::TraCIScopeWrapper::subscribeContext ( const std::string &  objID,
int  domain,
double  range,
const std::vector< int > &  vars,
double  beginTime,
double  endTime 
) const
inherited

◆ trackVehicle()

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

Field Documentation

◆ myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID
protectedinherited

Definition at line 146 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID
protectedinherited

Definition at line 147 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID
protectedinherited

Definition at line 149 of file TraCIAPI.h.

◆ myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults
protectedinherited

Definition at line 151 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 145 of file TraCIAPI.h.

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID
protectedinherited

Definition at line 148 of file TraCIAPI.h.

◆ mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults
protectedinherited

Definition at line 150 of file TraCIAPI.h.


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