GUISelectedStorage::SingleTypeSelections Class Reference

#include <GUISelectedStorage.h>

---

Detailed Description

A container for ids of selected objects of a certain type.

Definition at line 247 of file GUISelectedStorage.h.

Public Member Functions
void	clear () throw ()
	Clears the list of selected objects.
void	deselect (GLuint id) throw ()
	Deselects the object with the given id from the list of selected objects.
const std::vector< GLuint > &	getSelected () const throw ()
	Returns the list of selected ids.
bool	isSelected (GLuint id) throw ()
	Returns the information whether the object with the given id is qithin the selection.
void	load (const std::string &filename) throw (IOError)
	Loads the list of selected objects to a file named as given.
void	save (const std::string &filename) throw (IOError)
	Saves the list of selected objects to a file named as given.
void	select (GLuint id) throw ()
	Adds the object with the given id to the list of selected objects.
	SingleTypeSelections () throw ()
	Constructor.
	~SingleTypeSelections () throw ()
	Destructor.
Private Attributes
std::vector< GLuint >	mySelected
	The list of selected ids.

---

Constructor & Destructor Documentation

GUISelectedStorage::SingleTypeSelections::SingleTypeSelections

(

)

throw ()

Constructor.

Definition at line 50 of file GUISelectedStorage.cpp.

{}

GUISelectedStorage::SingleTypeSelections::~SingleTypeSelections

(

)

throw ()

Destructor.

Definition at line 53 of file GUISelectedStorage.cpp.

{}

---

Member Function Documentation

void GUISelectedStorage::SingleTypeSelections::clear

(

)

throw ()

Clears the list of selected objects.

Definition at line 82 of file GUISelectedStorage.cpp.

References mySelected.

Referenced by GUISelectedStorage::clear().

                                                      {
    mySelected.clear();
}

void GUISelectedStorage::SingleTypeSelections::deselect

(

GLuint

id

)

throw ()

Deselects the object with the given id from the list of selected objects.

Parameters:

[in]

id

The id of the object

Definition at line 73 of file GUISelectedStorage.cpp.

References mySelected.

Referenced by GUISelectedStorage::deselect().

                                                                  {
    std::vector<GLuint>::iterator i = find(mySelected.begin(), mySelected.end(), id);
    if (i!=mySelected.end()) {
        mySelected.erase(i);
    }
}

const std::vector< GLuint > & GUISelectedStorage::SingleTypeSelections::getSelected

(

)

const throw ()

Returns the list of selected ids.

Returns:

A list containing the ids of all selected objects

Definition at line 113 of file GUISelectedStorage.cpp.

References mySelected.

Referenced by GUISelectedStorage::getSelected().

                                                                  {
    return mySelected;
}

bool GUISelectedStorage::SingleTypeSelections::isSelected

(

GLuint

id

)

throw ()

Returns the information whether the object with the given id is qithin the selection.

Parameters:

[in]

id

The id of the object

Returns:

Whether the object is selected

Definition at line 57 of file GUISelectedStorage.cpp.

References mySelected.

Referenced by GUISelectedStorage::isSelected().

                                                                    {
    std::vector<GLuint>::iterator i = find(mySelected.begin(), mySelected.end(), id);
    return i!=mySelected.end();
}

void GUISelectedStorage::SingleTypeSelections::load

(

const std::string &

filename

)

throw (IOError)

Loads the list of selected objects to a file named as given.

Parameters:

[in]

filename

The name of the file to read the list from

Exceptions:

IOError

recheck!!!

Todo:

Recheck: is this used(?)

Todo:

Recheck usage of IOError

Definition at line 88 of file GUISelectedStorage.cpp.

Referenced by GUISelectedStorage::load().

                                                                                     {
    std::ifstream strm(filename.c_str());
    while (strm.good()) {
        std::string name;
        strm >> name;
    }
}

void GUISelectedStorage::SingleTypeSelections::save

(

const std::string &

filename

)

throw (IOError)

Saves the list of selected objects to a file named as given.

Parameters:

[in]

filename

The name of the file to save the list into

Exceptions:

IOError

recheck!!!

Todo:

Recheck: is this used(?)

Todo:

Recheck usage of IOError

Definition at line 98 of file GUISelectedStorage.cpp.

References OutputDevice::close(), OutputDevice::getDevice(), GUIGlObject::getFullName(), GUIGlObjectStorage::getObjectBlocking(), GUIGlObjectStorage::gIDStorage, mySelected, and GUIGlObjectStorage::unblockObject().

Referenced by GUISelectedStorage::save().

                                                                                     {
    OutputDevice &dev = OutputDevice::getDevice(filename);
    for (std::vector<GLuint>::iterator i=mySelected.begin(); i!=mySelected.end(); ++i) {
        GUIGlObject *object = GUIGlObjectStorage::gIDStorage.getObjectBlocking(*i);
        if (object!=0) {
            std::string name = object->getFullName();
            dev << name << "\n";
            GUIGlObjectStorage::gIDStorage.unblockObject(*i);
        }
    }
    dev.close();
}

void GUISelectedStorage::SingleTypeSelections::select

(

GLuint

id

)

throw ()

Adds the object with the given id to the list of selected objects.

Parameters:

[in]

id

The id of the object

Definition at line 64 of file GUISelectedStorage.cpp.

References mySelected.

Referenced by GUISelectedStorage::select().

                                                                {
    std::vector<GLuint>::iterator i = find(mySelected.begin(), mySelected.end(), id);
    if (i==mySelected.end()) {
        mySelected.push_back(id);
    }
}

---

Field Documentation

std::vector<GLuint> GUISelectedStorage::SingleTypeSelections::mySelected [private]

The list of selected ids.

Definition at line 304 of file GUISelectedStorage.h.

Referenced by clear(), deselect(), getSelected(), isSelected(), save(), and select().

---

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

• GUISelectedStorage.h
• GUISelectedStorage.cpp