Container for junctions; performs operations on all stored junctions. More...

#include <MSJunctionControl.h>

Inheritance diagram for MSJunctionControl:

Collaboration diagram for MSJunctionControl:

Public Types
typedef std::map< std::string, MSJunction * >	IDMap
	Definition of the key to pointer map type. More...

Public Member Functions
virtual bool	add (const std::string &id, MSJunction * item)
	Adds an item. More...

bool	changeID (const std::string &oldId, const std::string &newId)
	change ID of a stored object More...

void	clear ()
	Removes all items from the container (deletes them, too) More...

bool	erase (const std::string &id)
	Removes the named item from the container. More...

MSJunction *	get (const std::string &id) const
	Retrieves an item. More...

const IDMap &	getMyMap () const
	Returns a reference to the internal map. More...

void	insertIDs (std::vector< std::string > &into) const

	MSJunctionControl ()
	Constructor. More...

void	postloadInitContainer ()
	Closes building of junctions. More...

virtual bool	remove (const std::string &id)
	Removes an item. More...

int	size () const
	Returns the number of stored items within the container. More...

	~MSJunctionControl ()
	Destructor. More...

Private Member Functions
	MSJunctionControl (const MSJunctionControl &)
	Invalidated copy constructor. More...

MSJunctionControl &	operator= (const MSJunctionControl &)
	Invalidated assignment operator. More...

Detailed Description

Container for junctions; performs operations on all stored junctions.

Definition at line 52 of file MSJunctionControl.h.

Member Typedef Documentation

typedef std::map< std::string, MSJunction * > NamedObjectCont< MSJunction * >::IDMap

inherited

Definition of the key to pointer map type.

Definition at line 57 of file NamedObjectCont.h.

Constructor & Destructor Documentation

MSJunctionControl::MSJunctionControl ( )

Constructor.

Definition at line 41 of file MSJunctionControl.cpp.

MSJunctionControl::~MSJunctionControl ( )

Destructor.

Definition at line 45 of file MSJunctionControl.cpp.

MSJunctionControl::MSJunctionControl ( const MSJunctionControl & )

private

Invalidated copy constructor.

Member Function Documentation

virtual bool NamedObjectCont< MSJunction * >::add	(	const std::string &	id,
		MSJunction *	item
	)

inlinevirtualinherited

Adds an item.

If another item with the same name is already known, false is reported and the item is not added.

Parameters

[in]	id	The id of the item to add
[in]	item	The item to add

Returns: If the item could been added (no item with the same id was within the container before)

Definition at line 79 of file NamedObjectCont.h.

bool NamedObjectCont< MSJunction * >::changeID	(	const std::string &	oldId,
		const std::string &	newId
	)

inlineinherited

change ID of a stored object

Definition at line 175 of file NamedObjectCont.h.

void NamedObjectCont< MSJunction * >::clear ( )

inlineinherited

Removes all items from the container (deletes them, too)

Definition at line 122 of file NamedObjectCont.h.

bool NamedObjectCont< MSJunction * >::erase ( const std::string & id )

inlineinherited

Removes the named item from the container.

If the named object exists, it is deleted, the key is removed from the map, and true is returned. If the id was not known, false is returned.

Parameters

[in] id The id of the item to delete

Returns: Whether the object could be deleted (was within the map)

Definition at line 145 of file NamedObjectCont.h.

MSJunction * NamedObjectCont< MSJunction * >::get ( const std::string & id ) const

inlineinherited

Retrieves an item.

Returns 0 when no item with the given id is stored within the container

Parameters

[in] id The id of the item to retrieve

Returns: The item stored under the given id, or 0 if no such item exists

Definition at line 112 of file NamedObjectCont.h.

const IDMap& NamedObjectCont< MSJunction * >::getMyMap ( ) const

inlineinherited

Returns a reference to the internal map.

Definition at line 189 of file NamedObjectCont.h.

Referenced by postloadInitContainer().

void NamedObjectCont< MSJunction * >::insertIDs ( std::vector< std::string > & into ) const

inlineinherited

Definition at line 167 of file NamedObjectCont.h.

MSJunctionControl& MSJunctionControl::operator= ( const MSJunctionControl & )

private

Invalidated assignment operator.

void MSJunctionControl::postloadInitContainer ( )

Closes building of junctions.

Calls "postloadInit" on all stored junctions.

Exceptions

ProcessError From the called "postloadInit"

See also: MSJunction::postloadInit

Definition at line 50 of file MSJunctionControl.cpp.

References NamedObjectCont< MSJunction * >::getMyMap(), and NODETYPE_INTERNAL.

Referenced by MSNet::closeBuilding().

virtual bool NamedObjectCont< MSJunction * >::remove ( const std::string & id )

inlinevirtualinherited

Removes an item.

Parameters

[in]	id	The id of the item to remove
[in]	del	delete item after removing of container

Returns: If the item could been removed (an item with the id was within the container before)

Definition at line 93 of file NamedObjectCont.h.

int NamedObjectCont< MSJunction * >::size ( ) const

inlineinherited

Returns the number of stored items within the container.

Definition at line 132 of file NamedObjectCont.h.

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

Public Types

Public Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation