Isis Developer Reference
|
Internalizes a list of shapes and allows for operations on the entire list. More...
#include <ShapeList.h>
Signals | |
void | countChanged (int newCount) |
Public Member Functions | |
ShapeList (QString name, QString path, QObject *parent=NULL) | |
Creates an shape list from an shape list name and path (does not read Shapes). | |
ShapeList (QObject *parent=NULL) | |
Creates a blank shape list. | |
ShapeList (QList< Shape * >, QObject *parent=NULL) | |
Creates an shape list from a list of shapes. | |
ShapeList (QStringList &) | |
Creates an shape list from a list of cube file names. | |
ShapeList (const ShapeList &) | |
Copy constructor. | |
~ShapeList () | |
Destructor. | |
SerialNumberList | serialNumberList () |
Creates a SerialNumberList from the shape list. | |
void | append (Shape *const &value) |
Appends an shape to the shape list. | |
void | append (const QList< Shape * > &value) |
Appends a list of shapes to the shape list. | |
void | clear () |
Clears the shape list. | |
iterator | erase (iterator pos) |
Erases a single shape from the shape list. | |
iterator | erase (iterator begin, iterator end) |
Erases a range of shapes from the shape list. | |
void | insert (int i, Shape *const &value) |
Inserts an shape into the shape list at an index. | |
iterator | insert (iterator before, Shape *const &value) |
Inserts an shape into the shape list after an iterator. | |
void | prepend (Shape *const &value) |
Inserts an shape at the beginning of the shape list. | |
void | push_back (Shape *const &value) |
Appends an shape to the end of the shape list. | |
void | push_front (Shape *const &value) |
Prepends an shape to the beginning of the shape list. | |
int | removeAll (Shape *const &value) |
Removes all occurances of an shape. | |
void | removeAt (int i) |
Removes the shape at an index. | |
void | removeFirst () |
Removes the shape at the front of the shape list. | |
void | removeLast () |
Removes the shape at the end of the shape list. | |
bool | removeOne (Shape *const &value) |
Removes the first occurance of an shape. | |
void | swap (QList< Shape * > &other) |
Swaps the shape list with another list of shapes. | |
Shape * | takeAt (int i) |
Removes the shape at an index and returns it. | |
Shape * | takeFirst () |
Removes and returns the first shape. | |
Shape * | takeLast () |
Removes and returns the last shape. | |
ShapeList & | operator+= (const QList< Shape * > &other) |
Appends a list of shapes to the end of the shape list. | |
ShapeList & | operator+= (Shape *const &other) |
Appends a single shape to the end of the shape list. | |
ShapeList & | operator<< (const QList< Shape * > &other) |
Appends a list of shapes to the end of the shape list. | |
ShapeList & | operator<< (Shape *const &other) |
Appends a single shape to the end of the shape list. | |
ShapeList & | operator= (const QList< Shape * > &rhs) |
Assigns another list of shapes to the shape list. | |
ShapeList & | operator= (const ShapeList &rhs) |
Assignment operator. | |
void | setName (QString newName) |
Set the human-readable name of this shape list. | |
void | setPath (QString newPath) |
Set the relative path (from the project root) to this shape list's folder. | |
QString | name () const |
Get the human-readable name of this shape list. | |
QString | path () const |
Get the path to the shapes in the shape list (relative to project root). | |
void | deleteFromDisk (Project *project) |
Delete all of the contained Shapes from disk. | |
void | save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const |
Convert this shape list into XML format for saving/restoring capabilities. | |
Internalizes a list of shapes and allows for operations on the entire list.
This class reads a list of shapes from an shapes.xml file and internalizes them as aQList of shapes. It also allows for modifications to the entire list of shapes and storing the shape list as an shapes.xml file.
Isis::ShapeList::ShapeList | ( | QString | name, |
QString | path, | ||
QObject * | parent = NULL ) |
|
explicit |
Creates a blank shape list.
parent | The Qt-relationship parent. |
Creates an shape list from a list of shapes.
shapes | The list of shapes. |
parent | The Qt-relationship parent. |
References append().
|
explicit |
Creates an shape list from a list of cube file names.
This is slow (serial) and not recommended.
fileNames | The list of cube fileNames. |
References append().
Isis::ShapeList::ShapeList | ( | const ShapeList & | other | ) |
Copy constructor.
other | The shape list to copy. |
Isis::ShapeList::~ShapeList | ( | ) |
Destructor.
This does not free the Shapes from memory.
Appends a list of shapes to the shape list.
value | the list of shapes to be appened. |
References countChanged().
void Isis::ShapeList::append | ( | Shape *const & | value | ) |
Appends an shape to the shape list.
value | The shape to be appended. |
References countChanged().
Referenced by Isis::WorkOrder::isExecutable(), Isis::WorkOrder::setData(), ShapeList(), and ShapeList().
void Isis::ShapeList::clear | ( | ) |
|
signal |
Referenced by append(), append(), clear(), erase(), erase(), insert(), insert(), operator+=(), operator+=(), operator<<(), operator<<(), operator=(), operator=(), prepend(), push_back(), push_front(), removeAll(), removeAt(), removeFirst(), removeLast(), removeOne(), swap(), takeAt(), takeFirst(), and takeLast().
void Isis::ShapeList::deleteFromDisk | ( | Project * | project | ) |
Delete all of the contained Shapes from disk.
project | The project the shapes in the shape list belong to. |
References Isis::Shape::deleteFromDisk(), and Isis::Project::shapeDataRoot().
Referenced by Isis::ImportShapesWorkOrder::undoExecution().
Erases a range of shapes from the shape list.
Erases all shapes from begin up to (but not including) end.
begin | An iterator pointing to the first shape to be erased. |
end | An iterator pointing to the shape just after the last shape to be erased. Will be invalid after the call. |
References countChanged().
Erases a single shape from the shape list.
pos | An iterator pointing to the shape to be erased. |
References countChanged().
void Isis::ShapeList::insert | ( | int | i, |
Shape *const & | value ) |
Inserts an shape into the shape list at an index.
i | The index at which to insert the shape. |
value | the shape to be inserted. |
References countChanged().
Inserts an shape into the shape list after an iterator.
before | An iterator pointing to the shape that value will be inserted after |
value | The shape to be inserted. |
References countChanged().
QString Isis::ShapeList::name | ( | ) | const |
Get the human-readable name of this shape list.
Referenced by Isis::ProjectItem::setShapeList(), Isis::Project::shapeList(), and ShapeList().
Appends a list of shapes to the end of the shape list.
other | The list of shapes to be appended. |
References countChanged().
Appends a single shape to the end of the shape list.
other | The shape to be appended. |
References countChanged().
Appends a list of shapes to the end of the shape list.
other | The list of shapes to be appended. |
References countChanged().
Appends a single shape to the end of the shape list.
other | The shape to be appended. |
References countChanged().
Assigns another list of shapes to the shape list.
rhs | The list of shapes that shapeList will become a copy of. |
References countChanged().
Assignment operator.
rhs | The right hand side of the '=' operator |
References countChanged().
QString Isis::ShapeList::path | ( | ) | const |
Get the path to the shapes in the shape list (relative to project root).
This only applies to an shape list from the project.
Referenced by Isis::ProjectItem::setShapeList(), and ShapeList().
void Isis::ShapeList::prepend | ( | Shape *const & | value | ) |
Inserts an shape at the beginning of the shape list.
value | The shape to be inserted. |
References countChanged().
void Isis::ShapeList::push_back | ( | Shape *const & | value | ) |
Appends an shape to the end of the shape list.
Equivalent to append().
value | The shape to be appended. |
References countChanged().
void Isis::ShapeList::push_front | ( | Shape *const & | value | ) |
Prepends an shape to the beginning of the shape list.
Equivalent to prepend().
value | The shape to be appended. |
References countChanged().
int Isis::ShapeList::removeAll | ( | Shape *const & | value | ) |
Removes all occurances of an shape.
value | The shape to be removed. |
References countChanged().
void Isis::ShapeList::removeAt | ( | int | i | ) |
Removes the shape at an index.
i | The index of the shape to be removed. |
References countChanged().
void Isis::ShapeList::removeFirst | ( | ) |
Removes the shape at the front of the shape list.
References countChanged().
void Isis::ShapeList::removeLast | ( | ) |
Removes the shape at the end of the shape list.
References countChanged().
bool Isis::ShapeList::removeOne | ( | Shape *const & | value | ) |
Removes the first occurance of an shape.
value | The shape to be removed. |
References countChanged().
void Isis::ShapeList::save | ( | QXmlStreamWriter & | stream, |
const Project * | project, | ||
FileName | newProjectRoot ) const |
Convert this shape list into XML format for saving/restoring capabilities.
This writes:
<shapeList name="..." path="...">
to the given xml stream, and creates an 'shapes.xml' inside the folder with the shapes. Inside the shapes.xml, this writes:
<shapes> ... </shapes>
stream | XmlStream to write out the document. |
project | The project the shape list will be saved to. |
newProjectRoot | The path to the root directory for the new project. |
iException::Io | "Failed to create directory" |
iException::Io | "Unable to save shape information because new file could not be opened for writing" |
References _FILEINFO_, Isis::FileName::dir(), Isis::IException::Io, Isis::FileName::original(), Isis::FileName::path(), Isis::Shape::save(), Isis::Project::shapeDataRoot(), and Isis::FileName::toString().
SerialNumberList Isis::ShapeList::serialNumberList | ( | ) |
Creates a SerialNumberList from the shape list.
References Isis::SerialNumberList::add().
void Isis::ShapeList::setName | ( | QString | newName | ) |
Set the human-readable name of this shape list.
This is really only useful for project shape lists (not anonymous temporary ones).
newName | The name to give this shape list |
Referenced by Isis::ProjectItemModel::setData().
void Isis::ShapeList::setPath | ( | QString | newPath | ) |
Set the relative path (from the project root) to this shape list's folder.
This is really only useful for project shape lists (not anonymous temporary ones).
newPath | The path to the shapes in this shape list |
Swaps the shape list with another list of shapes.
other | The list of shapes to swapped with. |
References countChanged().
Shape * Isis::ShapeList::takeAt | ( | int | i | ) |
Removes the shape at an index and returns it.
i | The index of the shape to be removed and returned. |
References countChanged().
Shape * Isis::ShapeList::takeFirst | ( | ) |
Removes and returns the first shape.
References countChanged().
Shape * Isis::ShapeList::takeLast | ( | ) |
Removes and returns the last shape.
References countChanged().