Eclipse SUMO - Simulation of Urban MObility
Public Member Functions | Private Attributes
GNEChange_EnableAttribute Class Reference

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

#include <GNEChange_EnableAttribute.h>

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

Public Member Functions

 GNEChange_EnableAttribute (GNEAttributeCarrier *ac, const SumoXMLAttr key, const bool value)
 constructor More...
 
 GNEChange_EnableAttribute (GNEAttributeCarrier *ac, const SumoXMLAttr key, const bool value, const int previousParameters)
 constructor More...
 
 ~GNEChange_EnableAttribute ()
 Destructor. More...
 
inherited from GNEChange

get undo Name

std::string undoName () const
 return undoName More...
 
std::string redoName () const
 get Redo name More...
 
void undo ()
 undo action More...
 
void redo ()
 redo action More...
 

Private Attributes

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

friend class

GNEChange * next
 
virtual int size () const
 Return the size of the command group. More...
 
Supermode getSupermode () const
 get supermode More...
 
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. More...
 
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. More...
 
const Supermode mySupermode
 supermode related with this change More...
 
bool myForward
 we group antagonistic commands (create junction/delete junction) and keep them apart by this flag More...
 
const bool mySelectedElement
 flag for check if element is selected More...
 
const GNEHierarchicalContainer myOriginalHierarchicalContainer
 Hierarchical container with parent and children. More...
 
std::map< GNEHierarchicalElement *, GNEHierarchicalContainer > myHierarchicalContainers
 map with hierarchical container of all parent and children elements More...
 
void restoreHierarchicalContainers ()
 restore container (only use in undo() function) More...
 
template<typename T >
void addElementInParentsAndChildren (T *element)
 add given element into parents and children (only use in redo() function) More...
 
template<typename T >
void removeElementFromParentsAndChildren (T *element)
 remove given element from parents and children (only use in redo() function) More...
 

Detailed Description

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

Definition at line 32 of file GNEChange_EnableAttribute.h.

Constructor & Destructor Documentation

◆ GNEChange_EnableAttribute() [1/2]

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

constructor

Parameters
[in]acThe attribute-carrier to be modified
[in]keyThe attribute key
[in]valueThe new value

Definition at line 35 of file GNEChange_EnableAttribute.cpp.

◆ GNEChange_EnableAttribute() [2/2]

GNEChange_EnableAttribute::GNEChange_EnableAttribute ( GNEAttributeCarrier *  ac,
const SumoXMLAttr  key,
const bool  value,
const int  previousParameters 
)

constructor

Parameters
[in]acThe attribute-carrier to be modified
[in]keyThe attribute key
[in]valueThe new value
[in]previousParametersprevious values (used by flows)

Definition at line 45 of file GNEChange_EnableAttribute.cpp.

References GNEAttributeCarrier::getTagProperty(), GNETagProperties::getTagStr(), GNEReferenceCounter::incRef(), and myAC.

◆ ~GNEChange_EnableAttribute()

GNEChange_EnableAttribute::~GNEChange_EnableAttribute ( )

Destructor.

Definition at line 55 of file GNEChange_EnableAttribute.cpp.

References GNEReferenceCounter::decRef(), GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagProperty(), GNEAttributeCarrier::getTagStr(), GNETagProperties::getTagStr(), 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_EnableAttribute::redo ( )
virtual

redo action

Implements GNEChange.

Definition at line 90 of file GNEChange_EnableAttribute.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_EnableAttribute::redoName ( ) const
virtual

get Redo name

Implements GNEChange.

Definition at line 121 of file GNEChange_EnableAttribute.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagStr(), myAC, myNewValue, 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 GNEChangeGroup::size().

Here is the caller graph for this function:

◆ undo()

void GNEChange_EnableAttribute::undo ( )
virtual

undo action

Implements GNEChange.

Definition at line 69 of file GNEChange_EnableAttribute.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_EnableAttribute::undoName ( ) const
virtual

return undoName

Implements GNEChange.

Definition at line 111 of file GNEChange_EnableAttribute.cpp.

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

Field Documentation

◆ myAC

GNEAttributeCarrier* GNEChange_EnableAttribute::myAC
private

the net to which all operations shall be applied

Note
we are not responsible for the pointer

Definition at line 73 of file GNEChange_EnableAttribute.h.

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

◆ 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_EnableAttribute::myKey
private

The attribute name.

Definition at line 76 of file GNEChange_EnableAttribute.h.

Referenced by redo(), and undo().

◆ myNewValue

const bool GNEChange_EnableAttribute::myNewValue
private

the new value

Definition at line 82 of file GNEChange_EnableAttribute.h.

Referenced by redo(), redoName(), and undoName().

◆ 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_EnableAttribute::myOrigValue
private

the original value

Definition at line 79 of file GNEChange_EnableAttribute.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: