torc::generic::UserDataContainer Class Reference

Represents class that can hold userData. More...

#include <UserDataContainer.hpp>

Inheritance diagram for torc::generic::UserDataContainer:

Public Member Functions
void	getUserData (std::list< std::string > &outUserData) const
void	setUserData (const std::list< std::string > &inSource)
void	addUserData (const std::string &inSource)
	~UserDataContainer () throw ()

Protected Member Functions
	UserDataContainer ()

Private Member Functions
	UserDataContainer (const UserDataContainer &source)
UserDataContainer &	operator= (const UserDataContainer &source)

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 35 of file UserDataContainer.hpp.

Constructor & Destructor Documentation

torc::generic::UserDataContainer::UserDataContainer ( )

protected

Definition at line 38 of file UserDataContainer.cpp.

                                     :
    mUserData() {}

torc::generic::UserDataContainer::~UserDataContainer	(		)
throw	(
	)

Definition at line 41 of file UserDataContainer.cpp.

{}

torc::generic::UserDataContainer::UserDataContainer ( const UserDataContainer &  source )

private

Member Function Documentation

void torc::generic::UserDataContainer::addUserData

(

const std::string &

inSource

)

Add an user data to the list of user data

Parameters

[in]

inSource

An user data as string

Definition at line 34 of file UserDataContainer.cpp.

                                                             {
    mUserData.push_back(inSource);
}

void torc::generic::UserDataContainer::getUserData ( std::list< std::string > &  outUserData ) const

inline

Get the list of all userData

Parameters

[out]

outUserData

The list of all userData

Definition at line 78 of file UserDataContainer.hpp.

                                                                                {
    outUserData.insert(outUserData.end(), mUserData.begin(), mUserData.end());
    return;
}

UserDataContainer& torc::generic::UserDataContainer::operator= ( const UserDataContainer &  source )

private

void torc::generic::UserDataContainer::setUserData

(

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

inSource

)

Set the list of userData

Parameters

[in]

inSource

The list of UserData

Definition at line 26 of file UserDataContainer.cpp.

                                                                      {
    mUserData.insert(mUserData.end(), inSource.begin(), inSource.end());
}

Field Documentation

std::list<std::string> torc::generic::UserDataContainer::mUserData

private

Definition at line 70 of file UserDataContainer.hpp.

---

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

• UserDataContainer.hpp
• UserDataContainer.cpp