sends::user_list Class Reference
[Sends Data Classes]

List of known users. More...

#include <user_data.hh>

List of all members.

Public Types
typedef std::map< std::string, user_data >	user_map
typedef user_map::iterator	user_iterator
typedef user_map::const_iterator	const_user_iterator
Public Member Functions
	user_list (void)
	Empty list constructor.
	~user_list (void)
	Destructor.
void	readFile (const std::string &file)
	Fill the list.
const user_data &	operator[] (const std::string &name) const
	Get user data.

---

Detailed Description

List of known users.

The user_list class is a list of user_data acceible by the user name field.

Author:

John Zweizig

Version:

1.0; Last Modified January 23, 2008

---

Member Typedef Documentation

typedef std::map<std::string, user_data> sends::user_list::user_map

User list data type keyed by the user name.

typedef user_map::iterator sends::user_list::user_iterator

User list iterator

typedef user_map::const_iterator sends::user_list::const_user_iterator

Constant user list iterator

---

Constructor & Destructor Documentation

sends::user_list::user_list

(

void

)

Empty list constructor.

Construct an empty user list.

sends::user_list::~user_list

(

void

)

Destructor.

Destroy a user list.

---

Member Function Documentation

void sends::user_list::readFile

(

const std::string &

file

)

Fill the list.

Fill a list from a specified ascii file.

Parameters:

file

Pat to an Ascii file containing the user information.

const user_data& sends::user_list::operator[]

(

const std::string &

name

)

const

Get user data.

Return a constant reference to the user_data object for the specified user name.

Parameters:

name

Constant reference to a string with the user name.

Exceptions:

runtime_error

if the named user is not defined.

Returns:

Constant reference to the user data object.

---

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

• src/base/user_data.hh