#include <GNENetDiffTool.h>

Inheritance diagram for GNENetDiffTool:

Collaboration diagram for GNENetDiffTool:

Public Member Functions
std::string	getCommand () const
	get command (python + script + arguments)

const std::string	getDefaultValue (const std::string &name) const
	get default value of the given parameter

FXMenuCommand *	getMenuCommand () const
	get menu command

const std::string &	getToolName () const
	get tool name

OptionsCont &	getToolsOptions ()
	get tools options

	GNENetDiffTool (GNEApplicationWindow applicationWindow, const std::string &toolPath, FXMenuPane menu)
	Constructor.

bool	loadConfiguration (const std::string &file)
	load configuration

void	postProcessing ()
	execute post processing

void	saveConfiguration (const std::string &file) const
	save configuration

void	setCurrentValues ()
	set current values (used for set values like current folder and similar)

	~GNENetDiffTool ()
	destructor

Protected Member Functions
std::string	getCommandPath () const
	get command (python + script)

Protected Attributes
GNEApplicationWindow *	myApplicationWindow = nullptr
	application window

FXMenuCommand *	myMenuCommand = nullptr
	menu command associated with this tool

const std::string	myPythonToolName
	tool name

OptionsCont	myPythonToolsOptions
	tools options

OptionsCont	myPythonToolsOptionsOriginal
	original tools options

const std::string	myToolPath
	python tool path relative to SUMO_HOME

Private Member Functions
void	fillNetDiffOptions (OptionsCont &options)
	fill netDiff options

	GNENetDiffTool (const GNENetDiffTool &)=delete
	Invalidated copy constructor.

void	loadShapes (const std::string &file)
	load shapes

GNENetDiffTool &	operator= (const GNENetDiffTool &)=delete
	Invalidated assignment operator.

Detailed Description

Definition at line 29 of file GNENetDiffTool.h.

Constructor & Destructor Documentation

◆ GNENetDiffTool() [1/2]

GNENetDiffTool::GNENetDiffTool	(	GNEApplicationWindow *	applicationWindow,
		const std::string &	toolPath,
		FXMenuPane *	menu
	)

Constructor.

Definition at line 36 of file GNENetDiffTool.cpp.

References fillNetDiffOptions(), GNEPythonTool::myPythonToolsOptions, and GNEPythonTool::myPythonToolsOptionsOriginal.

◆ ~GNENetDiffTool()

GNENetDiffTool::~GNENetDiffTool ( )

destructor

Definition at line 44 of file GNENetDiffTool.cpp.

◆ GNENetDiffTool() [2/2]

GNENetDiffTool::GNENetDiffTool ( const GNENetDiffTool & )

privatedelete

Invalidated copy constructor.

Member Function Documentation

◆ fillNetDiffOptions()

void GNENetDiffTool::fillNetDiffOptions ( OptionsCont & options )

private

fill netDiff options

Definition at line 114 of file GNENetDiffTool.cpp.

References OptionsCont::addDescription(), OptionsCont::addOptionSubTopic(), OptionsCont::doRegister(), and TL.

Referenced by GNENetDiffTool().

Here is the caller graph for this function:

◆ getCommand()

std::string GNENetDiffTool::getCommand ( ) const

virtual

get command (python + script + arguments)

Reimplemented from GNEPythonTool.

Definition at line 91 of file GNENetDiffTool.cpp.

References OptionsCont::getBool(), GNEPythonTool::getCommandPath(), OptionsCont::getString(), and GNEPythonTool::myPythonToolsOptions.

◆ getCommandPath()

std::string GNEPythonTool::getCommandPath ( ) const

protectedinherited

get command (python + script)

Definition at line 92 of file GNEPythonTool.cpp.

References GNEPythonTool::myToolPath.

Referenced by getCommand(), and GNEPythonTool::getCommand().

Here is the caller graph for this function:

◆ getDefaultValue()

const std::string GNEPythonTool::getDefaultValue ( const std::string & name ) const

inherited

get default value of the given parameter

Definition at line 157 of file GNEPythonTool.cpp.

References OptionsCont::getValueString(), and GNEPythonTool::myPythonToolsOptionsOriginal.

◆ getMenuCommand()

FXMenuCommand * GNEPythonTool::getMenuCommand ( ) const

inherited

get menu command

Definition at line 74 of file GNEPythonTool.cpp.

References GNEPythonTool::myMenuCommand.

Referenced by GNERunPythonToolDialog::onCmdAccept(), GNERunPythonToolDialog::onCmdBack(), and GNEPythonToolDialog::onCmdRun().

Here is the caller graph for this function:

◆ getToolName()

const std::string & GNEPythonTool::getToolName ( ) const

inherited

get tool name

Definition at line 62 of file GNEPythonTool.cpp.

References GNEPythonTool::myPythonToolName.

◆ getToolsOptions()

OptionsCont & GNEPythonTool::getToolsOptions ( )

inherited

get tools options

Definition at line 68 of file GNEPythonTool.cpp.

References GNEPythonTool::myPythonToolsOptions.

Referenced by GNEPythonToolDialog::buildArguments().

Here is the caller graph for this function:

◆ loadConfiguration()

bool GNEPythonTool::loadConfiguration ( const std::string & file )

inherited

load configuration

Definition at line 169 of file GNEPythonTool.cpp.

References OptionsLoader::errorOccurred(), GNEPythonTool::myPythonToolName, GNEPythonTool::myPythonToolsOptions, OptionsCont::resetWritable(), TL, TLF, StringUtils::transcode(), StringUtils::transcodeToLocal(), WRITE_ERROR, and WRITE_MESSAGE.

Referenced by GNEPythonToolDialog::onCmdLoad().

Here is the caller graph for this function:

◆ loadShapes()

void GNENetDiffTool::loadShapes ( const std::string & file )

private

load shapes

Definition at line 150 of file GNENetDiffTool.cpp.

References GNEViewNet::getNet(), GNEApplicationWindow::getUndoList(), GNEApplicationWindow::getViewNet(), GNEApplicationWindow::isUndoRedoAllowed(), GNEPythonTool::myApplicationWindow, NETWORK, GeneralHandler::parse(), XMLSubSys::setValidation(), SUPERMODENETWORK, TL, WRITE_ERROR, and WRITE_MESSAGE.

Referenced by postProcessing().

Here is the caller graph for this function:

◆ operator=()

GNENetDiffTool & GNENetDiffTool::operator= ( const GNENetDiffTool & )

privatedelete

Invalidated assignment operator.

◆ postProcessing()

void GNENetDiffTool::postProcessing ( )

virtual

execute post processing

Reimplemented from GNEPythonTool.

Definition at line 61 of file GNENetDiffTool.cpp.

References OptionsCont::getBool(), GNESelectorFrame::getSelectionOperationModul(), GNEViewParent::getSelectorFrame(), OptionsCont::getString(), GNEApplicationWindow::getViewNet(), GNEViewNet::getViewParent(), GNESelectorFrame::SelectionOperation::loadFromFile(), loadShapes(), GNEPythonTool::myApplicationWindow, and GNEPythonTool::myPythonToolsOptions.

◆ saveConfiguration()

void GNEPythonTool::saveConfiguration ( const std::string & file ) const

inherited

save configuration

Definition at line 197 of file GNEPythonTool.cpp.

References GNEPythonTool::getCommand(), GNEPythonTool::myPythonToolName, SysUtils::runHiddenCommand(), TLF, and WRITE_MESSAGE.

Referenced by GNEPythonToolDialog::onCmdSave().

Here is the caller graph for this function:

◆ setCurrentValues()

void GNENetDiffTool::setCurrentValues ( )

virtual

set current values (used for set values like current folder and similar)

Reimplemented from GNEPythonTool.

Definition at line 48 of file GNENetDiffTool.cpp.

References FileHelpers::getFilePath(), OptionsCont::getOptions(), OptionsCont::getString(), GNEPythonTool::myPythonToolsOptions, OptionsCont::resetWritable(), and OptionsCont::set().

Field Documentation

◆ myApplicationWindow

GNEApplicationWindow* GNEPythonTool::myApplicationWindow = nullptr

protectedinherited

application window

Definition at line 75 of file GNEPythonTool.h.

Referenced by loadShapes(), and postProcessing().

◆ myMenuCommand

FXMenuCommand* GNEPythonTool::myMenuCommand = nullptr

protectedinherited

menu command associated with this tool

Definition at line 78 of file GNEPythonTool.h.

Referenced by GNEPythonTool::getMenuCommand(), and GNEPythonTool::GNEPythonTool().

◆ myPythonToolName

const std::string GNEPythonTool::myPythonToolName

protectedinherited

tool name

Definition at line 90 of file GNEPythonTool.h.

Referenced by GNEPythonTool::getToolName(), GNEPythonTool::GNEPythonTool(), GNEPythonTool::loadConfiguration(), and GNEPythonTool::saveConfiguration().

◆ myPythonToolsOptions

OptionsCont GNEPythonTool::myPythonToolsOptions

protectedinherited

tools options

Definition at line 81 of file GNEPythonTool.h.

Referenced by getCommand(), GNEPythonTool::getCommand(), GNEPythonTool::getToolsOptions(), GNENetDiffTool(), GNEPythonTool::GNEPythonTool(), GNEPythonTool::loadConfiguration(), postProcessing(), and setCurrentValues().

◆ myPythonToolsOptionsOriginal

OptionsCont GNEPythonTool::myPythonToolsOptionsOriginal

protectedinherited

original tools options

Definition at line 84 of file GNEPythonTool.h.

Referenced by GNEPythonTool::getDefaultValue(), GNENetDiffTool(), and GNEPythonTool::GNEPythonTool().

◆ myToolPath

const std::string GNEPythonTool::myToolPath

protectedinherited

python tool path relative to SUMO_HOME

Definition at line 87 of file GNEPythonTool.h.

Referenced by GNEPythonTool::getCommandPath().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GNENetDiffTool() [1/2]

◆ ~GNENetDiffTool()

◆ GNENetDiffTool() [2/2]

Member Function Documentation

◆ fillNetDiffOptions()

◆ getCommand()

◆ getCommandPath()

◆ getDefaultValue()

◆ getMenuCommand()

◆ getToolName()

◆ getToolsOptions()

◆ loadConfiguration()

◆ loadShapes()

◆ operator=()

◆ postProcessing()

◆ saveConfiguration()

◆ setCurrentValues()

Field Documentation

◆ myApplicationWindow

◆ myMenuCommand

◆ myPythonToolName

◆ myPythonToolsOptions

◆ myPythonToolsOptionsOriginal

◆ myToolPath