Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNEParametersDialog Class Reference

#include <GNEParametersDialog.h>

Inheritance diagram for GNEParametersDialog:
[legend]
Collaboration diagram for GNEParametersDialog:
[legend]

Data Structures

class  ParametersOperations
 
class  ParametersValues
 FOX-declaration. More...
 

Public Types

basic dialog type
enum class  Buttons {
  OK , YES_NO , YES_NO_CANCEL , ACCEPT ,
  ACCEPT_CANCEL , ACCEPT_CANCEL_RESET , SAVE_DONTSAVE_CANCEL , RUN_CANCEL_RESET ,
  RUN_ADVANCED_CANCEL , RERUN_BACK_CLOSE
}
 
enum class  OpenType { MODAL , NON_MODAL }
 Open dialog type. More...
 

Public Member Functions

std::vector< std::pair< std::string, std::string > > getEditedParameters () const
 get edited parameters
 
 GNEParametersDialog (GNEApplicationWindow *applicationWindow, const Parameterised::Map &parameters)
 constructor
 
void runInternalTest (const InternalTestStep::DialogArgument *dialogArgument)
 run internal test
 
 ~GNEParametersDialog ()
 destructor
 
FOX-callbacks
long onCmdAccept (FXObject *, FXSelector, void *)
 event after press accept button
 
long onCmdReset (FXObject *, FXSelector, void *)
 event after press reset button
 
FOX-callbacks
virtual long onCmdCancel (FXObject *, FXSelector, void *)
 called when cancel or no button is pressed (can be reimplemented in children)
 
virtual long onCmdAbort (FXObject *, FXSelector, void *)
 called when abort is called either closing dialog or pressing abort button (can be reimplemented in children)
 
virtual long onCmdRun (FXObject *, FXSelector, void *)
 called when run button is pressed (must be reimplemented in children)
 
virtual long onCmdBack (FXObject *, FXSelector, void *)
 called when back button is pressed (must be reimplemented in children)
 
virtual long onCmdAdvanced (FXObject *, FXSelector, void *)
 called when advanced button is pressed (must be reimplemented in children)
 
long onKeyPress (FXObject *obj, FXSelector sel, void *ptr)
 called when user presses a key on the dialog
 
long onKeyRelease (FXObject *obj, FXSelector sel, void *ptr)
 called when user releases a key on the dialog
 

Protected Member Functions

long closeDialogAborting ()
 close dialog aborting the changes
 
long closeDialogAccepting ()
 close dialog accepting the changes
 
long closeDialogCanceling ()
 close dialog declining the changes
 
void openDialog (FXWindow *focusableElement=nullptr)
 open dialog
 
void updateIcon (GUIIcon newIcon)
 update icon
 
void updateTitle (const std::string &newTitle)
 update title
 

Protected Attributes

FXButton * myAbortButton = nullptr
 abort button
 
FXButton * myAcceptButton = nullptr
 accept button
 
FXButton * myAdvancedButton = nullptr
 advanced button
 
GNEApplicationWindowmyApplicationWindow = nullptr
 FOX needs this.
 
FXButton * myBackButton = nullptr
 back button
 
FXButton * myCancelButton = nullptr
 cancel button
 
FXVerticalFrame * myContentFrame = nullptr
 content frame
 
const Parameterised::Map myOriginalParameters
 FOX need this.
 
ParametersOperationsmyParametersOperations = nullptr
 pointer to parameters operations
 
ParametersValuesmyParametersValues = nullptr
 pointer to parameters values
 
FXButton * myResetButton = nullptr
 reset button
 
Result myResult = Result::CANCEL
 result to indicate if this dialog was closed accepting or rejecting changes
 
FXButton * myRunButton = nullptr
 run button
 

Private Member Functions

void buildDialog (GUIIcon titleIcon, Buttons buttons)
 build dialog
 
 GNEParametersDialog (const GNEParametersDialog &)=delete
 Invalidated copy constructor.
 
GNEParametersDialogoperator= (const GNEParametersDialog &)=delete
 Invalidated assignment operator.
 

Private Attributes

FXButton * myFocusButton = nullptr
 focus button, used for focusing the default button when dialog is opened
 
OpenType myOpenType
 open type
 
bool myTesting = false
 flag to indicate if this dialog is being tested using internal test
 

Resize mode

Result getResult () const
 get result to indicate if this dialog was closed accepting or rejecting changes
 
GNEApplicationWindowgetApplicationWindow () const
 get pointer to the application window
 
FXVerticalFrame * getContentFrame () const
 get content frame
 
enum class  ResizeMode { STATIC , RESIZABLE }
 
enum class  Result { ACCEPT , CANCEL , ABORT }
 list of possible results when closing the dialog More...
 

Detailed Description

Definition at line 41 of file GNEParametersDialog.h.

Member Enumeration Documentation

◆ Buttons

enum class GNEDialog::Buttons
stronginherited
Enumerator
OK 
YES_NO 
YES_NO_CANCEL 
ACCEPT 
ACCEPT_CANCEL 
ACCEPT_CANCEL_RESET 
SAVE_DONTSAVE_CANCEL 
RUN_CANCEL_RESET 
RUN_ADVANCED_CANCEL 
RERUN_BACK_CLOSE 

Definition at line 41 of file GNEDialog.h.

◆ OpenType

enum class GNEDialog::OpenType
stronginherited

Open dialog type.

Enumerator
MODAL 
NON_MODAL 

Definition at line 55 of file GNEDialog.h.

◆ ResizeMode

enum class GNEDialog::ResizeMode
stronginherited
Enumerator
STATIC 
RESIZABLE 

Definition at line 61 of file GNEDialog.h.

◆ Result

enum class GNEDialog::Result
stronginherited

list of possible results when closing the dialog

Enumerator
ACCEPT 
CANCEL 
ABORT 

Definition at line 67 of file GNEDialog.h.

Constructor & Destructor Documentation

◆ GNEParametersDialog() [1/2]

GNEParametersDialog::GNEParametersDialog ( GNEApplicationWindow applicationWindow,
const Parameterised::Map parameters 
)

◆ ~GNEParametersDialog()

GNEParametersDialog::~GNEParametersDialog ( )

destructor

Definition at line 487 of file GNEParametersDialog.cpp.

◆ GNEParametersDialog() [2/2]

GNEParametersDialog::GNEParametersDialog ( const GNEParametersDialog )
privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ buildDialog()

◆ closeDialogAborting()

long GNEDialog::closeDialogAborting ( )
protectedinherited

close dialog aborting the changes

Definition at line 259 of file GNEDialog.cpp.

References GNEDialog::ABORT, GNEDialog::MODAL, GNEDialog::myApplicationWindow, GNEDialog::myOpenType, GNEDialog::myResult, and GNEDialog::myTesting.

Referenced by GNEOverwriteElement::onCmdAbort(), GNETemplateElementDialog< T >::onCmdAbort(), GNEDialog::onCmdAbort(), and GNEDialog::onKeyPress().

Here is the caller graph for this function:

◆ closeDialogAccepting()

long GNEDialog::closeDialogAccepting ( )
protectedinherited

close dialog accepting the changes

Definition at line 227 of file GNEDialog.cpp.

References GNEDialog::ACCEPT, GNEDialog::MODAL, GNEDialog::myApplicationWindow, GNEDialog::myOpenType, GNEDialog::myResult, and GNEDialog::myTesting.

Referenced by GNETemplateElementDialog< T >::acceptElementDialog(), GNEOverwriteElement::onCmdAccept(), GNEFileDialog::onCmdAccept(), GNEFixElementsDialog< T >::onCmdAccept(), GNEDialog::onCmdAccept(), onCmdAccept(), GNEVClassesDialog::onCmdAccept(), and GNERunDialog::onCmdAccept().

Here is the caller graph for this function:

◆ closeDialogCanceling()

◆ getApplicationWindow()

◆ getContentFrame()

FXVerticalFrame * GNEDialog::getContentFrame ( ) const
inherited

get content frame

Definition at line 99 of file GNEDialog.cpp.

References GNEDialog::myContentFrame.

Referenced by GNEVClassesDialog::GNEVClassesDialog().

Here is the caller graph for this function:

◆ getEditedParameters()

std::vector< std::pair< std::string, std::string > > GNEParametersDialog::getEditedParameters ( ) const

get edited parameters

Definition at line 497 of file GNEParametersDialog.cpp.

References GNEParametersDialog::ParametersValues::getParameterRows(), and myParametersValues.

Referenced by onCmdAccept().

Here is the caller graph for this function:

◆ getResult()

GNEDialog::Result GNEDialog::getResult ( ) const
inherited

get result to indicate if this dialog was closed accepting or rejecting changes

Definition at line 87 of file GNEDialog.cpp.

References GNEDialog::myResult.

Referenced by GNEDataHandler::checkDuplicatedDataSet(), GNEMeanDataHandler::checkDuplicatedMeanDataElement(), GNEAdditionalHandler::checkElement(), and GNERouteHandler::checkElement().

Here is the caller graph for this function:

◆ onCmdAbort()

long GNEDialog::onCmdAbort ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when abort is called either closing dialog or pressing abort button (can be reimplemented in children)

Reimplemented in GNEOverwriteElement, GNETemplateElementDialog< T >, GNETemplateElementDialog< elementDialogType >, GNETemplateElementDialog< GNEAdditional >, GNETemplateElementDialog< GNEAttributeCarrier >, GNETemplateElementDialog< GNEDemandElement >, GNERunDialog, GNERunNetgenerateDialog, and GNERunPythonToolDialog.

Definition at line 117 of file GNEDialog.cpp.

References GNEDialog::closeDialogAborting().

Referenced by FXDEFMAP(), and GNEDialog::openDialog().

Here is the caller graph for this function:

◆ onCmdAccept()

long GNEParametersDialog::onCmdAccept ( FXObject *  ,
FXSelector  ,
void *   
)
virtual

event after press accept button

Reimplemented from GNEDialog.

Definition at line 511 of file GNEParametersDialog.cpp.

References GNEDialog::closeDialogAccepting(), getEditedParameters(), SUMOXMLDefinitions::isValidParameterKey(), GNEDialog::myApplicationWindow, and TL.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdAdvanced()

long GNEDialog::onCmdAdvanced ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when advanced button is pressed (must be reimplemented in children)

Reimplemented in GNENetgenerateDialog.

Definition at line 141 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdBack()

long GNEDialog::onCmdBack ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when back button is pressed (must be reimplemented in children)

Reimplemented in GNERunNetgenerateDialog, GNERunPythonToolDialog, GNERunNetgenerateDialog, GNERunPythonToolDialog, and GNERunDialog.

Definition at line 135 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdCancel()

long GNEDialog::onCmdCancel ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when cancel or no button is pressed (can be reimplemented in children)

Reimplemented in GNEOverwriteElement, GNETemplateElementDialog< T >, GNETemplateElementDialog< elementDialogType >, GNETemplateElementDialog< GNEAdditional >, GNETemplateElementDialog< GNEAttributeCarrier >, GNETemplateElementDialog< GNEDemandElement >, GNEFilePathDialog, GNEVClassesDialog, GNENeteditOptionsDialog, GNENetgenerateOptionsDialog, GNESumoOptionsDialog, GNERunNetgenerateDialog, GNERunPythonToolDialog, and GNEGeometryPointDialog.

Definition at line 111 of file GNEDialog.cpp.

References GNEDialog::closeDialogCanceling().

Referenced by FXDEFMAP(), FXDEFMAP(), and GNEDialog::openDialog().

Here is the caller graph for this function:

◆ onCmdReset()

long GNEParametersDialog::onCmdReset ( FXObject *  ,
FXSelector  ,
void *   
)
virtual

event after press reset button

Reimplemented from GNEDialog.

Definition at line 542 of file GNEParametersDialog.cpp.

References myOriginalParameters, myParametersValues, and GNEParametersDialog::ParametersValues::setParameters().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdRun()

long GNEDialog::onCmdRun ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

called when run button is pressed (must be reimplemented in children)

Reimplemented in GNERunDialog, GNENetgenerateDialog, and GNEPythonToolDialog.

Definition at line 129 of file GNEDialog.cpp.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onKeyPress()

long GNEDialog::onKeyPress ( FXObject *  obj,
FXSelector  sel,
void *  ptr 
)
inherited

called when user presses a key on the dialog

Definition at line 147 of file GNEDialog.cpp.

References GNEDialog::closeDialogAborting(), GNEApplicationWindow::getInternalTest(), GNEDialog::myApplicationWindow, and GNEDialog::myTesting.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onKeyRelease()

long GNEDialog::onKeyRelease ( FXObject *  obj,
FXSelector  sel,
void *  ptr 
)
inherited

called when user releases a key on the dialog

Definition at line 163 of file GNEDialog.cpp.

References GNEApplicationWindow::getInternalTest(), GNEDialog::myApplicationWindow, and GNEDialog::myTesting.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ openDialog()

void GNEDialog::openDialog ( FXWindow *  focusableElement = nullptr)
protectedinherited

open dialog

Definition at line 173 of file GNEDialog.cpp.

References InternalTestStep::DialogArgument::ABORT, InternalTestStep::DialogArgument::ACCEPT, InternalTestStep::DialogArgument::CANCEL, InternalTestStep::DIALOG, GNEApplicationWindow::getInternalTest(), GNEDialog::MODAL, GNEDialog::myApplicationWindow, GNEDialog::myFocusButton, GNEDialog::myOpenType, GNEDialog::myTesting, GNEDialog::onCmdAbort(), GNEDialog::onCmdAccept(), GNEDialog::onCmdCancel(), GNEDialog::onCmdReset(), InternalTestStep::DialogArgument::RESET, GNEDialog::runInternalTest(), and InternalTest::setNextStep().

Referenced by GNEAboutDialog::GNEAboutDialog(), GNEAttributeCarrierDialog::GNEAttributeCarrierDialog(), GNEBasicDialog::GNEBasicDialog(), GNECalibratorDialog::GNECalibratorDialog(), GNEFileDialog::GNEFileDialog(), GNEFilePathDialog::GNEFilePathDialog(), GNEFixAdditionalElementsDialog::GNEFixAdditionalElementsDialog(), GNEFixDemandElementsDialog::GNEFixDemandElementsDialog(), GNEFixNetworkElements::GNEFixNetworkElements(), GNEHelpAttributesDialog::GNEHelpAttributesDialog(), GNENeteditOptionsDialog::GNENeteditOptionsDialog(), GNENetgenerateOptionsDialog::GNENetgenerateOptionsDialog(), GNEOverwriteElement::GNEOverwriteElement(), GNEParametersDialog(), GNERerouterDialog::GNERerouterDialog(), GNERerouterIntervalDialog::GNERerouterIntervalDialog(), GNERunNetgenerateDialog::GNERunNetgenerateDialog(), GNERunPythonToolDialog::GNERunPythonToolDialog(), GNESumoOptionsDialog::GNESumoOptionsDialog(), GNEVariableSpeedSignDialog::GNEVariableSpeedSignDialog(), GNEVClassesDialog::GNEVClassesDialog(), and GNEVehicleTypeDialog::GNEVehicleTypeDialog().

Here is the caller graph for this function:

◆ operator=()

GNEParametersDialog & GNEParametersDialog::operator= ( const GNEParametersDialog )
privatedelete

Invalidated assignment operator.

◆ runInternalTest()

void GNEParametersDialog::runInternalTest ( const InternalTestStep::DialogArgument dialogArgument)
virtual

run internal test

Implements GNEDialog.

Definition at line 491 of file GNEParametersDialog.cpp.

◆ updateIcon()

void GNEDialog::updateIcon ( GUIIcon  newIcon)
protectedinherited

update icon

Definition at line 281 of file GNEDialog.cpp.

References GUIIconSubSys::getIcon().

Referenced by GNEFileDialog::GNEFileDialog().

Here is the caller graph for this function:

◆ updateTitle()

void GNEDialog::updateTitle ( const std::string &  newTitle)
protectedinherited

update title

Definition at line 275 of file GNEDialog.cpp.

Referenced by GNEFileDialog::GNEFileDialog().

Here is the caller graph for this function:

Field Documentation

◆ myAbortButton

FXButton* GNEDialog::myAbortButton = nullptr
protectedinherited

abort button

Definition at line 144 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myAcceptButton

FXButton* GNEDialog::myAcceptButton = nullptr
protectedinherited

accept button

Definition at line 138 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), GNEFileDialog::GNEFileDialog(), and GNERunDialog::updateDialogButtons().

◆ myAdvancedButton

FXButton* GNEDialog::myAdvancedButton = nullptr
protectedinherited

advanced button

Definition at line 156 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), and GNENetgenerateDialog::updateRunButtons().

◆ myApplicationWindow

◆ myBackButton

FXButton* GNEDialog::myBackButton = nullptr
protectedinherited

back button

Definition at line 153 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), and GNERunDialog::updateDialogButtons().

◆ myCancelButton

FXButton* GNEDialog::myCancelButton = nullptr
protectedinherited

cancel button

Definition at line 141 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myContentFrame

◆ myFocusButton

FXButton* GNEDialog::myFocusButton = nullptr
privateinherited

focus button, used for focusing the default button when dialog is opened

Definition at line 181 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog(), and GNEDialog::openDialog().

◆ myOpenType

OpenType GNEDialog::myOpenType
privateinherited

◆ myOriginalParameters

const Parameterised::Map GNEParametersDialog::myOriginalParameters
protected

FOX need this.

original parameters

Definition at line 261 of file GNEParametersDialog.h.

Referenced by onCmdReset().

◆ myParametersOperations

ParametersOperations* GNEParametersDialog::myParametersOperations = nullptr
protected

pointer to parameters operations

Definition at line 267 of file GNEParametersDialog.h.

Referenced by GNEParametersDialog().

◆ myParametersValues

ParametersValues* GNEParametersDialog::myParametersValues = nullptr
protected

pointer to parameters values

Definition at line 264 of file GNEParametersDialog.h.

Referenced by getEditedParameters(), GNEParametersDialog(), and onCmdReset().

◆ myResetButton

FXButton* GNEDialog::myResetButton = nullptr
protectedinherited

reset button

Definition at line 147 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myResult

Result GNEDialog::myResult = Result::CANCEL
protectedinherited

result to indicate if this dialog was closed accepting or rejecting changes

Definition at line 159 of file GNEDialog.h.

Referenced by GNEDialog::closeDialogAborting(), GNEDialog::closeDialogAccepting(), GNEDialog::closeDialogCanceling(), and GNEDialog::getResult().

◆ myRunButton

FXButton* GNEDialog::myRunButton = nullptr
protectedinherited

◆ myTesting

bool GNEDialog::myTesting = false
privateinherited

flag to indicate if this dialog is being tested using internal test

Definition at line 187 of file GNEDialog.h.

Referenced by GNEDialog::closeDialogAborting(), GNEDialog::closeDialogAccepting(), GNEDialog::closeDialogCanceling(), GNEDialog::onKeyPress(), GNEDialog::onKeyRelease(), and GNEDialog::openDialog().


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