UserList Class Reference

#include <UserList.h>

Inheritance diagram for UserList:

[legend]Collaboration diagram for UserList:

[legend]List of all members.

Public Types
typedef User::ID_t	Key
typedef vmap< Key, User * >	UserList_t
typedef UserList_t::iterator	iterator_user
typedef UserList_t::size_type	size_type_user
typedef User::ID_t	ID_t
Public Member Functions
	UserList ()
virtual	~UserList ()
size_type_user	getNumUsers () const
ID_t	getUserListID () const
bool	haveUser (Key key) const
User &	getUser (Key key)
iterator_user	begin_user ()
iterator_user	end_user ()
virtual ID_t	checkinUser (User &user)
virtual void	checkoutUser (Key key, bool informuser=false)
virtual void	checkoutUser (const User &user, bool informuser=false)

---

Detailed Description

Definition at line 37 of file UserList.h.

---

Member Typedef Documentation

typedef User::ID_t UserList::ID_t

Reimplemented in Mesh< Dim >. Definition at line 46 of file UserList.h.

typedef UserList_t::iterator UserList::iterator_user

Definition at line 43 of file UserList.h.

typedef User::ID_t UserList::Key

Definition at line 41 of file UserList.h.

typedef UserList_t::size_type UserList::size_type_user

Definition at line 45 of file UserList.h.

typedef vmap<Key, User *> UserList::UserList_t

Definition at line 42 of file UserList.h.

---

Constructor & Destructor Documentation

UserList::UserList (   )

Definition at line 34 of file UserList.cpp.

UserList::~UserList (   )  [virtual]

Definition at line 39 of file UserList.cpp. References a, begin_user(), and end_user(). Here is the call graph for this function:

---

Member Function Documentation

UserList::iterator_user UserList::begin_user (   )

Definition at line 77 of file UserList.cpp. References vmap< Key, T, Compare >::begin(). Referenced by Mesh< Dim >::begin_if(), FieldLayout< Dim >::begin_if(), and ~UserList(). Here is the call graph for this function:

UserList::ID_t UserList::checkinUser (  User &  user  )  [virtual]

Definition at line 109 of file UserList.cpp. References haveUser(), TAU_PROFILE, TAU_UTILITY, and user. Referenced by RegionLayout< T, Dim, Mesh >::checkin(), Mesh< Dim >::checkin(), and FieldLayout< Dim >::checkin(). Here is the call graph for this function:

void UserList::checkoutUser (  const User &  user, bool  informuser = false )  [virtual]

Definition at line 138 of file UserList.cpp. References checkoutUser(), TAU_PROFILE, TAU_UTILITY, and user. Here is the call graph for this function:

void UserList::checkoutUser (  Key  key, bool  informuser = false )  [virtual]

Definition at line 124 of file UserList.cpp. References end_user(), vmap< Key, T, Compare >::erase(), vmap< Key, T, Compare >::find(), TAU_PROFILE, TAU_UTILITY, and user. Referenced by RegionLayout< T, Dim, Mesh >::checkout(), Mesh< Dim >::checkout(), FieldLayout< Dim >::checkout(), and checkoutUser(). Here is the call graph for this function:

UserList::iterator_user UserList::end_user (   )

Definition at line 84 of file UserList.cpp. References vmap< Key, T, Compare >::end(). Referenced by checkoutUser(), Mesh< Dim >::end_if(), FieldLayout< Dim >::end_if(), getUser(), and ~UserList(). Here is the call graph for this function:

UserList::size_type_user UserList::getNumUsers (   )  const

Definition at line 47 of file UserList.cpp. References vmap< Key, T, Compare >::size(). Referenced by Mesh< Dim >::size_if(), and FieldLayout< Dim >::size_if(). Here is the call graph for this function:

User & UserList::getUser (  Key  key  )

Definition at line 68 of file UserList.cpp. References end_user(), vmap< Key, T, Compare >::find(), PInsist, and user. Here is the call graph for this function:

UserList::ID_t UserList::getUserListID (   )  const

Definition at line 54 of file UserList.cpp. Referenced by RegionLayout< T, Dim, Mesh >::get_Id(), Mesh< Dim >::get_Id(), FieldLayout< Dim >::get_Id(), RegionLayout< T, Dim, MeshType >::notifyUserOfDelete(), SIndex< Dim >::notifyUserOfDelete(), Field< T, Dim, M, C >::notifyUserOfDelete(), BareField< T, Dim >::notifyUserOfDelete(), RegionLayout< T, Dim, MeshType >::Repartition(), ParticleSpatialLayout< T, Dim, Mesh >::Repartition(), ParticleInteractLayout< T, Dim, Mesh >::Repartition(), SIndex< Dim >::Repartition(), and Field< T, Dim, M, C >::Repartition().

bool UserList::haveUser (  Key  key  )  const

Definition at line 61 of file UserList.cpp. References vmap< Key, T, Compare >::count(). Referenced by checkinUser(). Here is the call graph for this function:

---

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

• src/Utility/UserList.h
• src/Utility/UserList.cpp

---