Isis 3 Programmer Reference
Signals | Public Member Functions | Static Public Member Functions | Private Slots | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
Isis::CnetDisplayProperties Class Reference

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

#include <CnetDisplayProperties.h>

Inheritance diagram for Isis::CnetDisplayProperties:
Inheritance graph
Collaboration diagram for Isis::CnetDisplayProperties:
Collaboration graph

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
 
void setCubeList (QString fileName)
 
void setFileNameUsage (bool preferFileNames)
 
void setShowsFullPaths (bool newState)
 

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
 

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_".

Definition at line 41 of file CnetDisplayProperties.h.

Constructor & Destructor Documentation

◆ ~CnetDisplayProperties()

Isis::CnetDisplayProperties::~CnetDisplayProperties ( )
virtual

Definition at line 84 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 260 of file CnetDisplayProperties.cpp.

◆ composeStatusUpdated

void Isis::CnetDisplayProperties::composeStatusUpdated ( )
privateslot

Definition at line 293 of file CnetDisplayProperties.cpp.

◆ currentlyComposing()

bool Isis::CnetDisplayProperties::currentlyComposing ( ) const

Definition at line 99 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 112 of file CnetDisplayProperties.cpp.

References getImageName().

◆ getFileName()

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

Definition at line 128 of file CnetDisplayProperties.cpp.

◆ getImageName()

QString Isis::CnetDisplayProperties::getImageName ( QString cubeSerialNumber,
bool forceFullPaths = false ) const
Parameters
cubeSerialNumberCube 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 152 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 175 of file CnetDisplayProperties.cpp.

◆ getShowsFullPaths()

bool Isis::CnetDisplayProperties::getShowsFullPaths ( ) const

Definition at line 198 of file CnetDisplayProperties.cpp.

◆ nullify()

void Isis::CnetDisplayProperties::nullify ( )
private

Definition at line 282 of file CnetDisplayProperties.cpp.

◆ serialNumbersComposed

void Isis::CnetDisplayProperties::serialNumbersComposed ( )
privateslot

Definition at line 298 of file CnetDisplayProperties.cpp.

◆ setCubeList()

void Isis::CnetDisplayProperties::setCubeList ( QString fileName)

Definition at line 203 of file CnetDisplayProperties.cpp.

◆ setFileNameUsage()

void Isis::CnetDisplayProperties::setFileNameUsage ( bool preferFileNames)

Definition at line 237 of file CnetDisplayProperties.cpp.

◆ setShowsFullPaths()

void Isis::CnetDisplayProperties::setShowsFullPaths ( bool newState)

Definition at line 255 of file CnetDisplayProperties.cpp.

Member Data Documentation

◆ m_composedCount

QAtomicInt* Isis::CnetDisplayProperties::m_composedCount
private

Definition at line 95 of file CnetDisplayProperties.h.

◆ m_composeStatusPoller

QTimer* Isis::CnetDisplayProperties::m_composeStatusPoller
private

Definition at line 93 of file CnetDisplayProperties.h.

◆ m_composeWatcher

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

Definition at line 92 of file CnetDisplayProperties.h.

◆ m_curComposing

bool Isis::CnetDisplayProperties::m_curComposing
private

Definition at line 97 of file CnetDisplayProperties.h.

◆ m_instance

CnetDisplayProperties * Isis::CnetDisplayProperties::m_instance = NULL
staticprivate

Definition at line 101 of file CnetDisplayProperties.h.

◆ m_interruptFlag

QAtomicInt* Isis::CnetDisplayProperties::m_interruptFlag
private

Definition at line 96 of file CnetDisplayProperties.h.

◆ m_readWriteLock

QReadWriteLock* Isis::CnetDisplayProperties::m_readWriteLock
private

Definition at line 99 of file CnetDisplayProperties.h.

◆ m_serialNumberToFileNameMap

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

Definition at line 90 of file CnetDisplayProperties.h.

◆ m_showFullPath

bool Isis::CnetDisplayProperties::m_showFullPath
private

Definition at line 98 of file CnetDisplayProperties.h.

◆ useFileNames

bool Isis::CnetDisplayProperties::useFileNames
private

Definition at line 89 of file CnetDisplayProperties.h.

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