Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GNEPythonToolDialogElements::Argument Class Referenceabstract

argument More...

#include <GNEPythonToolDialogElements.h>

Inheritance diagram for GNEPythonToolDialogElements::Argument:
[legend]
Collaboration diagram for GNEPythonToolDialogElements::Argument:
[legend]

Public Member Functions

 Argument (GNEPythonToolDialog *toolDialogParent, const GNEPythonTool *pythonTool, GNEApplicationWindow *applicationWindow, FXVerticalFrame *argumentFrame, const std::string &parameter, Option *option)
 FOX-declaration.
const std::string getArgument () const
 get argument
MFXLabelTooltip * getParameterLabel () const
 get parameter label
bool requiredAttributeSet () const
 check if required attribute is set
virtual void reset ()=0
 reset to default value
 ~Argument ()
 destructor
FOX-callbacks
virtual long onCmdSetValue (FXObject *, FXSelector, void *)=0
 Called when user changes argument value.
long onCmdResetValue (FXObject *, FXSelector, void *)
 Called when user press reset button.
long onUpdResetValue (FXObject *, FXSelector, void *)
 Called when user press reset button.

Protected Member Functions

 Argument ()
 default constructor
virtual const std::string getValue () const =0
 get value

Protected Attributes

const std::string myDefaultValue
 default value
FXHorizontalFrame * myElementsFrame = nullptr
 auxiliar elements frame
Option * myOption = nullptr
 option
GNEPythonToolDialog * myToolDialogParent = nullptr
 tool dialog parent

Private Member Functions

 Argument (const Argument &)=delete
 Invalidated copy constructor.
Argument & operator= (const Argument &)=delete
 Invalidated assignment operator.

Private Attributes

MFXLabelTooltip * myParameterLabel = nullptr
 parameter label
FXButton * myResetButton = nullptr
 reset button

Detailed Description

argument

Definition at line 65 of file GNEPythonToolDialogElements.h.

Constructor & Destructor Documentation

◆ Argument() [1/3]

GNEPythonToolDialogElements::Argument::Argument ( GNEPythonToolDialog * toolDialogParent,
const GNEPythonTool * pythonTool,
GNEApplicationWindow * applicationWindow,
FXVerticalFrame * argumentFrame,
const std::string & parameter,
Option * option )

FOX-declaration.

constructor (we need pythonTool and applicationWindow because is called during GNEPythonToolDialog constructor)

Definition at line 118 of file GNEPythonToolDialogElements.cpp.

References GUIDesigns::buildFXButton(), Option::getDescription(), GUIIconSubSys::getIcon(), GUIMainWindow::getStaticTooltipMenu(), Option::getTypeName(), GUIDesignAuxiliarFrame, GUIDesignAuxiliarHorizontalFrame, GUIDesignButtonIcon, GUIDesignLabelThickedFixed, GUIDesignTextColorBlue, Option::isRequired(), MID_GNE_RESET, myDefaultValue, myElementsFrame, myOption, myParameterLabel, myResetButton, myToolDialogParent, RESET, and TL.

Referenced by Argument(), GNEPythonToolDialogElements::BoolArgument::BoolArgument(), GNEPythonToolDialogElements::EdgeArgument::EdgeArgument(), GNEPythonToolDialogElements::EdgeVectorArgument::EdgeVectorArgument(), GNEPythonToolDialogElements::FileNameArgument::FileNameArgument(), GNEPythonToolDialogElements::FloatArgument::FloatArgument(), GNEPythonToolDialogElements::IntArgument::IntArgument(), operator=(), and GNEPythonToolDialogElements::StringArgument::StringArgument().

Here is the caller graph for this function:

◆ ~Argument()

GNEPythonToolDialogElements::Argument::~Argument ( )

destructor

Definition at line 139 of file GNEPythonToolDialogElements.cpp.

◆ Argument() [2/3]

GNEPythonToolDialogElements::Argument::Argument ( )
protected

default constructor

Definition at line 186 of file GNEPythonToolDialogElements.cpp.

◆ Argument() [3/3]

GNEPythonToolDialogElements::Argument::Argument ( const Argument & )
privatedelete

Invalidated copy constructor.

References Argument().

Member Function Documentation

◆ getArgument()

const std::string GNEPythonToolDialogElements::Argument::getArgument ( ) const

get argument

Definition at line 149 of file GNEPythonToolDialogElements.cpp.

References getValue(), myDefaultValue, and myParameterLabel.

◆ getParameterLabel()

MFXLabelTooltip * GNEPythonToolDialogElements::Argument::getParameterLabel ( ) const

get parameter label

Definition at line 143 of file GNEPythonToolDialogElements.cpp.

References myParameterLabel.

◆ getValue()

virtual const std::string GNEPythonToolDialogElements::Argument::getValue ( ) const
protectedpure virtual

get value

Implemented in GNEPythonToolDialogElements::BoolArgument, GNEPythonToolDialogElements::EdgeArgument, GNEPythonToolDialogElements::EdgeVectorArgument, GNEPythonToolDialogElements::FileNameArgument, GNEPythonToolDialogElements::FloatArgument, GNEPythonToolDialogElements::IntArgument, and GNEPythonToolDialogElements::StringArgument.

Referenced by getArgument(), onUpdResetValue(), and requiredAttributeSet().

Here is the caller graph for this function:

◆ onCmdResetValue()

long GNEPythonToolDialogElements::Argument::onCmdResetValue ( FXObject * ,
FXSelector ,
void *  )

Called when user press reset button.

Definition at line 169 of file GNEPythonToolDialogElements.cpp.

References reset().

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onCmdSetValue()

virtual long GNEPythonToolDialogElements::Argument::onCmdSetValue ( FXObject * ,
FXSelector ,
void *  )
pure virtual

Called when user changes argument value.

Implemented in GNEPythonToolDialogElements::BoolArgument, GNEPythonToolDialogElements::EdgeArgument, GNEPythonToolDialogElements::EdgeVectorArgument, GNEPythonToolDialogElements::FileNameArgument, GNEPythonToolDialogElements::FloatArgument, GNEPythonToolDialogElements::IntArgument, and GNEPythonToolDialogElements::StringArgument.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ onUpdResetValue()

long GNEPythonToolDialogElements::Argument::onUpdResetValue ( FXObject * ,
FXSelector ,
void *  )

Called when user press reset button.

Definition at line 177 of file GNEPythonToolDialogElements.cpp.

References getValue(), myDefaultValue, and myResetButton.

Referenced by FXDEFMAP().

Here is the caller graph for this function:

◆ operator=()

Argument & GNEPythonToolDialogElements::Argument::operator= ( const Argument & )
privatedelete

Invalidated assignment operator.

References Argument().

◆ requiredAttributeSet()

bool GNEPythonToolDialogElements::Argument::requiredAttributeSet ( ) const

check if required attribute is set

Definition at line 159 of file GNEPythonToolDialogElements.cpp.

References getValue(), myDefaultValue, and myOption.

◆ reset()

virtual void GNEPythonToolDialogElements::Argument::reset ( )
pure virtual

reset to default value

Implemented in GNEPythonToolDialogElements::BoolArgument, GNEPythonToolDialogElements::EdgeArgument, GNEPythonToolDialogElements::EdgeVectorArgument, GNEPythonToolDialogElements::FileNameArgument, GNEPythonToolDialogElements::FloatArgument, GNEPythonToolDialogElements::IntArgument, and GNEPythonToolDialogElements::StringArgument.

Referenced by onCmdResetValue().

Here is the caller graph for this function:

Field Documentation

◆ myDefaultValue

const std::string GNEPythonToolDialogElements::Argument::myDefaultValue
protected

default value

Definition at line 118 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), getArgument(), GNEPythonToolDialogElements::BoolArgument::onCmdSetValue(), onUpdResetValue(), requiredAttributeSet(), GNEPythonToolDialogElements::BoolArgument::reset(), GNEPythonToolDialogElements::EdgeArgument::reset(), GNEPythonToolDialogElements::EdgeVectorArgument::reset(), GNEPythonToolDialogElements::FileNameArgument::reset(), GNEPythonToolDialogElements::FloatArgument::reset(), GNEPythonToolDialogElements::IntArgument::reset(), and GNEPythonToolDialogElements::StringArgument::reset().

◆ myElementsFrame

FXHorizontalFrame* GNEPythonToolDialogElements::Argument::myElementsFrame = nullptr
protected

auxiliar elements frame

Definition at line 121 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), GNEPythonToolDialogElements::BoolArgument::BoolArgument(), GNEPythonToolDialogElements::EdgeArgument::EdgeArgument(), GNEPythonToolDialogElements::EdgeVectorArgument::EdgeVectorArgument(), GNEPythonToolDialogElements::FileNameArgument::FileNameArgument(), GNEPythonToolDialogElements::FloatArgument::FloatArgument(), GNEPythonToolDialogElements::IntArgument::IntArgument(), and GNEPythonToolDialogElements::StringArgument::StringArgument().

◆ myOption

Option* GNEPythonToolDialogElements::Argument::myOption = nullptr
protected

option

Definition at line 115 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), GNEPythonToolDialogElements::AdditionalArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::DataArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::FileNameArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::NetworkArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::RouteArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::SumoConfigArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::BoolArgument::onCmdSetValue(), GNEPythonToolDialogElements::EdgeArgument::onCmdSetValue(), GNEPythonToolDialogElements::EdgeVectorArgument::onCmdSetValue(), GNEPythonToolDialogElements::FileNameArgument::onCmdSetValue(), GNEPythonToolDialogElements::FloatArgument::onCmdSetValue(), GNEPythonToolDialogElements::IntArgument::onCmdSetValue(), GNEPythonToolDialogElements::StringArgument::onCmdSetValue(), requiredAttributeSet(), GNEPythonToolDialogElements::BoolArgument::reset(), GNEPythonToolDialogElements::EdgeArgument::reset(), GNEPythonToolDialogElements::EdgeVectorArgument::reset(), GNEPythonToolDialogElements::FileNameArgument::reset(), GNEPythonToolDialogElements::FloatArgument::reset(), GNEPythonToolDialogElements::IntArgument::reset(), and GNEPythonToolDialogElements::StringArgument::reset().

◆ myParameterLabel

MFXLabelTooltip* GNEPythonToolDialogElements::Argument::myParameterLabel = nullptr
private

parameter label

Definition at line 125 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), getArgument(), and getParameterLabel().

◆ myResetButton

FXButton* GNEPythonToolDialogElements::Argument::myResetButton = nullptr
private

reset button

Definition at line 128 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), and onUpdResetValue().

◆ myToolDialogParent

GNEPythonToolDialog* GNEPythonToolDialogElements::Argument::myToolDialogParent = nullptr
protected

tool dialog parent

Definition at line 112 of file GNEPythonToolDialogElements.h.

Referenced by Argument(), GNEPythonToolDialogElements::AdditionalArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::DataArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::FileNameArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::NetworkArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::RouteArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::SumoConfigArgument::onCmdOpenFilename(), GNEPythonToolDialogElements::EdgeVectorArgument::onCmdUseCurrent(), GNEPythonToolDialogElements::EdgeVectorArgument::onUpdUseCurrent(), GNEPythonToolDialogElements::AdditionalArgument::onUpdUseCurrentAdditionalFile(), GNEPythonToolDialogElements::DataArgument::onUpdUseCurrentDataFile(), GNEPythonToolDialogElements::NetworkArgument::onUpdUseCurrentNetworkFile(), GNEPythonToolDialogElements::RouteArgument::onUpdUseCurrentRouteFile(), and GNEPythonToolDialogElements::SumoConfigArgument::onUpdUseCurrentSumoConfigFile().

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