SUMO - Simulation of Urban MObility
GUIParameterTableWindow Class Reference

A window containing a gl-object's parameter. More...

#include <GUIParameterTableWindow.h>

Inheritance diagram for GUIParameterTableWindow:
Inheritance graph
Collaboration diagram for GUIParameterTableWindow:
Collaboration graph

Public Member Functions

void closeBuilding (const Parameterised *p=0)
 Closes the building of the table. More...
 
 GUIParameterTableWindow (GUIMainWindow &app, GUIGlObject &o, int noRows)
 Constructor. More...
 
void removeObject (GUIGlObject *const o)
 Lets this window know the object shown is being deleted. More...
 
 ~GUIParameterTableWindow ()
 Destructor. More...
 
Row adding functions
template<class T >
void mkItem (const char *name, bool dynamic, ValueSource< T > *src)
 Adds a row which obtains its value from a ValueSource. More...
 
void mkItem (const char *name, bool dynamic, std::string value)
 Adds a row which shows a string-value. More...
 
void mkItem (const char *name, bool dynamic, unsigned value)
 Adds a row which shows a unsigned-value. More...
 
void mkItem (const char *name, bool dynamic, int value)
 Adds a row which shows a integer-value. More...
 
void mkItem (const char *name, bool dynamic, long long int value)
 Adds a row which shows a 64 bit integer-value. More...
 
void mkItem (const char *name, bool dynamic, double value)
 Adds a row which shows a double-value. More...
 
FOX-callbacks
long onSimStep (FXObject *, FXSelector, void *)
 Updates the table due to a simulation step. More...
 
long onTableSelected (FXObject *, FXSelector, void *)
 Does nothing. More...
 
long onTableDeselected (FXObject *, FXSelector, void *)
 Does nothing. More...
 
long onRightButtonPress (FXObject *, FXSelector, void *)
 Shows a popup. More...
 

Static Public Member Functions

static void updateAll ()
 Updates all instances. More...
 

Protected Member Functions

 GUIParameterTableWindow ()
 FOX needs this. More...
 
void updateTable ()
 Updates the table. More...
 

Static Protected Attributes

static std::vector< GUIParameterTableWindow * > myContainer
 The container of items that shall be updated. More...
 
static MFXMutex myGlobalContainerLock
 The mutex used to avoid concurrent updates of the instance container. More...
 

Static Private Member Functions

static int numParams (const GUIGlObject *obj)
 returns the number of parameters if obj is Parameterised and 0 otherwise More...
 

Private Attributes

GUIMainWindowmyApplication
 The main application window. More...
 
unsigned myCurrentPos
 The index of the next row to add - used while building. More...
 
std::vector< GUIParameterTableItemInterface * > myItems
 The list of table rows. More...
 
MFXMutex myLock
 A lock assuring save updates in case of object deletion. More...
 
GUIGlObjectmyObject
 The object to get the information from. More...
 
FXTable * myTable
 The table to display the information in. More...
 

Detailed Description

A window containing a gl-object's parameter.

This class realises a view on some parameter of a gl-object. The gl-object itself is responsible for filling this table.

After allocating such a table, the object should fill the rows by calling one of the mkItem-methods for each. The building is closed using closeBuilding what forces the table to be displayed.

Each row is represented using an instance of GUIParameterTableItemInterface.

Definition at line 64 of file GUIParameterTableWindow.h.

Constructor & Destructor Documentation

◆ GUIParameterTableWindow() [1/2]

GUIParameterTableWindow::GUIParameterTableWindow ( GUIMainWindow app,
GUIGlObject o,
int  noRows 
)

Constructor.

Parameters
[in]appThe application this window belongs to
[in]oThe gl-object this table describes
[in]noRowsNumber of rows to allocate

Definition at line 62 of file GUIParameterTableWindow.cpp.

References GUIGlObject::addParameterTable(), GUIIconSubSys::getIcon(), ICON_APP_TABLE, MFXMutex::lock(), MID_TABLE, myContainer, myGlobalContainerLock, myLock, myObject, myTable, numParams(), and MFXMutex::unlock().

◆ ~GUIParameterTableWindow()

GUIParameterTableWindow::~GUIParameterTableWindow ( )

◆ GUIParameterTableWindow() [2/2]

GUIParameterTableWindow::GUIParameterTableWindow ( )
inlineprotected

FOX needs this.

Definition at line 243 of file GUIParameterTableWindow.h.

Member Function Documentation

◆ closeBuilding()

void GUIParameterTableWindow::closeBuilding ( const Parameterised p = 0)

Closes the building of the table.

Adds the table to the list of child windows of the applications also telling the application that the window should be updated in each simulation step. Shows the table.

See also
GUIMainWindow::addChild

Definition at line 218 of file GUIParameterTableWindow.cpp.

References GUIMainWindow::addChild(), Parameterised::getParametersMap(), mkItem(), myApplication, and myObject.

Referenced by GNEInternalLane::getParameterWindow(), GUITrafficLightLogicWrapper::getParameterWindow(), GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), GUILaneSpeedTrigger::getParameterWindow(), GUIMEInductLoop::MyWrapper::getParameterWindow(), GUIInstantInductLoop::MyWrapper::getParameterWindow(), GUIPolygon::getParameterWindow(), GNENetElement::getParameterWindow(), GUICalibrator::getParameterWindow(), GUIJunctionWrapper::getParameterWindow(), GUIPointOfInterest::getParameterWindow(), GUIE3Collector::MyWrapper::getParameterWindow(), GUIContainerStop::getParameterWindow(), GUIChargingStation::getParameterWindow(), GUIBusStop::getParameterWindow(), GUIParkingArea::getParameterWindow(), GUIEdge::getParameterWindow(), GNENet::getParameterWindow(), GUIMEVehicle::getParameterWindow(), GUIVehicle::getParameterWindow(), GUINet::getParameterWindow(), GUIE2Collector::MyWrapper::getParameterWindow(), GUIInductLoop::MyWrapper::getParameterWindow(), GUILane::getParameterWindow(), GNEAdditional::getParameterWindow(), GUIContainer::getTypeParameterWindow(), GUIPerson::getTypeParameterWindow(), GUIMEVehicle::getTypeParameterWindow(), GUIVehicle::getTypeParameterWindow(), and GUIPerson::GUIPersonPopupMenu::onCmdShowPlan().

◆ mkItem() [1/6]

template<class T >
void GUIParameterTableWindow::mkItem ( const char *  name,
bool  dynamic,
ValueSource< T > *  src 
)
inline

Adds a row which obtains its value from a ValueSource.

Parameters
[in]nameThe name of the row entry
[in]dynamicInformation whether the entry is dynamic
[in]srcThe value source to use

Definition at line 110 of file GUIParameterTableWindow.h.

References myCurrentPos, myItems, myTable, onRightButtonPress(), onSimStep(), onTableDeselected(), and onTableSelected().

Referenced by closeBuilding(), GUITrafficLightLogicWrapper::getParameterWindow(), GUIContainer::getParameterWindow(), GUIPerson::getParameterWindow(), GUILaneSpeedTrigger::getParameterWindow(), GUIMEInductLoop::MyWrapper::getParameterWindow(), GUIInstantInductLoop::MyWrapper::getParameterWindow(), GUIPolygon::getParameterWindow(), GUICalibrator::getParameterWindow(), GNENetElement::getParameterWindow(), GUIJunctionWrapper::getParameterWindow(), GUIPointOfInterest::getParameterWindow(), GUIE3Collector::MyWrapper::getParameterWindow(), GUIContainerStop::getParameterWindow(), GUIChargingStation::getParameterWindow(), GUIBusStop::getParameterWindow(), GUIParkingArea::getParameterWindow(), GUIEdge::getParameterWindow(), GUIMEVehicle::getParameterWindow(), GUIVehicle::getParameterWindow(), GUINet::getParameterWindow(), GUIE2Collector::MyWrapper::getParameterWindow(), GUIInductLoop::MyWrapper::getParameterWindow(), GUILane::getParameterWindow(), GNEAdditional::getParameterWindow(), GUIContainer::getTypeParameterWindow(), GUIPerson::getTypeParameterWindow(), GUIMEVehicle::getTypeParameterWindow(), GUIVehicle::getTypeParameterWindow(), and GUIPerson::GUIPersonPopupMenu::onCmdShowPlan().

◆ mkItem() [2/6]

void GUIParameterTableWindow::mkItem ( const char *  name,
bool  dynamic,
std::string  value 
)

Adds a row which shows a string-value.

Parameters
[in]nameThe name of the row entry
[in]dynamicInformation whether the entry is dynamic
[in]valueThe value to show
Todo:
the dynamic-parameter is obsolete(?)

Definition at line 170 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

◆ mkItem() [3/6]

void GUIParameterTableWindow::mkItem ( const char *  name,
bool  dynamic,
unsigned  value 
)

Adds a row which shows a unsigned-value.

Parameters
[in]nameThe name of the row entry
[in]dynamicInformation whether the entry is dynamic
[in]valueThe value to show
Todo:
the dynamic-parameter is obsolete

Definition at line 185 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

◆ mkItem() [4/6]

void GUIParameterTableWindow::mkItem ( const char *  name,
bool  dynamic,
int  value 
)

Adds a row which shows a integer-value.

Parameters
[in]nameThe name of the row entry
[in]dynamicInformation whether the entry is dynamic
[in]valueThe value to show
Todo:
the dynamic-parameter is obsolete

Definition at line 192 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

◆ mkItem() [5/6]

void GUIParameterTableWindow::mkItem ( const char *  name,
bool  dynamic,
long long int  value 
)

Adds a row which shows a 64 bit integer-value.

Parameters
[in]nameThe name of the row entry
[in]dynamicInformation whether the entry is dynamic
[in]valueThe value to show
Todo:
the dynamic-parameter is obsolete

Definition at line 199 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

◆ mkItem() [6/6]

void GUIParameterTableWindow::mkItem ( const char *  name,
bool  dynamic,
double  value 
)

Adds a row which shows a double-value.

Parameters
[in]nameThe name of the row entry
[in]dynamicInformation whether the entry is dynamic
[in]valueThe value to show
Todo:
the dynamic-parameter is obsolete

Definition at line 178 of file GUIParameterTableWindow.cpp.

References myCurrentPos, myItems, and myTable.

◆ numParams()

int GUIParameterTableWindow::numParams ( const GUIGlObject obj)
staticprivate

returns the number of parameters if obj is Parameterised and 0 otherwise

Definition at line 236 of file GUIParameterTableWindow.cpp.

References Parameterised::getParametersMap().

Referenced by GUIParameterTableWindow().

◆ onRightButtonPress()

long GUIParameterTableWindow::onRightButtonPress ( FXObject *  sender,
FXSelector  sel,
void *  eventData 
)

Shows a popup.

Callback for right-mouse-button pressing event. Obtains the selected row and determines whether it is dynamic. If so, a popup-menu which allows to open a tracker for this value is built and shown.

See also
GUIParameterTableItemInterface
GUIParam_PopupMenuInterface

Definition at line 142 of file GUIParameterTableWindow.cpp.

References GUIParameterTableItemInterface::dynamic(), GUIParameterTableItemInterface::getdoubleSourceCopy(), GUIParameterTableItemInterface::getName(), MID_OPENTRACKER, myApplication, myItems, myObject, and myTable.

Referenced by mkItem().

◆ onSimStep()

long GUIParameterTableWindow::onSimStep ( FXObject *  ,
FXSelector  ,
void *   
)

Updates the table due to a simulation step.

Definition at line 121 of file GUIParameterTableWindow.cpp.

References updateTable().

Referenced by mkItem().

◆ onTableDeselected()

long GUIParameterTableWindow::onTableDeselected ( FXObject *  ,
FXSelector  ,
void *   
)

Does nothing.

Todo:
Recheck whether this is needed (to override FXTable-behaviour?)

Definition at line 136 of file GUIParameterTableWindow.cpp.

Referenced by mkItem().

◆ onTableSelected()

long GUIParameterTableWindow::onTableSelected ( FXObject *  ,
FXSelector  ,
void *   
)

Does nothing.

Todo:
Recheck whether this is needed (to override FXTable-behaviour?)

Definition at line 130 of file GUIParameterTableWindow.cpp.

Referenced by mkItem().

◆ removeObject()

void GUIParameterTableWindow::removeObject ( GUIGlObject *const  o)

Lets this window know the object shown is being deleted.

Parameters
[in]oThe deleted (shown) object

Definition at line 114 of file GUIParameterTableWindow.cpp.

References myLock, and myObject.

◆ updateAll()

static void GUIParameterTableWindow::updateAll ( )
inlinestatic

Updates all instances.

Definition at line 199 of file GUIParameterTableWindow.h.

References myContainer, myGlobalContainerLock, and updateTable().

◆ updateTable()

void GUIParameterTableWindow::updateTable ( )
protected

Updates the table.

Goes through all entries and updates them using GUIParameterTableItemInterface::update.

See also
GUIParameterTableItemInterface::update

Definition at line 206 of file GUIParameterTableWindow.cpp.

References myItems, myLock, and myObject.

Referenced by onSimStep(), and updateAll().

Field Documentation

◆ myApplication

GUIMainWindow* GUIParameterTableWindow::myApplication
private

The main application window.

Definition at line 227 of file GUIParameterTableWindow.h.

Referenced by closeBuilding(), onRightButtonPress(), and ~GUIParameterTableWindow().

◆ myContainer

std::vector< GUIParameterTableWindow * > GUIParameterTableWindow::myContainer
staticprotected

The container of items that shall be updated.

Definition at line 217 of file GUIParameterTableWindow.h.

Referenced by GUIParameterTableWindow(), updateAll(), and ~GUIParameterTableWindow().

◆ myCurrentPos

unsigned GUIParameterTableWindow::myCurrentPos
private

The index of the next row to add - used while building.

Definition at line 233 of file GUIParameterTableWindow.h.

Referenced by mkItem().

◆ myGlobalContainerLock

MFXMutex GUIParameterTableWindow::myGlobalContainerLock
staticprotected

The mutex used to avoid concurrent updates of the instance container.

Definition at line 214 of file GUIParameterTableWindow.h.

Referenced by GUIParameterTableWindow(), updateAll(), and ~GUIParameterTableWindow().

◆ myItems

std::vector<GUIParameterTableItemInterface*> GUIParameterTableWindow::myItems
private

The list of table rows.

Definition at line 230 of file GUIParameterTableWindow.h.

Referenced by mkItem(), onRightButtonPress(), updateTable(), and ~GUIParameterTableWindow().

◆ myLock

MFXMutex GUIParameterTableWindow::myLock
mutableprivate

A lock assuring save updates in case of object deletion.

Definition at line 236 of file GUIParameterTableWindow.h.

Referenced by GUIParameterTableWindow(), removeObject(), updateTable(), and ~GUIParameterTableWindow().

◆ myObject

GUIGlObject* GUIParameterTableWindow::myObject
private

The object to get the information from.

Definition at line 221 of file GUIParameterTableWindow.h.

Referenced by closeBuilding(), GUIParameterTableWindow(), onRightButtonPress(), removeObject(), updateTable(), and ~GUIParameterTableWindow().

◆ myTable

FXTable* GUIParameterTableWindow::myTable
private

The table to display the information in.

Definition at line 224 of file GUIParameterTableWindow.h.

Referenced by GUIParameterTableWindow(), mkItem(), and onRightButtonPress().


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