torc::generic::UserDataContainer Class Reference

Represents class that can hold userData. More...

#include <UserDataContainer.hpp>

Inheritance diagram for torc::generic::UserDataContainer:

[legend]

List of all members.

Public Member Functions
void	getUserData (std::list< std::string > &outUserData) const throw ()
void	setUserData (const std::list< std::string > &inSource) throw ()
void	addUserData (const std::string &inSource) throw ()
Private Member Functions
	UserDataContainer (const UserDataContainer &source) throw ()
UserDataContainer &	operator= (const UserDataContainer &source) throw ()
Private Attributes
std::list< std::string >	mUserData

---

Detailed Description

Represents class that can hold userData.

The UserDataContainer interface is generalized by classes that need to hold one or more userData.

Definition at line 36 of file UserDataContainer.hpp.

---

Member Function Documentation

void torc::generic::UserDataContainer::getUserData

(

std::list< std::string > &

outUserData

)

const throw () [inline]

Get the list of all userData

Parameters:

[out]

outUserData

The list of all userData

Definition at line 84 of file UserDataContainer.hpp.

void torc::generic::UserDataContainer::setUserData

(

const std::list< std::string > &

inSource

)

throw ()

Set the list of userData

Parameters:

[in]

inSource

The list of UserData

Definition at line 28 of file UserDataContainer.cpp.

void torc::generic::UserDataContainer::addUserData

(

const std::string &

inSource

)

throw ()

Add an user data to the list of user data

Parameters:

[in]

inSource

An user data as string

Add an user data to the list of user data

Parameters:

[in]

inSource

An user data as string

Definition at line 40 of file UserDataContainer.cpp.

---

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

• torc/generic/om/UserDataContainer.hpp
• torc/generic/om/UserDataContainer.cpp