Isis::CnetDisplayProperties Class Reference

Handles how control networks should be displayed to the user. More...

#include <CnetDisplayProperties.h>

Inheritance diagram for Isis::CnetDisplayProperties:

Collaboration diagram for Isis::CnetDisplayProperties:

Public Types
enum	coordinateDisplayType { LatLonRadius = 0 , XYZ = 1 }
	Returns coordinate display type (0 = LatLonRadius, 1 = XYZ). More...

Signals
void	composeProgressChanged (int)
void	composeProgressRangeChanged (int, int)
void	compositionFinished ()

Public Member Functions
bool	currentlyComposing () const
QList< QString >	getCubeList (ControlNet *cnet) const
	TODO comment me.
QString	getFileName (QString fileName, bool forceFullPaths=false) const
QString	getImageName (QString cubeSerialNumber, bool forceFullPaths=false) const
QString	getSerialNumber (QString imageId)
bool	getShowsFullPaths () const
CnetDisplayProperties::coordinateDisplayType	coordinateDisplayType ()
void	setCubeList (QString fileName)
void	setFileNameUsage (bool preferFileNames)
void	setShowsFullPaths (bool newState)
void	setCoordinateDisplayType (enum coordinateDisplayType coordDisplay)
	Sets the coordinate display type (0 = LatLonRadius, 1 = XYZ).

Static Public Member Functions
static CnetDisplayProperties *	getInstance ()

Private Slots
void	composeStatusUpdated ()
void	serialNumbersComposed ()

Private Member Functions
	CnetDisplayProperties (CnetDisplayProperties const &)
CnetDisplayProperties &	operator= (CnetDisplayProperties const &)
QMap< QString, QString >	composeSerialNumbers (QStringList fileNames)
void	nullify ()

Private Attributes
bool	useFileNames
QMap< QString, QString > *	m_serialNumberToFileNameMap
QFutureWatcher< QMap< QString, QString > > *	m_composeWatcher
QTimer *	m_composeStatusPoller
QAtomicInt *	m_composedCount
QAtomicInt *	m_interruptFlag
bool	m_curComposing
bool	m_showFullPath
QReadWriteLock *	m_readWriteLock
enum Isis::CnetDisplayProperties::coordinateDisplayType	m_coordinateDisplayType

Static Private Attributes
static CnetDisplayProperties *	m_instance = NULL

Detailed Description

Handles how control networks should be displayed to the user.

This class handles how control networks should be displayed to the user. For example, this class keeps track of whether cube serial numbers or file names should be displayed to the user, and provides an interface to translate between the two.

This class is a singleton.

Author

????-??-?? Eric Hyer

History

2012-09-28 Kimberly Oyama - Changed member variables to be prefixed with "m_".

2019-07-26 Ken Edmundson - OSIRIS-REx modifications... 1) Added enum coordinateDisplayType and associated member variable m_coordinateDisplayType to store current display of point coordinates in either Lat/Lon/Radius or XYZ. 2) Added coordinateDisplayType() and setCoordinateDisplayType() methods. 3) Modified getInstance method, primarily for readibility.

Definition at line 49 of file CnetDisplayProperties.h.

Member Enumeration Documentation

coordinateDisplayType

enum enum CnetDisplayProperties::coordinateDisplayType Isis::CnetDisplayProperties::coordinateDisplayType

Returns coordinate display type (0 = LatLonRadius, 1 = XYZ).

Returns

enum CnetDisplayProperties::coordinateDisplayType.

Definition at line 60 of file CnetDisplayProperties.h.

Constructor & Destructor Documentation

~CnetDisplayProperties()

Isis::CnetDisplayProperties::~CnetDisplayProperties ( )

virtual

Definition at line 85 of file CnetDisplayProperties.cpp.

CnetDisplayProperties()

Isis::CnetDisplayProperties::CnetDisplayProperties ( )

private

Definition at line 42 of file CnetDisplayProperties.cpp.

Member Function Documentation

composeSerialNumbers()

QMap< QString, QString > Isis::CnetDisplayProperties::composeSerialNumbers ( QStringList fileNames )

private

Definition at line 285 of file CnetDisplayProperties.cpp.

composeStatusUpdated

void Isis::CnetDisplayProperties::composeStatusUpdated ( )

privateslot

Definition at line 318 of file CnetDisplayProperties.cpp.

currentlyComposing()

bool Isis::CnetDisplayProperties::currentlyComposing

(

)

const

Definition at line 100 of file CnetDisplayProperties.cpp.

getCubeList()

QList< QString > Isis::CnetDisplayProperties::getCubeList

(

ControlNet *

cnet

)

const

TODO comment me.

If a cube list is currently being loaded, this method will return an empty list. If there is no cube list, it will also return an empty list.

This method is thread safe.

Definition at line 113 of file CnetDisplayProperties.cpp.

References getImageName().

getFileName()

QString Isis::CnetDisplayProperties::getFileName	(	QString	fileName,
		bool	forceFullPaths = false ) const

Definition at line 129 of file CnetDisplayProperties.cpp.

getImageName()

QString Isis::CnetDisplayProperties::getImageName	(	QString	cubeSerialNumber,
		bool	forceFullPaths = false ) const

Parameters

cubeSerialNumber

Cube serial number as a QString

Returns

The file name associated with the given cube serial number, or the given cube serial number if a file name can not be found in the current cube list.

See also

setCubeList()

This method is thread safe!

Definition at line 153 of file CnetDisplayProperties.cpp.

Referenced by getCubeList().

getInstance()

CnetDisplayProperties * Isis::CnetDisplayProperties::getInstance ( )

static

Definition at line 37 of file CnetDisplayProperties.cpp.

getSerialNumber()

QString Isis::CnetDisplayProperties::getSerialNumber

(

QString

imageId

)

Definition at line 176 of file CnetDisplayProperties.cpp.

getShowsFullPaths()

bool Isis::CnetDisplayProperties::getShowsFullPaths

(

)

const

Definition at line 199 of file CnetDisplayProperties.cpp.

nullify()

void Isis::CnetDisplayProperties::nullify ( )

private

Definition at line 307 of file CnetDisplayProperties.cpp.

serialNumbersComposed

void Isis::CnetDisplayProperties::serialNumbersComposed ( )

privateslot

Definition at line 323 of file CnetDisplayProperties.cpp.

setCoordinateDisplayType()

void Isis::CnetDisplayProperties::setCoordinateDisplayType

(

enum coordinateDisplayType

coordDisplay

)

Sets the coordinate display type (0 = LatLonRadius, 1 = XYZ).

Parameters

coordDisplay

coordinate display type.

Returns

void.

Definition at line 280 of file CnetDisplayProperties.cpp.

Referenced by Isis::CnetEditorWidget::setLatLonRadiusCoordinateDisplay(), and Isis::CnetEditorWidget::setXYZCoordinateDisplay().

setCubeList()

void Isis::CnetDisplayProperties::setCubeList

(

QString

fileName

)

Definition at line 215 of file CnetDisplayProperties.cpp.

setFileNameUsage()

void Isis::CnetDisplayProperties::setFileNameUsage

(

bool

preferFileNames

)

Definition at line 249 of file CnetDisplayProperties.cpp.

setShowsFullPaths()

void Isis::CnetDisplayProperties::setShowsFullPaths

(

bool

newState

)

Definition at line 267 of file CnetDisplayProperties.cpp.

Member Data Documentation

m_composedCount

QAtomicInt* Isis::CnetDisplayProperties::m_composedCount

private

Definition at line 111 of file CnetDisplayProperties.h.

m_composeStatusPoller

QTimer* Isis::CnetDisplayProperties::m_composeStatusPoller

private

Definition at line 109 of file CnetDisplayProperties.h.

m_composeWatcher

QFutureWatcher< QMap< QString, QString > >* Isis::CnetDisplayProperties::m_composeWatcher

private

Definition at line 108 of file CnetDisplayProperties.h.

m_coordinateDisplayType

enum Isis::CnetDisplayProperties::coordinateDisplayType Isis::CnetDisplayProperties::m_coordinateDisplayType

private

Definition at line 116 of file CnetDisplayProperties.h.

m_curComposing

bool Isis::CnetDisplayProperties::m_curComposing

private

Definition at line 113 of file CnetDisplayProperties.h.

m_instance

CnetDisplayProperties * Isis::CnetDisplayProperties::m_instance = NULL

staticprivate

Definition at line 118 of file CnetDisplayProperties.h.

m_interruptFlag

QAtomicInt* Isis::CnetDisplayProperties::m_interruptFlag

private

Definition at line 112 of file CnetDisplayProperties.h.

m_readWriteLock

QReadWriteLock* Isis::CnetDisplayProperties::m_readWriteLock

private

Definition at line 115 of file CnetDisplayProperties.h.

m_serialNumberToFileNameMap

QMap< QString, QString >* Isis::CnetDisplayProperties::m_serialNumberToFileNameMap

private

Definition at line 106 of file CnetDisplayProperties.h.

m_showFullPath

bool Isis::CnetDisplayProperties::m_showFullPath

private

Definition at line 114 of file CnetDisplayProperties.h.

useFileNames

bool Isis::CnetDisplayProperties::useFileNames

private

Definition at line 105 of file CnetDisplayProperties.h.

---

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

• src/qisis/objs/CnetEditorWidget/CnetDisplayProperties.h
• src/qisis/objs/CnetEditorWidget/CnetDisplayProperties.cpp