MSJunctionControl Class Reference

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

#include <MSJunctionControl.h>

Inheritance diagram for MSJunctionControl:

Public Member Functions
virtual bool	add (const std::string &id, MSJunction *item)
	Adds an item.
const std::vector< MSJunction * > &	buildAndGetStaticVector () const
void	clear ()
	Removes all items from the container (deletes them, too)
bool	erase (const std::string &id)
	Removes the named item from the container.
MSJunction *	get (const std::string &id) const
	Retrieves an item.
const std::map< std::string, MSJunction * > &	getMyMap () const
std::vector< MSJunction * >	getTempVector () const
void	insertIDs (std::vector< std::string > &into) const
	MSJunctionControl ()
	Constructor.
void	postloadInitContainer ()
	Closes building of junctions.
virtual bool	remove (const std::string &id)
	Removes an item.
unsigned int	size () const
	Returns the number of items within the container.
	~MSJunctionControl ()
	Destructor.
Private Member Functions
	MSJunctionControl (const MSJunctionControl &)
	Invalidated copy constructor.
MSJunctionControl &	operator= (const MSJunctionControl &)
	Invalidated assignment operator.

---

Detailed Description

Container for junctions; performs operations on all stored junctions.

Definition at line 57 of file MSJunctionControl.h.

---

Constructor & Destructor Documentation

MSJunctionControl::MSJunctionControl

(

)

Constructor.

Definition at line 45 of file MSJunctionControl.cpp.

MSJunctionControl::~MSJunctionControl

(

)

Destructor.

Definition at line 49 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
	)		[inline, virtual, inherited]

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 76 of file NamedObjectCont.h.

const std::vector<MSJunction * >& NamedObjectCont< MSJunction * >::buildAndGetStaticVector

(

)

const [inline, inherited]

Definition at line 175 of file NamedObjectCont.h.

Referenced by postloadInitContainer().

void NamedObjectCont< MSJunction * >::clear

(

)

[inline, inherited]

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

Definition at line 119 of file NamedObjectCont.h.

bool NamedObjectCont< MSJunction * >::erase

(

const std::string &

id

)

[inline, inherited]

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 147 of file NamedObjectCont.h.

MSJunction * NamedObjectCont< MSJunction * >::get

(

const std::string &

id

)

const [inline, inherited]

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 109 of file NamedObjectCont.h.

const std::map<std::string, MSJunction * >& NamedObjectCont< MSJunction * >::getMyMap

(

)

const [inline, inherited]

Definition at line 220 of file NamedObjectCont.h.

std::vector<MSJunction * > NamedObjectCont< MSJunction * >::getTempVector

(

)

const [inline, inherited]

Definition at line 195 of file NamedObjectCont.h.

void NamedObjectCont< MSJunction * >::insertIDs

(

std::vector< std::string > &

into

)

const [inline, inherited]

Definition at line 208 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 54 of file MSJunctionControl.cpp.

References NamedObjectCont< MSJunction * >::buildAndGetStaticVector().

Referenced by MSNet::closeBuilding().

virtual bool NamedObjectCont< MSJunction * >::remove

(

const std::string &

id

)

[inline, virtual, inherited]

Removes an item.

Parameters:

[in]

id

The id of the item to remove

Returns:

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

Definition at line 90 of file NamedObjectCont.h.

unsigned int NamedObjectCont< MSJunction * >::size

(

)

const [inline, inherited]

Returns the number of items within the container.

Returns:

The number of stored items

Definition at line 133 of file NamedObjectCont.h.

---

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

• MSJunctionControl.h
• MSJunctionControl.cpp