GNEChange_ToggleAttribute Class Reference

the function-object for an editing operation (abstract base) More...

#include <GNEChange_ToggleAttribute.h>

Inheritance diagram for GNEChange_ToggleAttribute:

Collaboration diagram for GNEChange_ToggleAttribute:

Public Member Functions
	GNEChange_ToggleAttribute (GNEAttributeCarrier *ac, const SumoXMLAttr key, const bool value)
	constructor
	~GNEChange_ToggleAttribute ()
	Destructor.
inherited from GNEChange
get undo Name
std::string	undoName () const
	return undoName
std::string	redoName () const
	get Redo name
void	undo ()
	undo action
void	redo ()
	redo action

Private Attributes
GNEAttributeCarrier *	myAC
	the net to which all operations shall be applied
const SumoXMLAttr	myKey
	The attribute name.
const bool	myNewValue
	the new value
const bool	myOrigValue
	the original value

friend class
GNEChange *	next
virtual int	size () const
	Return the size of the command group.
Supermode	getSupermode () const
	get supermode
bool	canMerge () const
	Return TRUE if this command can be merged with previous undo commands. This is useful to combine e.g. multiple consecutive single-character text changes into a single block change. The default implementation returns FALSE.
bool	mergeWith (GNEChange *command)
	Called by the undo system to try and merge the new incoming command with this command; should return TRUE if merging was possible. The default implementation returns FALSE.
const Supermode	mySupermode
	supermode related with this change
bool	myForward
	we group antagonistic commands (create junction/delete junction) and keep them apart by this flag
const bool	mySelectedElement
	flag for check if element is selected
const GNEHierarchicalContainer	myOriginalHierarchicalContainer
	Hierarchical container with parent and children.
std::map< GNEHierarchicalElement *, GNEHierarchicalContainer >	myHierarchicalContainers
	map with hierarchical container of all parent and children elements
void	restoreHierarchicalContainers ()
	restore container (only use in undo() function)
template<typename T >
void	addElementInParentsAndChildren (T *element)
	add given element into parents and children (only use in redo() function)
template<typename T >
void	removeElementFromParentsAndChildren (T *element)
	remove given element from parents and children (only use in redo() function)

Detailed Description

the function-object for an editing operation (abstract base)

Definition at line 32 of file GNEChange_ToggleAttribute.h.

Constructor & Destructor Documentation

GNEChange_ToggleAttribute()

GNEChange_ToggleAttribute::GNEChange_ToggleAttribute	(	GNEAttributeCarrier *	ac,
		const SumoXMLAttr	key,
		const bool	value
	)

constructor

Parameters

[in]	ac	The attribute-carrier to be modified
[in]	key	The attribute key
[in]	value	The new value

Definition at line 38 of file GNEChange_ToggleAttribute.cpp.

~GNEChange_ToggleAttribute()

GNEChange_ToggleAttribute::~GNEChange_ToggleAttribute

(

)

Destructor.

Definition at line 48 of file GNEChange_ToggleAttribute.cpp.

References GNEReferenceCounter::decRef(), GNEViewParent::getGNEAppWindows(), GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNEAttributeCarrier::getTagProperty(), GNEAttributeCarrier::getTagStr(), GNETagProperties::getTagStr(), GNENet::getViewNet(), GNEViewNet::getViewParent(), GNEApplicationWindow::isUndoRedoAllowed(), myAC, GNEReferenceCounter::unreferenced(), and WRITE_DEBUG.

Member Function Documentation

addElementInParentsAndChildren()

template<typename T >

void GNEChange::addElementInParentsAndChildren ( T *  element )

inlineprotectedinherited

add given element into parents and children (only use in redo() function)

Definition at line 124 of file GNEChange.h.

References GNEHierarchicalContainer::getChildren(), GNEHierarchicalContainer::getParents(), and GNEChange::myOriginalHierarchicalContainer.

Referenced by GNEChange_Additional::redo(), GNEChange_DemandElement::redo(), GNEChange_Edge::redo(), GNEChange_GenericData::redo(), and GNEChange_Lane::redo().

Here is the caller graph for this function:

canMerge()

bool GNEChange::canMerge ( ) const

inherited

Return TRUE if this command can be merged with previous undo commands. This is useful to combine e.g. multiple consecutive single-character text changes into a single block change. The default implementation returns FALSE.

Definition at line 74 of file GNEChange.cpp.

Referenced by GNEUndoList::add().

Here is the caller graph for this function:

getSupermode()

Supermode GNEChange::getSupermode ( ) const

inherited

get supermode

Definition at line 68 of file GNEChange.cpp.

References GNEChange::mySupermode.

Referenced by GNEUndoList::getRedoSupermode(), and GNEUndoList::getUndoSupermode().

Here is the caller graph for this function:

mergeWith()

bool GNEChange::mergeWith ( GNEChange *  command )

inherited

Called by the undo system to try and merge the new incoming command with this command; should return TRUE if merging was possible. The default implementation returns FALSE.

Definition at line 80 of file GNEChange.cpp.

Referenced by GNEUndoList::add().

Here is the caller graph for this function:

redo()

void GNEChange_ToggleAttribute::redo ( )

virtual

redo action

Implements GNEChange.

Definition at line 86 of file GNEChange_ToggleAttribute.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNENet::getSavingStatus(), GNEAttributeCarrier::getTagProperty(), GNEAttributeCarrier::getTagStr(), GNETagProperties::isAdditionalElement(), GNETagProperties::isDataElement(), GNETagProperties::isDemandElement(), GNETagProperties::isMeanData(), GNETagProperties::isNetworkElement(), myAC, myKey, myNewValue, GNENetHelper::SavingStatus::requireSaveAdditionals(), GNENetHelper::SavingStatus::requireSaveDataElements(), GNENetHelper::SavingStatus::requireSaveDemandElements(), GNENetHelper::SavingStatus::requireSaveMeanDatas(), GNENetHelper::SavingStatus::requireSaveNetwork(), GNEAttributeCarrier::toggleAttribute(), and WRITE_DEBUG.

redoName()

std::string GNEChange_ToggleAttribute::redoName ( ) const

virtual

get Redo name

Implements GNEChange.

Definition at line 113 of file GNEChange_ToggleAttribute.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagStr(), myAC, and TLF.

removeElementFromParentsAndChildren()

template<typename T >

void GNEChange::removeElementFromParentsAndChildren ( T *  element )

inlineprotectedinherited

remove given element from parents and children (only use in redo() function)

Definition at line 167 of file GNEChange.h.

References GNEHierarchicalContainer::getChildren(), GNEHierarchicalContainer::getParents(), and GNEChange::myOriginalHierarchicalContainer.

Referenced by GNEChange_Additional::redo(), GNEChange_DemandElement::redo(), GNEChange_Edge::redo(), GNEChange_GenericData::redo(), and GNEChange_Lane::redo().

Here is the caller graph for this function:

restoreHierarchicalContainers()

void GNEChange::restoreHierarchicalContainers ( )

protectedinherited

restore container (only use in undo() function)

Definition at line 94 of file GNEChange.cpp.

References GNEChange::myHierarchicalContainers.

Referenced by GNEChange_Additional::undo(), GNEChange_DemandElement::undo(), GNEChange_Edge::undo(), GNEChange_GenericData::undo(), and GNEChange_Lane::undo().

Here is the caller graph for this function:

size()

int GNEChange::size ( ) const

virtualinherited

Return the size of the command group.

Reimplemented in GNEChangeGroup.

Definition at line 61 of file GNEChange.cpp.

Referenced by GNEUndoList::currentCommandGroupSize(), and GNEChangeGroup::size().

Here is the caller graph for this function:

undo()

void GNEChange_ToggleAttribute::undo ( )

virtual

undo action

Implements GNEChange.

Definition at line 65 of file GNEChange_ToggleAttribute.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNENet::getSavingStatus(), GNEAttributeCarrier::getTagProperty(), GNEAttributeCarrier::getTagStr(), GNETagProperties::isAdditionalElement(), GNETagProperties::isDataElement(), GNETagProperties::isDemandElement(), GNETagProperties::isMeanData(), GNETagProperties::isNetworkElement(), myAC, myKey, myOrigValue, GNENetHelper::SavingStatus::requireSaveAdditionals(), GNENetHelper::SavingStatus::requireSaveDataElements(), GNENetHelper::SavingStatus::requireSaveDemandElements(), GNENetHelper::SavingStatus::requireSaveMeanDatas(), GNENetHelper::SavingStatus::requireSaveNetwork(), GNEAttributeCarrier::toggleAttribute(), and WRITE_DEBUG.

undoName()

std::string GNEChange_ToggleAttribute::undoName ( ) const

virtual

return undoName

Implements GNEChange.

Definition at line 107 of file GNEChange_ToggleAttribute.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagStr(), myAC, and TLF.

Field Documentation

myAC

GNEAttributeCarrier* GNEChange_ToggleAttribute::myAC

private

the net to which all operations shall be applied

Note

we are not responsible for the pointer

Definition at line 65 of file GNEChange_ToggleAttribute.h.

Referenced by redo(), redoName(), undo(), undoName(), and ~GNEChange_ToggleAttribute().

myForward

bool GNEChange::myForward

protectedinherited

we group antagonistic commands (create junction/delete junction) and keep them apart by this flag

Definition at line 212 of file GNEChange.h.

Referenced by GNEChange_Additional::redo(), GNEChange_Children::redo(), GNEChange_Connection::redo(), GNEChange_Crossing::redo(), GNEChange_DataInterval::redo(), GNEChange_DataSet::redo(), GNEChange_DemandElement::redo(), GNEChange_Edge::redo(), GNEChange_EdgeType::redo(), GNEChange_GenericData::redo(), GNEChange_Junction::redo(), GNEChange_Lane::redo(), GNEChange_MeanData::redo(), GNEChange_TLS::redo(), GNEChange_Additional::redoName(), GNEChange_Children::redoName(), GNEChange_Connection::redoName(), GNEChange_Crossing::redoName(), GNEChange_DataInterval::redoName(), GNEChange_DataSet::redoName(), GNEChange_DemandElement::redoName(), GNEChange_Edge::redoName(), GNEChange_EdgeType::redoName(), GNEChange_GenericData::redoName(), GNEChange_Junction::redoName(), GNEChange_Lane::redoName(), GNEChange_MeanData::redoName(), GNEChange_TLS::redoName(), GNEChange_Additional::undo(), GNEChange_Children::undo(), GNEChange_Connection::undo(), GNEChange_Crossing::undo(), GNEChange_DataInterval::undo(), GNEChange_DataSet::undo(), GNEChange_DemandElement::undo(), GNEChange_Edge::undo(), GNEChange_EdgeType::undo(), GNEChange_GenericData::undo(), GNEChange_Junction::undo(), GNEChange_Lane::undo(), GNEChange_MeanData::undo(), GNEChange_TLS::undo(), GNEChange_Additional::undoName(), GNEChange_Children::undoName(), GNEChange_Connection::undoName(), GNEChange_Crossing::undoName(), GNEChange_DataInterval::undoName(), GNEChange_DataSet::undoName(), GNEChange_DemandElement::undoName(), GNEChange_Edge::undoName(), GNEChange_EdgeType::undoName(), GNEChange_GenericData::undoName(), GNEChange_Junction::undoName(), GNEChange_Lane::undoName(), GNEChange_MeanData::undoName(), and GNEChange_TLS::undoName().

myHierarchicalContainers

std::map<GNEHierarchicalElement*, GNEHierarchicalContainer> GNEChange::myHierarchicalContainers

protectedinherited

map with hierarchical container of all parent and children elements

Definition at line 221 of file GNEChange.h.

Referenced by GNEChange::GNEChange(), and GNEChange::restoreHierarchicalContainers().

myKey

const SumoXMLAttr GNEChange_ToggleAttribute::myKey

private

The attribute name.

Definition at line 68 of file GNEChange_ToggleAttribute.h.

Referenced by redo(), and undo().

myNewValue

const bool GNEChange_ToggleAttribute::myNewValue

private

the new value

Definition at line 74 of file GNEChange_ToggleAttribute.h.

Referenced by redo().

myOriginalHierarchicalContainer

const GNEHierarchicalContainer GNEChange::myOriginalHierarchicalContainer

protectedinherited

Hierarchical container with parent and children.

Definition at line 218 of file GNEChange.h.

Referenced by GNEChange::addElementInParentsAndChildren(), GNEChange_DemandElement::redo(), GNEChange::removeElementFromParentsAndChildren(), and GNEChange_DemandElement::undo().

myOrigValue

const bool GNEChange_ToggleAttribute::myOrigValue

private

the original value

Definition at line 71 of file GNEChange_ToggleAttribute.h.

Referenced by undo().

mySelectedElement

const bool GNEChange::mySelectedElement

protectedinherited

flag for check if element is selected

Definition at line 215 of file GNEChange.h.

Referenced by GNEChange_Additional::redo(), GNEChange_Connection::redo(), GNEChange_Crossing::redo(), GNEChange_DemandElement::redo(), GNEChange_Edge::redo(), GNEChange_GenericData::redo(), GNEChange_Junction::redo(), GNEChange_Lane::redo(), GNEChange_MeanData::redo(), GNEChange_Additional::undo(), GNEChange_Connection::undo(), GNEChange_Crossing::undo(), GNEChange_DemandElement::undo(), GNEChange_Edge::undo(), GNEChange_GenericData::undo(), GNEChange_Junction::undo(), GNEChange_Lane::undo(), and GNEChange_MeanData::undo().

mySupermode

const Supermode GNEChange::mySupermode

protectedinherited

supermode related with this change

Definition at line 209 of file GNEChange.h.

Referenced by GNEChange::getSupermode().

next

GNEChange* GNEChange::next

privateinherited

Definition at line 225 of file GNEChange.h.

Referenced by GNEUndoList::add(), GNEUndoList::clear(), GNEUndoList::cut(), GNEUndoList::end(), GNEChangeGroup::redo(), GNEUndoList::redo(), GNEChangeGroup::size(), GNEChangeGroup::undo(), GNEUndoList::undo(), and GNEChangeGroup::~GNEChangeGroup().

---

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

• GNEChange_ToggleAttribute.h
• GNEChange_ToggleAttribute.cpp