GNEChange_DemandElement Class Reference

#include <GNEChange_DemandElement.h>

Inheritance diagram for GNEChange_DemandElement:

Collaboration diagram for GNEChange_DemandElement:

Public Member Functions
	GNEChange_DemandElement (GNEDemandElement *demandElement, bool forward)
	Constructor for creating/deleting an demand element element.
	~GNEChange_DemandElement ()
	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
GNEDemandElement *	myDemandElement
	full information regarding the demand element element that is to be created/deleted

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

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

Definition at line 32 of file GNEChange_DemandElement.h.

Constructor & Destructor Documentation

GNEChange_DemandElement()

GNEChange_DemandElement::GNEChange_DemandElement	(	GNEDemandElement *	demandElement,
		bool	forward
	)

Constructor for creating/deleting an demand element element.

Parameters

[in]	demand	element The demand element element to be created/deleted
[in]	forward	Whether to create/delete (true/false)

Definition at line 38 of file GNEChange_DemandElement.cpp.

~GNEChange_DemandElement()

GNEChange_DemandElement::~GNEChange_DemandElement

(

)

Destructor.

Definition at line 45 of file GNEChange_DemandElement.cpp.

References GNEReferenceCounter::decRef(), GNENetHelper::AttributeCarriers::deleteDemandElement(), GNENet::getAttributeCarriers(), GNEAttributeCarrier::getNet(), GNEAttributeCarrier::getTagStr(), myDemandElement, GNENetHelper::AttributeCarriers::retrieveDemandElement(), 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(), 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_DemandElement::redo ( )

virtual

redo action

Implements GNEChange.

Definition at line 102 of file GNEChange_DemandElement.cpp.

References GNEChange::addElementInParentsAndChildren(), GNENetHelper::AttributeCarriers::deleteDemandElement(), GNENet::getAttributeCarriers(), GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNEHierarchicalContainer::getParents(), GNENet::getSavingStatus(), GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), GNEAttributeCarrier::getTagStr(), GNEViewParent::getTypeFrame(), GNETypeFrame::getTypeSelector(), GNENet::getViewNet(), GNEViewNet::getViewParent(), GNENetHelper::AttributeCarriers::insertDemandElement(), myDemandElement, GNEChange::myForward, GNEChange::myOriginalHierarchicalContainer, GNEChange::mySelectedElement, GNETypeFrame::TypeSelector::refreshTypeSelector(), GNEChange::removeElementFromParentsAndChildren(), GNENetHelper::SavingStatus::requireSaveDemandElements(), GNEAttributeCarrier::selectAttributeCarrier(), SUMO_TAG_VTYPE, GNEAttributeCarrier::unselectAttributeCarrier(), and WRITE_DEBUG.

redoName()

std::string GNEChange_DemandElement::redoName ( ) const

virtual

get Redo name

Implements GNEChange.

Definition at line 153 of file GNEChange_DemandElement.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagStr(), myDemandElement, GNEChange::myForward, 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(), 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(), 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_DemandElement::undo ( )

virtual

undo action

Implements GNEChange.

Definition at line 61 of file GNEChange_DemandElement.cpp.

References GNENetHelper::AttributeCarriers::deleteDemandElement(), GNENet::getAttributeCarriers(), GNEAttributeCarrier::getID(), GNEAttributeCarrier::getNet(), GNEHierarchicalContainer::getParents(), GNENet::getSavingStatus(), GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), GNEAttributeCarrier::getTagStr(), GNEViewParent::getTypeFrame(), GNETypeFrame::getTypeSelector(), GNENet::getViewNet(), GNEViewNet::getViewParent(), GNENetHelper::AttributeCarriers::insertDemandElement(), myDemandElement, GNEChange::myForward, GNEChange::myOriginalHierarchicalContainer, GNEChange::mySelectedElement, GNETypeFrame::TypeSelector::refreshTypeSelector(), GNENetHelper::SavingStatus::requireSaveDemandElements(), GNEChange::restoreHierarchicalContainers(), GNEAttributeCarrier::selectAttributeCarrier(), SUMO_TAG_VTYPE, GNEAttributeCarrier::unselectAttributeCarrier(), and WRITE_DEBUG.

undoName()

std::string GNEChange_DemandElement::undoName ( ) const

virtual

return undoName

Implements GNEChange.

Definition at line 143 of file GNEChange_DemandElement.cpp.

References GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagStr(), myDemandElement, GNEChange::myForward, and TL.

Field Documentation

myDemandElement

GNEDemandElement* GNEChange_DemandElement::myDemandElement

private

full information regarding the demand element element that is to be created/deleted

Note

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

Definition at line 64 of file GNEChange_DemandElement.h.

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

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

myOriginalHierarchicalContainer

const GNEHierarchicalContainer GNEChange::myOriginalHierarchicalContainer

protectedinherited

Hierarchical container with parent and children.

Definition at line 218 of file GNEChange.h.

Referenced by GNEChange::addElementInParentsAndChildren(), redo(), GNEChange::removeElementFromParentsAndChildren(), and 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(), 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(), 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_DemandElement.h
• GNEChange_DemandElement.cpp