Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNERunDialog Class Referenceabstract

#include <GNERunDialog.h>

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

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

void addEvent (GUIEvent *event, const bool signal)
 add event in the queue
 
virtual std::string getRunCommand () const =0
 get run command
 
 GNERunDialog (GNEApplicationWindow *applicationWindow, const std::string &name, GUIIcon titleIcon)
 FOX-declaration.
 
virtual void runInternalTest (const InternalTestStep::DialogArgument *dialogArgument)=0
 run internal test
 
 ~GNERunDialog ()
 destructor
 
FOX-callbacks
long onCmdAbort (FXObject *, FXSelector, void *)
 event after press abort button
 
long onCmdRun (FXObject *, FXSelector, void *)
 event after press rerun button
 
virtual long onCmdBack (FXObject *, FXSelector, void *)=0
 event after press back button
 
virtual long onCmdAccept (FXObject *, FXSelector, void *)=0
 event after press close button
 
long onCmdSaveLog (FXObject *, FXSelector, void *)
 event after press save button
 
long onThreadEvent (FXObject *, FXSelector, void *)
 called when the thread signals an event
 
FOX-callbacks
virtual long onCmdCancel (FXObject *, FXSelector, void *)
 called when cancel or no button is pressed (can be reimplemented in children)
 
virtual long onCmdReset (FXObject *, FXSelector, void *)
 called when reset 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
 
 FOX_CONSTRUCTOR (GNERunDialog)
 FOX needs this.
 
void openDialog (FXWindow *focusableElement=nullptr)
 open dialog
 
void updateDialogButtons ()
 update dialog buttons
 
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
 
bool myError = false
 flag to check if there is an error
 
MFXSynchQue< GUIEvent * > myEvents
 List of received events.
 
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
 
FXText * myText = nullptr
 text
 
FXEX::MFXThreadEvent myThreadEvent
 io-event with the runner thread
 

Private Member Functions

void buildDialog (GUIIcon titleIcon, Buttons buttons)
 build dialog
 
 GNERunDialog (const GNERunDialog &)=delete
 Invalidated copy constructor.
 
GNERunDialogoperator= (const GNERunDialog &)=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 37 of file GNERunDialog.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

◆ GNERunDialog() [1/2]

GNERunDialog::GNERunDialog ( GNEApplicationWindow applicationWindow,
const std::string &  name,
GUIIcon  titleIcon 
)

◆ ~GNERunDialog()

GNERunDialog::~GNERunDialog ( )

destructor

Definition at line 71 of file GNERunDialog.cpp.

◆ GNERunDialog() [2/2]

GNERunDialog::GNERunDialog ( const GNERunDialog )
privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ addEvent()

void GNERunDialog::addEvent ( GUIEvent event,
const bool  signal 
)

add event in the queue

Definition at line 75 of file GNERunDialog.cpp.

References myEvents, myThreadEvent, MFXSynchQue< T, Container >::push_back(), and FXEX::MFXThreadEvent::signal().

Referenced by GNEExternalRunner::abort(), and GNEExternalRunner::run().

Here is the caller graph for this function:

◆ 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(), GNEParametersDialog::onCmdAccept(), GNEVClassesDialog::onCmdAccept(), and onCmdAccept().

Here is the caller graph for this function:

◆ closeDialogCanceling()

◆ FOX_CONSTRUCTOR()

GNERunDialog::FOX_CONSTRUCTOR ( GNERunDialog  )
protected

FOX needs this.

◆ 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:

◆ 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:

◆ getRunCommand()

virtual std::string GNERunDialog::getRunCommand ( ) const
pure virtual

get run command

Implemented in GNERunNetgenerateDialog, and GNERunPythonToolDialog.

Referenced by GNEExternalRunner::run().

Here is the caller graph for this function:

◆ onCmdAbort()

long GNERunDialog::onCmdAbort ( FXObject *  ,
FXSelector  ,
void *   
)
virtual

◆ onCmdAccept()

long GNERunDialog::onCmdAccept ( FXObject *  ,
FXSelector  ,
void *   
)
pure virtual

◆ 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()

virtual long GNERunDialog::onCmdBack ( FXObject *  ,
FXSelector  ,
void *   
)
pure virtual

event after press back button

Reimplemented from GNEDialog.

Implemented in GNERunNetgenerateDialog, GNERunPythonToolDialog, GNERunNetgenerateDialog, and GNERunPythonToolDialog.

◆ 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 GNEDialog::onCmdReset ( FXObject *  ,
FXSelector  ,
void *   
)
virtualinherited

◆ onCmdRun()

long GNERunDialog::onCmdRun ( FXObject *  ,
FXSelector  ,
void *   
)
virtual

◆ onCmdSaveLog()

long GNERunDialog::onCmdSaveLog ( FXObject *  ,
FXSelector  ,
void *   
)

event after press save button

Definition at line 134 of file GNERunDialog.cpp.

References GNEDialog::ACCEPT, OutputDevice::close(), OutputDevice::getDevice(), GNEDialog::myApplicationWindow, myText, GNEFileDialog::NETEDIT, GNEFileDialog::SAVE, TL, and SUMOXMLDefinitions::TXTFileExtensions.

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:

◆ onThreadEvent()

long GNERunDialog::onThreadEvent ( FXObject *  ,
FXSelector  ,
void *   
)

called when the thread signals an event

Definition at line 152 of file GNERunDialog.cpp.

References MFXSynchQue< T, Container >::empty(), ERROR_OCCURRED, GUIEvent_Message::getMsg(), GUIEvent::getOwnType(), MESSAGE_OCCURRED, myError, myEvents, myText, OUTPUT_OCCURRED, MFXSynchQue< T, Container >::pop(), TOOL_ENDED, MFXSynchQue< T, Container >::top(), and updateDialogButtons().

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::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=()

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

Invalidated assignment operator.

◆ runInternalTest()

virtual void GNERunDialog::runInternalTest ( const InternalTestStep::DialogArgument dialogArgument)
pure virtual

◆ updateDialogButtons()

void GNERunDialog::updateDialogButtons ( )
protected

update dialog buttons

Definition at line 199 of file GNERunDialog.cpp.

References GNEApplicationWindow::getExternalRunner(), GUIIconSubSys::getIcon(), GNEExternalRunner::isRunning(), GNEDialog::myAcceptButton, GNEDialog::myApplicationWindow, GNEDialog::myBackButton, GNEDialog::myRunButton, START, STOP, and TL.

Referenced by onCmdRun(), and onThreadEvent().

Here is the caller graph for this function:

◆ 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 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 updateDialogButtons().

◆ myCancelButton

FXButton* GNEDialog::myCancelButton = nullptr
protectedinherited

cancel button

Definition at line 141 of file GNEDialog.h.

Referenced by GNEDialog::buildDialog().

◆ myContentFrame

◆ myError

bool GNERunDialog::myError = false
protected

flag to check if there is an error

Definition at line 95 of file GNERunDialog.h.

Referenced by GNERunPythonToolDialog::onCmdAccept(), onCmdAccept(), onCmdRun(), and onThreadEvent().

◆ myEvents

MFXSynchQue<GUIEvent*> GNERunDialog::myEvents
protected

List of received events.

Definition at line 89 of file GNERunDialog.h.

Referenced by addEvent(), and onThreadEvent().

◆ 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

◆ 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

run button

Definition at line 150 of file GNEDialog.h.

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

◆ 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().

◆ myText

FXText* GNERunDialog::myText = nullptr
protected

text

Definition at line 86 of file GNERunDialog.h.

Referenced by onCmdAccept(), onCmdRun(), onCmdSaveLog(), and onThreadEvent().

◆ myThreadEvent

FXEX::MFXThreadEvent GNERunDialog::myThreadEvent
protected

io-event with the runner thread

Definition at line 92 of file GNERunDialog.h.

Referenced by addEvent().


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