List of GuiCameras saved as QSharedPointers. More...

#include <GuiCameraList.h>

Inherits QObject, and QList< GuiCameraQsp >.

Signals
void	countChanged (int newCount)
	Emitted when the number of GuiCameras in the list changes. More...

Public Member Functions
	GuiCameraList (QString name, QString path, QObject *parent=NULL)
	Create an gui camera list from a gui camera list name and path (does not read GuiCamera objects). More...

	GuiCameraList (QObject *parent=NULL)
	Create a blank gui camera list. More...

	GuiCameraList (QList< GuiCameraQsp >, QObject *parent=NULL)
	Create a gui camera list from a list of GuiCamera's. More...

	GuiCameraList (Project project, XmlStackedHandlerReader xmlReader, QObject *parent=NULL)
	Create an image list from XML. More...

	GuiCameraList (const GuiCameraList &)
	Copy constructor. More...

	~GuiCameraList ()
	Create a gui camera list from a list of gui camera file names. More...

void	append (GuiCameraQsp const &value)
	Appends a single GuiCamera to the list. More...

void	append (const QList< GuiCameraQsp > &value)
	Appends another GuiCameraList to the list. More...

void	clear ()
	Clears the list. More...

iterator	erase (iterator pos)
	Removes the GuiCamera associated with an iterator. More...

iterator	erase (iterator begin, iterator end)
	Removes all GuiCameras from begin up to, but not inclusing end. More...

void	insert (int i, GuiCameraQsp const &value)
	Inserts a GuiCamera into the list at a given index. More...

iterator	insert (iterator before, GuiCameraQsp const &value)
	Inserts a GuiCamera in front of the GuiCamera associated with an iterator. More...

void	prepend (GuiCameraQsp const &value)
	Inserts a GuiCamera at the beginning of the list. More...

void	push_back (GuiCameraQsp const &value)
	Inserts a GuiCamera at the end of the list. More...

void	push_front (GuiCameraQsp const &value)
	Inserts a GuiCamera at the front of the list. More...

int	removeAll (GuiCameraQsp const &value)
	Removes all occurances of a GuiCamera from the list. More...

void	removeAt (int i)
	Removes the GuiCamera at a specific index. More...

void	removeFirst ()
	Removes the first GuiCamera in the list. More...

void	removeLast ()
	Removes the last GuiCamera in the list. More...

bool	removeOne (GuiCameraQsp const &value)
	Removes the first occurance of a GuiCamera from the list. More...

void	swap (QList< GuiCameraQsp > &other)
	Swaps the list with another GuiCameraList. More...

GuiCameraQsp	takeAt (int i)
	Removes and returns the GuiCamera at a specific index. More...

GuiCameraQsp	takeFirst ()
	Removes and returns the first GuiCamera in the list. More...

GuiCameraQsp	takeLast ()
	Removes and returns the last GuiCamera in the list. More...

GuiCameraList &	operator+= (const QList< GuiCameraQsp > &other)
	Appends another GuiCameraList to the list and returns a reference to this. More...

GuiCameraList &	operator+= (GuiCameraQsp const &other)
	Appends a GuiCamera to the list and returns a reference to this. More...

GuiCameraList &	operator<< (const QList< GuiCameraQsp > &other)
	Appends another GuiVameraList to the list and returns a reference to this. More...

GuiCameraList &	operator<< (GuiCameraQsp const &other)
	Appends a GuiCamera to the list and returns a reference to this. More...

GuiCameraList &	operator= (const QList< GuiCameraQsp > &rhs)
	Assigns a list of GuiCameras to the list. More...

GuiCameraList &	operator= (const GuiCameraList &rhs)
	Assignment operator. More...

QList< QAction * >	supportedActions (Project *project=NULL)

bool	allSupport (GuiCameraDisplayProperties::Property prop)

void	setName (QString newName)
	Gets a list of pre-connected actions that have to do with display, such as color, alpha, outline, fill, etc. More...

void	setPath (QString newPath)
	Set the relative path (from the project root) to this gui camera list's folder. More...

QString	name () const
	Get the human-readable name of this gui cameray list. More...

QString	path () const
	Get the path to these gui camera objects in the list (relative to project root). More...

void	save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const
	Delete all of the contained GuiCamera objects from disk (see GuiCamera::deleteFromDisk()) More...

Detailed Description

List of GuiCameras saved as QSharedPointers.

Overrides many QList methods in order to emit signals about that status of the list.

List of GuiCameras.

Author: 2015-06-11 Ken Edmundson

Constructor & Destructor Documentation

Isis::GuiCameraList::GuiCameraList	(	QString	name,
		QString	path,
		QObject *	parent = `NULL`
	)

Create an gui camera list from a gui camera list name and path (does not read GuiCamera objects).

Parameters

name	The GuiCameraList's name (i.e. import1, import2, ...)
path	The GuiCameraList's folder name (i.e. import1, import2, ...)
parent	The Qt-relationship parent

References name(), and path().

Isis::GuiCameraList::GuiCameraList ( QObject * parent = NULL )

explicit

Create a blank gui camera list.

Parameters

parent The Qt-relationship parent

Isis::GuiCameraList::GuiCameraList	(	QList< GuiCameraQsp >	guiCameras,
		QObject *	parent = `NULL`
	)

explicit

Create a gui camera list from a list of GuiCamera's.

Parameters

guiCameras	The list of guiCamera's
parent	The Qt-relationship parent

References append().

Isis::GuiCameraList::GuiCameraList	(	Project *	project,
		XmlStackedHandlerReader *	xmlReader,
		QObject *	parent = `NULL`
	)

explicit

Create an image list from XML.

Parameters

project	The project with the gui camera list
xmlReader	The XML reader currently at an <GuiCameraList> tag.
parent	The Qt-relationship parent

References Isis::XmlStackedHandlerReader::pushContentHandler().

Isis::GuiCameraList::GuiCameraList ( const GuiCameraList & src )

Copy constructor.

Parameters

other The GuiCameraList to copy

Isis::GuiCameraList::~GuiCameraList ( )

Create a gui camera list from a list of gui camera file names.

This is slow (serial) and not recommended. Destructor. This does not free the GuiCamera objects from memory.

Member Function Documentation

bool Isis::GuiCameraList::allSupport ( GuiCameraDisplayProperties::Property prop )

void Isis::GuiCameraList::append ( GuiCameraQsp const & value )

Appends a single GuiCamera to the list.

Parameters

value The GuiCamera to be appened

See Also: QList<GuiCameraQsp>::append()

References countChanged().

Referenced by GuiCameraList().

void Isis::GuiCameraList::append ( const QList< GuiCameraQsp > & value )

Appends another GuiCameraList to the list.

Parameters

value The GuiCameraList to be appened

See Also: QList<GuiCameraQsp>::append()

References countChanged().

void Isis::GuiCameraList::clear ( )

Clears the list.

See Also: QList<GuiCameraQsp>::clear()

References countChanged().

void Isis::GuiCameraList::countChanged ( int newCount )

signal

Emitted when the number of GuiCameras in the list changes.

Not currently connected to anything.

Referenced by append(), clear(), erase(), insert(), operator+=(), operator<<(), operator=(), prepend(), push_back(), push_front(), removeAll(), removeAt(), removeFirst(), removeLast(), removeOne(), swap(), takeAt(), takeFirst(), and takeLast().

QList< GuiCameraQsp >::iterator Isis::GuiCameraList::erase ( iterator pos )

Removes the GuiCamera associated with an iterator.

Returns an iterator associated with the next GuiCamera in the list.

Parameters

pos	An iterator associated with the GuiCamera to be erased

Returns: QList<GuiCameraQsq>::iteraror Iterator associated with the next GuiCamera

See Also: QList<GuiCameraQsp>::erase()

References countChanged().

QList< GuiCameraQsp >::iterator Isis::GuiCameraList::erase	(	iterator	begin,
		iterator	end
	)

Removes all GuiCameras from begin up to, but not inclusing end.

Returns an iterator associated with GuiCamera that was associated with end.

Parameters

begin	An iterator associated with the first GuiCamera to be removed
end	An iterator associated with the GuiCamera after the last GuiCamera to be removed

Returns: QList<GuiCameraQsp>::iteraror Iterator associated with the GuiCamera that was associated with end.

See Also: QList<GuiCameraQsp>::erase()

References countChanged().

void Isis::GuiCameraList::insert	(	int	i,
		GuiCameraQsp const &	value
	)

Inserts a GuiCamera into the list at a given index.

Parameters

i	The index the GuiCamera will be inserted at
value	The GuiCamera to be inserted

See Also: QList<GuiCameraQsp>::insert()

References countChanged().

QList< GuiCameraQsp >::iterator Isis::GuiCameraList::insert	(	iterator	before,
		GuiCameraQsp const &	value
	)

Inserts a GuiCamera in front of the GuiCamera associated with an iterator.

Returns an iterator associated with the inserted GuiCamera.

Parameters

before	An iterator associated with the GuiCamera that value will be inserted in front of
value	The GuiCamera to be inserted.

Returns: QList<GuiCameraQsp>::iterator Iterator associated with the inserted GuiCamera

See Also: QList<GuiCameraQsp>::insert()

References countChanged().

QString Isis::GuiCameraList::name ( ) const

Get the human-readable name of this gui cameray list.

Returns: QString The name of the gui camera list (or an empty string if anonymous).

Referenced by GuiCameraList().

GuiCameraList & Isis::GuiCameraList::operator+= ( const QList< GuiCameraQsp > & other )

Appends another GuiCameraList to the list and returns a reference to this.

Parameters

other The GuiCameraList to be appended

Returns: QuiCameraList & A reference to this

See Also: QList<GuiCameraQsp>::operator+=()

References countChanged().

GuiCameraList & Isis::GuiCameraList::operator+= ( GuiCameraQsp const & other )

Appends a GuiCamera to the list and returns a reference to this.

Parameters

other The GuiCamera to be appended

Returns: GuiCameraList & A reference to this

See Also: QList<GuiCameraQsp>::operator+=()

References countChanged().

GuiCameraList & Isis::GuiCameraList::operator<< ( const QList< GuiCameraQsp > & other )

Appends another GuiVameraList to the list and returns a reference to this.

Parameters

other The GuiCameraList to be appened

Returns: GuiCameraList & A reference to this

See Also: QList<GuiCameraQsp>::operator<<()

References operator<<().

GuiCameraList & Isis::GuiCameraList::operator<< ( GuiCameraQsp const & other )

Appends a GuiCamera to the list and returns a reference to this.

Parameters

other The GuiCamera to be appended

Returns: GuiCameraList & A reference to this

See Also: QList<GuiCameraQsp>::operator<<()

References countChanged(), and operator<<().

GuiCameraList & Isis::GuiCameraList::operator= ( const QList< GuiCameraQsp > & rhs )

Assigns a list of GuiCameras to the list.

Does not modify m_name or m_path.

Parameters

rhs	the list being assigned from

Returns: GuiCameraList & A reference to this

See Also: QList<GuiCameraQsp>::operator=()

References countChanged().

GuiCameraList & Isis::GuiCameraList::operator= ( const GuiCameraList & rhs )

Assignment operator.

Parameters

rhs	The right hand side of the '=' operator

Returns: GuiCameraList & A reference to this

References countChanged().

QString Isis::GuiCameraList::path ( ) const

Get the path to these gui camera objects in the list (relative to project root).

This only applies to a gui camera list from the project.

Returns: Qstring The path to the gui camera objects in the list (or an empty string if unknown).

Referenced by GuiCameraList().

void Isis::GuiCameraList::prepend ( GuiCameraQsp const & value )

Inserts a GuiCamera at the beginning of the list.

Parameters

value The GuiCamera to be inserted.

See Also: QList<GuiCameraQsp>::prepend()

References countChanged().

void Isis::GuiCameraList::push_back ( GuiCameraQsp const & value )

Inserts a GuiCamera at the end of the list.

Equivalent to append.

Parameters

value The GuiCamera to be inserted.

See Also: QList<GuiCameraQsp>::push_back()

References countChanged().

void Isis::GuiCameraList::push_front ( GuiCameraQsp const & value )

Inserts a GuiCamera at the front of the list.

Equivalent to prepend.

Parameters

value The GuiCamera to be inserted.

See Also: QList<GuiCameraQsp>::push_front()

References countChanged().

int Isis::GuiCameraList::removeAll ( GuiCameraQsp const & value )

Removes all occurances of a GuiCamera from the list.

Returns the number removed.

Parameters

value The GuiCamera to be removed

Returns: int The number of GuiCameras removed

See Also: QList<GuiCameraQsp>::removeAll()

References countChanged().

void Isis::GuiCameraList::removeAt ( int i )

Removes the GuiCamera at a specific index.

Parameters

i	The index of the GuiCamera to be removed

See Also: QList<GuiCameraQsp>::removeAt()

References countChanged().

void Isis::GuiCameraList::removeFirst ( )

Removes the first GuiCamera in the list.

See Also: QList<GuiCameraQsp>::removeFirst()

References countChanged().

void Isis::GuiCameraList::removeLast ( )

Removes the last GuiCamera in the list.

See Also: QList<GuiCameraQsp>::removeLast()

References countChanged().

bool Isis::GuiCameraList::removeOne ( GuiCameraQsp const & value )

Removes the first occurance of a GuiCamera from the list.

Returns whether or not it succeeded.

Parameters

value The GuiCamera to be removed

Returns: bool True if successful

See Also: QList<GuiCameraQsp>::removeOne()

References countChanged().

void Isis::GuiCameraList::save	(	QXmlStreamWriter &	stream,
		const Project *	project,
		FileName	newProjectRoot
	)		const

Delete all of the contained GuiCamera objects from disk (see GuiCamera::deleteFromDisk())

Convert this gui camera list into XML format for saving/restoring capabilities. Not currently implemented

This writes:

  <GuiCameraList name="..." path="...">

to the given xml stream, and creates a 'targets.xml' inside the folder with the target body objects. Inside the images.xml, this writes:

  <targets>
    ...
  </targets>

void Isis::GuiCameraList::setName ( QString newName )

Gets a list of pre-connected actions that have to do with display, such as color, alpha, outline, fill, etc.

Returns true if all of the given displays support the property

Parameters

prop	The property we're testing for support for
displays	The displays we're doing the test on Set the human-readable name of this gui camera list. This is really only useful for project gui camera lists (not anonymous temporary ones).
newName	The name to give this gui camera list

void Isis::GuiCameraList::setPath ( QString newPath )

Set the relative path (from the project root) to this gui camera list's folder.

This is really only useful for project gui camera lists (not anonymous temporary ones).

Parameters

newPath The path to the gui camera objects in this gui camera list

QList<QAction *> Isis::GuiCameraList::supportedActions ( Project * project = NULL )

void Isis::GuiCameraList::swap ( QList< GuiCameraQsp > & other )

Swaps the list with another GuiCameraList.

Parameters

other The GuiCameraList to swap with

See Also: QList<GuiCameraQsp>::swap()

References countChanged().

GuiCameraQsp Isis::GuiCameraList::takeAt ( int i )

Removes and returns the GuiCamera at a specific index.

Parameters

i	The index of GuiCamera to be removed

Returns: QuiCameraQsp The GuiCamera removed

See Also: QList<GuiCameraQsp>::takeAt()

References countChanged().

GuiCameraQsp Isis::GuiCameraList::takeFirst ( )

Removes and returns the first GuiCamera in the list.

Returns: GuiCameraQsp The GuiCamera removed

See Also: QList<GuiCameraQsp>::takeFirst()

References countChanged().

GuiCameraQsp Isis::GuiCameraList::takeLast ( )

Removes and returns the last GuiCamera in the list.

Returns: GuiCameraQsp The GuiCamera removed

See Also: QList<GuiCameraQsp>::takeLast()

References countChanged().

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

src/qisis/objs/GuiCameraList/GuiCameraList.h
src/qisis/objs/GuiCameraList/GuiCameraList.cpp
src/qisis/objs/GuiCameraList/moc_GuiCameraList.cpp

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation