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

#include <GNEChange_Children.h>

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

Public Types

enum  Operation { MOVE_FRONT = 0 , MOVE_BACK = 1 }
 

Public Member Functions

 GNEChange_Children (GNEDemandElement *demandElementParent, GNEDemandElement *demandElementChild, const Operation operation)
 Constructor for creating/deleting an additional element. More...
 
 ~GNEChange_Children ()
 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

GNEDemandElement * myChildDemandElement
 demand element which position will be edited edited More...
 
std::vector< GNEDemandElement * > myEditedChildElements
 element children after apply operation More...
 
const Operation myOperation
 
const std::vector< GNEDemandElement * > myOriginalChildElements
 copy of child demand elements before apply operation More...
 
GNEDemandElement * myParentDemandElement
 full information regarding the parent demand element element that will be modified 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

A network change in which a additional element is created or deleted

Definition at line 32 of file GNEChange_Children.h.

Member Enumeration Documentation

◆ Operation

enum GNEChange_Children::Operation
Enumerator
MOVE_FRONT 
MOVE_BACK 

Definition at line 37 of file GNEChange_Children.h.

Constructor & Destructor Documentation

◆ GNEChange_Children()

GNEChange_Children::GNEChange_Children ( GNEDemandElement *  demandElementParent,
GNEDemandElement *  demandElementChild,
const Operation  operation 
)

Constructor for creating/deleting an additional element.

Parameters
[in]additionalThe additional element to be created/deleted
[in]forwardWhether to create/delete (true/false)

Definition at line 35 of file GNEChange_Children.cpp.

◆ ~GNEChange_Children()

GNEChange_Children::~GNEChange_Children ( )

Destructor.

Definition at line 62 of file GNEChange_Children.cpp.

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

redo action

Implements GNEChange.

Definition at line 109 of file GNEChange_Children.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNENet::getSavingStatus(), GNEAttributeCarrier::getTagStr(), myChildDemandElement, GNEChange::myForward, myOperation, myParentDemandElement, GNENetHelper::SavingStatus::requireSaveDemandElements(), and WRITE_DEBUG.

◆ redoName()

std::string GNEChange_Children::redoName ( ) const
virtual

get Redo name

Implements GNEChange.

Definition at line 167 of file GNEChange_Children.cpp.

References GNEAttributeCarrier::getTagStr(), GNEChange::myForward, myOperation, myParentDemandElement, and TL.

◆ 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_Children::undo ( )
virtual

undo action

Implements GNEChange.

Definition at line 75 of file GNEChange_Children.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNENet::getSavingStatus(), GNEAttributeCarrier::getTagStr(), myChildDemandElement, GNEChange::myForward, myOperation, myParentDemandElement, GNENetHelper::SavingStatus::requireSaveDemandElements(), and WRITE_DEBUG.

◆ undoName()

std::string GNEChange_Children::undoName ( ) const
virtual

return undoName

Implements GNEChange.

Definition at line 143 of file GNEChange_Children.cpp.

References GNEAttributeCarrier::getTagStr(), myChildDemandElement, GNEChange::myForward, myOperation, and TL.

Field Documentation

◆ myChildDemandElement

GNEDemandElement* GNEChange_Children::myChildDemandElement
private

demand element which position will be edited edited

Definition at line 73 of file GNEChange_Children.h.

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

◆ myEditedChildElements

std::vector<GNEDemandElement*> GNEChange_Children::myEditedChildElements
private

element children after apply operation

Definition at line 82 of file GNEChange_Children.h.

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

◆ myOperation

const Operation GNEChange_Children::myOperation
private

Definition at line 76 of file GNEChange_Children.h.

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

◆ myOriginalChildElements

const std::vector<GNEDemandElement*> GNEChange_Children::myOriginalChildElements
private

copy of child demand elements before apply operation

Definition at line 79 of file GNEChange_Children.h.

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

◆ myParentDemandElement

GNEDemandElement* GNEChange_Children::myParentDemandElement
private

full information regarding the parent demand element element that will be modified

Note
we assume shared responsibility for the pointer (via reference counting)

Definition at line 70 of file GNEChange_Children.h.

Referenced by redo(), redoName(), undo(), and ~GNEChange_Children().

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