#include <GuiCamera.h>

Inheritance diagram for Isis::GuiCamera:

Collaboration diagram for Isis::GuiCamera:

Public Member Functions
	GuiCamera (Camera camera, QObject parent=0)
	The constructor for this class. More...

	~GuiCamera ()
	The Destructor. More...

bool	operator== (const GuiCamera &srcGuiCamera) const
	Compares two Target Body objects to see if they are equal. More...

const GuiCameraDisplayProperties *	displayProperties () const
	Retrieves the display properties of the camera. More...

QString	id () const
	Output format: More...

QString	instrumentId ()
	Retrieve the InstrumentId as appears in the original cube label. More...

QString	instrumentNameShort ()
	Retrieves an abbreviated version for the name of the instrument. More...

QString	instrumentNameLong ()
	Retrieves a long version for the name of the instrument. More...

QString	spacecraftNameShort ()
	Retrieves an abbbreviated name for the spacecraft. More...

QString	spacecraftNameLong ()
	Retrieves the full name of the spacecraft. More...

Private Member Functions
	GuiCamera (const GuiCamera &other)

GuiCamera &	operator= (const GuiCamera &src)

Private Attributes
QUuid *	m_id
	A unique ID for this GuiCamera object (useful for others to reference this object when saving to disk). More...

GuiCameraDisplayProperties *	m_displayProperties
	Camera. More...

QString	m_instrumentId
	The InstrumentId as it appears on the cube. More...

QString	m_spacecraftNameShort
	An abbreviated name for the spacecraft. More...

QString	m_spacecraftNameLong
	The full spacecraft name. More...

QString	m_instrumentNameShort
	The abbreviated instrument name. More...

QString	m_instrumentNameLong
	The full instrument name. More...

Detailed Description

Container class for GuiCamera.

This class represents a camera in a project-based GUI interface. It encapsulates ideas about a camera such as it's display name, how it should be viewed, where it is on disk, etc.

Author: 2015-06-23 Ken Edmundson

History:: 2015-06-23 Ken Edmundson - Original version.

History:: 2015-10-14 Jeffrey Covington - Declared GuiCameraQsp as a Qt metatype for use with QVariant.

History:: 2016-06-08 Tyler Wilson - Added documentation to some functions and corrected the formatting. Fixes #3997. @hitsory 2018-07-12 Summer Stapleton - Added m_instrumentId and instrumentId() in order to collect the InstrumentId from the original cube label for comparisons related to image imports in ipce. References #5460.

Definition at line 72 of file GuiCamera.h.

Constructor & Destructor Documentation

◆ GuiCamera() [1/2]

Isis::GuiCamera::GuiCamera	(	Camera *	camera,
		QObject *	parent = `0`
	)

The constructor for this class.

Parameters

camera	A traditional Isis::Camera object which we are wrapping in this class.
parent	A pointer to the object instantiating this object.

Definition at line 25 of file GuiCamera.cpp.

References Isis::Camera::instrumentId(), Isis::Camera::instrumentNameLong(), Isis::Camera::instrumentNameShort(), m_displayProperties, m_id, m_instrumentId, m_instrumentNameLong, m_instrumentNameShort, m_spacecraftNameLong, m_spacecraftNameShort, Isis::Camera::spacecraftNameLong(), and Isis::Camera::spacecraftNameShort().

◆ ~GuiCamera()

Isis::GuiCamera::~GuiCamera ( )

The Destructor.

Definition at line 89 of file GuiCamera.cpp.

References m_id.

◆ GuiCamera() [2/2]

Isis::GuiCamera::GuiCamera ( const GuiCamera & other )

private

Author: 2015-06-08 Ken Edmundson

Member Function Documentation

◆ displayProperties()

const GuiCameraDisplayProperties * Isis::GuiCamera::displayProperties ( ) const

Retrieves the display properties of the camera.

Returns: GuiCameraDisplayProperties

Definition at line 133 of file GuiCamera.cpp.

References m_displayProperties.

Referenced by operator==(), and Isis::SensorInfoWidget::SensorInfoWidget().

◆ id()

QString Isis::GuiCamera::id ( ) const

Output format:

(fileName attribute is just the base name) Create an XML Handler (reader) that can populate the BundleSettings class data. See BundleSettings::save() for the expected format.

Parameters

bundleSettings	The image we're going to be initializing
imageFolder	The folder that contains the Cube Handle an XML start element. This expects <image> and <displayProperties> elements.

Returns: If we should continue reading the XML (usually true).

Retrieves a unique, identifying string associated with this GuiCamera object.

Returns: QString returns m_id

Definition at line 298 of file GuiCamera.cpp.

References m_id.

◆ instrumentId()

QString Isis::GuiCamera::instrumentId ( )

Retrieve the InstrumentId as appears in the original cube label.

Returns: QString Returns m_instrumentId

Definition at line 307 of file GuiCamera.cpp.

References m_instrumentId.

◆ instrumentNameLong()

QString Isis::GuiCamera::instrumentNameLong ( )

Retrieves a long version for the name of the instrument.

Returns: QString Returns m_instrumentNameLong.

Definition at line 325 of file GuiCamera.cpp.

References m_instrumentNameLong.

◆ instrumentNameShort()

QString Isis::GuiCamera::instrumentNameShort ( )

Retrieves an abbreviated version for the name of the instrument.

Returns: QString Returns m_instrumentNameShort.

Definition at line 316 of file GuiCamera.cpp.

References m_instrumentNameShort.

◆ operator==()

bool Isis::GuiCamera::operator== ( const GuiCamera & srcGuiCamera ) const

Compares two Target Body objects to see if they are equal.

Parameters

srcGuiCamera GuiCamera object to compare against

Returns: bool Returns True if the objects are equal, False if not.

Definition at line 113 of file GuiCamera.cpp.

References Isis::DisplayProperties::displayName(), displayProperties(), and m_displayProperties.

◆ spacecraftNameLong()

QString Isis::GuiCamera::spacecraftNameLong ( )

Retrieves the full name of the spacecraft.

Returns: QString Returns m_spacecraftNameLong.

Definition at line 343 of file GuiCamera.cpp.

References m_spacecraftNameLong.

Referenced by Isis::SensorInfoWidget::SensorInfoWidget().

◆ spacecraftNameShort()

QString Isis::GuiCamera::spacecraftNameShort ( )

Retrieves an abbbreviated name for the spacecraft.

Returns: QString Returns m_spacecraftNameShort.

Definition at line 334 of file GuiCamera.cpp.

References m_spacecraftNameShort.

Member Data Documentation

◆ m_displayProperties

GuiCameraDisplayProperties* Isis::GuiCamera::m_displayProperties

private

Camera.

target radii sigmas The GUI information for how this camera will be displayed.

Definition at line 166 of file GuiCamera.h.

Referenced by displayProperties(), GuiCamera(), and operator==().

◆ m_id

QUuid* Isis::GuiCamera::m_id

private

A unique ID for this GuiCamera object (useful for others to reference this object when saving to disk).

Definition at line 151 of file GuiCamera.h.

Referenced by GuiCamera(), id(), and ~GuiCamera().

◆ m_instrumentId

QString Isis::GuiCamera::m_instrumentId

private

The InstrumentId as it appears on the cube.

Definition at line 168 of file GuiCamera.h.

Referenced by GuiCamera(), and instrumentId().

◆ m_instrumentNameLong

QString Isis::GuiCamera::m_instrumentNameLong

private

The full instrument name.

Definition at line 176 of file GuiCamera.h.

Referenced by GuiCamera(), and instrumentNameLong().

◆ m_instrumentNameShort

QString Isis::GuiCamera::m_instrumentNameShort

private

The abbreviated instrument name.

Definition at line 174 of file GuiCamera.h.

Referenced by GuiCamera(), and instrumentNameShort().

◆ m_spacecraftNameLong

QString Isis::GuiCamera::m_spacecraftNameLong

private

The full spacecraft name.

Definition at line 172 of file GuiCamera.h.

Referenced by GuiCamera(), and spacecraftNameLong().

◆ m_spacecraftNameShort

QString Isis::GuiCamera::m_spacecraftNameShort

private

An abbreviated name for the spacecraft.

Definition at line 170 of file GuiCamera.h.

Referenced by GuiCamera(), and spacecraftNameShort().

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

src/qisis/objs/GuiCamera/GuiCamera.h
src/qisis/objs/GuiCamera/GuiCamera.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GuiCamera() [1/2]

◆ ~GuiCamera()

◆ GuiCamera() [2/2]

Member Function Documentation

◆ displayProperties()

◆ id()

◆ instrumentId()

◆ instrumentNameLong()

◆ instrumentNameShort()

◆ operator==()

◆ spacecraftNameLong()

◆ spacecraftNameShort()

Member Data Documentation

◆ m_displayProperties

◆ m_id

◆ m_instrumentId

◆ m_instrumentNameLong

◆ m_instrumentNameShort

◆ m_spacecraftNameLong

◆ m_spacecraftNameShort