#include <ControlNetVitals.h>

Inheritance diagram for Isis::ControlNetVitals:

Collaboration diagram for Isis::ControlNetVitals:

Public Slots
void	validate ()
	This method is designed to evaluate the current vitals of the network to determine if any weaknesses are present and update the status of the network.

void	validateNetwork (ControlNet::ModType)
	This SLOT is designed to intercept the networkModified() signal emitted by a Control Network whenever a modification is made to the network.

void	addPoint (ControlPoint *)
	This SLOT is designed to intercept the newPoint() signal emitted from a ControlNetwork whenever a new point has been added.

void	pointModified (ControlPoint *, ControlPoint::ModType, QVariant, QVariant)
	This SLOT is designed to receive a signal emitted from the Control Network whenever a modification is made to a Control Point.

void	deletePoint (ControlPoint *)
	This SLOT is designed to intercept the removePoint() signal emitted by a Control Network whenever a point is deleted.

void	addMeasure (ControlMeasure *)
	This SLOT is designed to intercept the newMeasure() signal emitted by a Control Network whenever a measure is added to one of it's Control Points.

void	measureModified (ControlMeasure *, ControlMeasure::ModType, QVariant, QVariant)
	This SLOT is designed to intercept the measureModified() signal emitted by a Control Network whenever a measure is modified in one of it's Control Points.

void	deleteMeasure (ControlMeasure *)
	This SLOT is designed to intercept the measureRemoved() signal emitted by a Control Network whenever a Control Measure is deleted.

Signals
void	networkChanged ()

void	historyEntry (QString, QString, QVariant, QVariant, QString)

Public Member Functions
	ControlNetVitals (ControlNet *net)
	Constructs a ControlNetVitals object from a ControlNet.

virtual	~ControlNetVitals ()
	De-constructor.

void	initializeVitals ()
	This will initialize all necessary values and set up the point measure and image measure QMaps appropriately.

bool	hasIslands ()
	This method is designed to return true if islands exist in the ControlNet Graph and False otherwise.

int	numIslands ()
	This method is designed to return the number of islands that exist in the ControlNet Graph.

const QList< QList< QString > > &	getIslands ()
	This method is designed to return a QList containing each island present in the ControlNet.

ControlPoint *	getPoint (QString id)
	This method is designed to return the Control Point with the associated point id from the Control Network.

int	numPoints ()
	This method is designed to return the number of points in the Control Network.

int	numIgnoredPoints ()
	This method is designed to return the number of ignored points in the Control Network.

int	numLockedPoints ()
	This method is designed to return the number of edit locked points in the Control Network.

int	numFixedPoints ()
	This method is designed to return the number of fixed points in the Control Network.

int	numConstrainedPoints ()
	This method is designed to return the number of constrained points in the Control Network.

int	numFreePoints ()
	This method is designed to return the number of free points in the Control Network.

int	numPointsBelowMeasureThreshold (int num=3)
	This method is designed to return the number of points that fall below a measure threshold.

int	numImages ()
	This method is designed to return the number of images in the Control Network.

int	numMeasures ()
	This method is designed to return the number of measures in the Control Network.

int	numImagesBelowMeasureThreshold (int num=3)
	This method is designed to return the number of images that fall below a measure threshold.

int	numImagesBelowHullTolerance (int tolerance=75)
	This method is designed to return the number of images that fall below a hull tolerance.

QList< QString >	getCubeSerials ()
	This method is designed to return all cube serials present in the Control Network.

QList< ControlPoint * >	getAllPoints ()
	This method is designed to return all points in the Control Network.

QList< ControlPoint * >	getIgnoredPoints ()
	This method is designed to return all ignored points in the Control Network.

QList< ControlPoint * >	getLockedPoints ()
	This method is designed to return all edit locked points in the Control Network.

QList< ControlPoint * >	getFixedPoints ()
	This method is designed to return all fixed points in the Control Network.

QList< ControlPoint * >	getConstrainedPoints ()
	This method is designed to return all constrained points in the Control Network.

QList< ControlPoint * >	getFreePoints ()
	This method is designed to return all free points in the Control Network.

QList< ControlPoint * >	getPointsBelowMeasureThreshold (int num=3)
	This method is designed to return all points that fall below a measure threshold.

QList< QString >	getImagesBelowMeasureThreshold (int num=3)
	This method is designed to return a QList containing cube serials for all images that fall below a measure threshold.

QList< QString >	getImagesBelowHullTolerance (int num=75)
	This method is designed to return a QList containing cube serials for all images that fall below a convex hull tolerance threshold.

QString	getNetworkId ()
	This method is designed to return networkId of the observed Control Network.

QString	getStatus ()
	This method is designed to return the current status of the network.

QString	getStatusDetails ()
	This method is designed to return details for the status of the network.

void	emitHistoryEntry (QString entry, QString id, QVariant oldValue, QVariant newValue)
	This method is designed to be called whenever a modification is made to the network, or any of it's control points or measures.

Private Member Functions
void	addMeasureToCounts (ControlMeasure *measure)
	Add a measure to the internal counters.

void	removeMeasureFromCounts (ControlMeasure *measure)
	Remove a measure from the internal counters.

Private Attributes
ControlNet *	m_controlNet
	The Control Network that the vitals class is observing.

QString	m_status
	The string representing the status of the net. Healthy, Weak, or Broken.

QString	m_statusDetails
	The string providing details into the status of the network.

QList< QList< QString > >	m_islandList
	A QList containing every island in the net. Each island consists of a QList containing All cube serials for that island.

QMap< int, int >	m_pointMeasureCounts
	The measureCount maps track how many points/images have how many measures. For instance, if I wanted to know how many points have 3 measures I would query the m_pointMeasureCounts with a key of 3 and it would return how many points have 3 measures.

QMap< int, int >	m_imageMeasureCounts
	The same is true for imageMeasureCounts, except for images.

QMap< ControlPoint::PointType, int >	m_pointTypeCounts
	The pointTypeCounts operates in the same fashion as the above two, except that the key would be the ControlPoint::PointType you're searching for. For instance, if I wanted to know how many points were fixed I would query This map at key ControlPoint::Fixed and it would return how many fixed points there are.

int	m_numPoints
	The number of points in the network.

int	m_numPointsIgnored
	The number of ignored points in the network.

int	m_numPointsLocked
	The number of edit locked points in the network.

int	m_numMeasures
	The number of measures in the network.

Detailed Description

ControlNetVitals.

This class is designed to represent the health of a control network. It utilizes signals and slots to listen for changes in an observed Control Network and re-evaluates the health of a network whenever a change is made. It tracks several statistics, and is intended to be the back-end for the ControlHealthMonitorWidget that is located in IPCE.

The ControlNetVitals class keeps track of several member variables that are a running counter for network statistics in regard to the health of the observed network. It creates these variables upon intialization and references these internal variables when returning certain statistics about a Control Network that can't be accessed by wrapper methods for the network itself. It then listens for specific signals to be emitted whenever a change is made to the network to update it's internal counters with respect to that change.

Author: 2018-05-28 Adam Goins

History

2018-05-28 Adam Goins - Initial Creation.

2018-06-14 Adam Goins & Jesse Maple - Refactored method calls and Signal/Slot usage.

2018-06-15 Adam Goins - Added documentation.

2018-06-25 Kristin Berry - Fixed problem with getImagesBelowMeasureThreshold().size() not matching numImagesBelowMeasureThreshold(). Fixed a similar problem with numPointsBelowMeasureThreshold().

2018-07-03 Jesse Mapel - Fixed deleting control points not properly updating the point counters.

Definition at line 51 of file ControlNetVitals.h.

Constructor & Destructor Documentation

◆ ControlNetVitals()

Isis::ControlNetVitals::ControlNetVitals ( ControlNet * cnet )

Constructs a ControlNetVitals object from a ControlNet.

once complete, it calls the validate() method to evaluate the current status of the newly ingested Control Network.

Parameters

cnet	The Control Network that we will be tracking vitals for.

Definition at line 32 of file ControlNetVitals.cpp.

References addMeasure(), addPoint(), deleteMeasure(), deletePoint(), initializeVitals(), m_controlNet, measureModified(), pointModified(), validate(), and validateNetwork().

◆ ~ControlNetVitals()

Isis::ControlNetVitals::~ControlNetVitals ( )

virtual

De-constructor.

Definition at line 511 of file ControlNetVitals.cpp.

Member Function Documentation

◆ addMeasure

void Isis::ControlNetVitals::addMeasure ( ControlMeasure * measure )

slot

This SLOT is designed to intercept the newMeasure() signal emitted by a Control Network whenever a measure is added to one of it's Control Points.

It grabs the parent Control Point of the Measure and decrements the pointMeasureCount QMap at the old measure count for the Control Point and increments the pointMeasureCount at the new measure count for the Control Point to reflect the addition of this measure.

This does not modify any counters based on the measures in the point because separate measureDeleted signals will be emitted by the ControlNet. addPoint does add modify counters based on measures because ControlNet does not emit separate measureAdded signals for efficiency reasons.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Parameters

measure The Control Measure being added to a Control Point in the network.

Definition at line 327 of file ControlNetVitals.cpp.

References addMeasureToCounts(), emitHistoryEntry(), m_numMeasures, and validate().

Referenced by ControlNetVitals().

◆ addMeasureToCounts()

void Isis::ControlNetVitals::addMeasureToCounts ( ControlMeasure * measure )

private

Add a measure to the internal counters.

Parameters

measure The measure to add

Definition at line 407 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetNumberOfValidMeasuresInImage(), Isis::ControlPoint::GetNumValidMeasures(), m_controlNet, m_imageMeasureCounts, and m_pointMeasureCounts.

Referenced by addMeasure(), and measureModified().

◆ addPoint

void Isis::ControlNetVitals::addPoint ( ControlPoint * point )

slot

This SLOT is designed to intercept the newPoint() signal emitted from a ControlNetwork whenever a new point has been added.

It observes the Control Point and increments the appropriate internal counters to reflect the addition of this new point.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Unlike deletePoint(), this method does modify counters based on measures because the ControlNet does not emit separate measureAdded signals for efficiency reasons.

Parameters

point The ControlPoint being added to the network.

Definition at line 129 of file ControlNetVitals.cpp.

References emitHistoryEntry(), Isis::ControlPoint::GetId(), Isis::ControlNet::GetNumMeasures(), Isis::ControlPoint::GetNumValidMeasures(), Isis::ControlPoint::GetType(), m_controlNet, m_numMeasures, m_numPoints, m_numPointsIgnored, m_numPointsLocked, m_pointMeasureCounts, m_pointTypeCounts, and validate().

Referenced by ControlNetVitals(), and initializeVitals().

◆ deleteMeasure

void Isis::ControlNetVitals::deleteMeasure ( ControlMeasure * measure )

slot

This SLOT is designed to intercept the measureRemoved() signal emitted by a Control Network whenever a Control Measure is deleted.

It observes the to-be deleted point and decrements the appropriate internal counters to reflect the removal of this Control Measure.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Parameters

point The Control Measure being deleted from a Control Point in the Control Network.

Definition at line 390 of file ControlNetVitals.cpp.

References emitHistoryEntry(), m_numMeasures, removeMeasureFromCounts(), and validate().

Referenced by ControlNetVitals().

◆ deletePoint

void Isis::ControlNetVitals::deletePoint ( ControlPoint * point )

slot

This SLOT is designed to intercept the removePoint() signal emitted by a Control Network whenever a point is deleted.

It observes the to-be deleted point and decrements the appropriate internal counters to reflect the removal of this point.

This does not modify any counters based on the measures in the point because separate measureDeleted signals will be emitted by the ControlNet. addPoint does add modify counters based on measures because ControlNet does not emit separate measureAdded signals for efficiency reasons.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Parameters

point The Control Point being deleted from the Control Network.

Definition at line 285 of file ControlNetVitals.cpp.

References emitHistoryEntry(), Isis::ControlPoint::GetId(), Isis::ControlPoint::GetNumValidMeasures(), Isis::ControlPoint::GetType(), m_numPoints, m_numPointsIgnored, m_numPointsLocked, m_pointMeasureCounts, m_pointTypeCounts, and validate().

Referenced by ControlNetVitals().

◆ emitHistoryEntry()

void Isis::ControlNetVitals::emitHistoryEntry	(	QString	entry,
		QString	id,
		QVariant	oldValue,
		QVariant	newValue )

This method is designed to be called whenever a modification is made to the network, or any of it's control points or measures.

It receives all of the components that make up the history entry (the comment, the ID of what was modified, oldValue, newValue) and emits them along with a timestamp of when the modification was made.

The historyEntry() will pass these values on to the listening SLOT in the health monitor widget so that it can be displayed in the history table.

Parameters

entry	The history comment that includes what modification was made.
id	The ID of the object modified. This can be a point id, measure serial, or net id.
oldValue	The oldValue the object had before the modification.
newValue	The newValue the object had after its modification.

Definition at line 110 of file ControlNetVitals.cpp.

References Isis::toString().

Referenced by addMeasure(), addPoint(), deleteMeasure(), deletePoint(), measureModified(), pointModified(), and validateNetwork().

◆ getAllPoints()

QList< ControlPoint * > Isis::ControlNetVitals::getAllPoints ( )

This method is designed to return all points in the Control Network.

Returns: A QList<ControlPoint*> containing all points in the Control Network.

Definition at line 705 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetPoints(), and m_controlNet.

◆ getConstrainedPoints()

QList< ControlPoint * > Isis::ControlNetVitals::getConstrainedPoints ( )

This method is designed to return all constrained points in the Control Network.

Returns: A QList<ControlPoint*> containing all constrained points in the Control Network.

Definition at line 757 of file ControlNetVitals.cpp.

References Isis::ControlPoint::Constrained, Isis::ControlNet::GetPoints(), Isis::ControlPoint::GetType(), and m_controlNet.

◆ getCubeSerials()

QList< QString > Isis::ControlNetVitals::getCubeSerials ( )

This method is designed to return all cube serials present in the Control Network.

Returns: A QList<QString> containing all cube serials in the Control Network.

Definition at line 695 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetCubeSerials(), and m_controlNet.

◆ getFixedPoints()

QList< ControlPoint * > Isis::ControlNetVitals::getFixedPoints ( )

This method is designed to return all fixed points in the Control Network.

Returns: A QList<ControlPoint*> containing all fixed points in the Control Network.

Definition at line 743 of file ControlNetVitals.cpp.

References Isis::ControlPoint::Fixed, Isis::ControlNet::GetPoints(), Isis::ControlPoint::GetType(), and m_controlNet.

◆ getFreePoints()

QList< ControlPoint * > Isis::ControlNetVitals::getFreePoints ( )

This method is designed to return all free points in the Control Network.

Returns: A QList<ControlPoint*> containing all free points in the Control Network.

Definition at line 771 of file ControlNetVitals.cpp.

References Isis::ControlPoint::Free, Isis::ControlNet::GetPoints(), Isis::ControlPoint::GetType(), and m_controlNet.

◆ getIgnoredPoints()

QList< ControlPoint * > Isis::ControlNetVitals::getIgnoredPoints ( )

This method is designed to return all ignored points in the Control Network.

Returns: A QList<ControlPoint*> containing all ignored points in the Control Network.

Definition at line 715 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetPoints(), and m_controlNet.

◆ getImagesBelowHullTolerance()

QList< QString > Isis::ControlNetVitals::getImagesBelowHullTolerance ( int num = 75 )

This method is designed to return a QList containing cube serials for all images that fall below a convex hull tolerance threshold.

For instance, a tolerance of .75 would return all images with a hull tolerance less than 75%.

Parameters

num	The hull tolerance (decimal percent) an image needs to meet the threshold.

Returns: A QList<QString> containing all images with a hull tolerance below the threshold.

Definition at line 826 of file ControlNetVitals.cpp.

◆ getImagesBelowMeasureThreshold()

QList< QString > Isis::ControlNetVitals::getImagesBelowMeasureThreshold ( int num = 3 )

This method is designed to return a QList containing cube serials for all images that fall below a measure threshold.

For instance, a measure threshold of 3 would return all images with less than 3 measures.

Parameters

num	The number of measures an image needs to have to meet the threshold.

Returns: A QList<QString> containing all images with number of measures less than the threshold.

Definition at line 806 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetCubeSerials(), Isis::ControlNet::GetValidMeasuresInCube(), and m_controlNet.

◆ getIslands()

const QList< QList< QString > > & Isis::ControlNetVitals::getIslands ( )

This method is designed to return a QList containing each island present in the ControlNet.

Each island is composed of another QList containing the cube serials for all cubes in that island.

Returns: A QList containing a QList of cube serials for each island present in the Control Net.

Definition at line 544 of file ControlNetVitals.cpp.

References m_islandList.

◆ getLockedPoints()

QList< ControlPoint * > Isis::ControlNetVitals::getLockedPoints ( )

This method is designed to return all edit locked points in the Control Network.

Returns: A QList<ControlPoint*> containing all edit locked points in the Control Network.

Definition at line 729 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetPoints(), and m_controlNet.

◆ getNetworkId()

QString Isis::ControlNetVitals::getNetworkId ( )

This method is designed to return networkId of the observed Control Network.

It is a wrapper for the ControlNet::GetNetworkId() call of the observed Control Network.

Returns: A QString containing the NetworkId of the Control Network.

Definition at line 865 of file ControlNetVitals.cpp.

References m_controlNet.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ getPoint()

ControlPoint * Isis::ControlNetVitals::getPoint ( QString id )

This method is designed to return the Control Point with the associated point id from the Control Network.

Parameters

id	The Point ID of the control point to be fetched.

Returns: The Control Point with the associated point id.

Definition at line 265 of file ControlNetVitals.cpp.

References m_controlNet.

Referenced by Isis::ControlHealthMonitorWidget::emitOpenPointEditor().

◆ getPointsBelowMeasureThreshold()

QList< ControlPoint * > Isis::ControlNetVitals::getPointsBelowMeasureThreshold ( int num = 3 )

This method is designed to return all points that fall below a measure threshold.

For instance, a measure threshold of 3 would return all points with less than 3 measures.

Parameters

num	The number of measures a point needs to have to meet the threshold.

Returns: All of points with number of measures less than the threshold.

Definition at line 788 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetPoints(), and m_controlNet.

◆ getStatus()

QString Isis::ControlNetVitals::getStatus ( )

This method is designed to return the current status of the network.

The possible values are "Healthy!", "Weak!", "Broken!"

Returns: A QString indicating the status of the Control Network.

Definition at line 839 of file ControlNetVitals.cpp.

References m_status.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ getStatusDetails()

QString Isis::ControlNetVitals::getStatusDetails ( )

This method is designed to return details for the status of the network.

This QString could contain several details if the status is weak, if more than one factor contribute to the weakness of the network. Details are separated by newline '
' in the QString.

Returns: A QString containing details for the status of the Control Network.

Definition at line 853 of file ControlNetVitals.cpp.

References m_statusDetails.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ hasIslands()

bool Isis::ControlNetVitals::hasIslands ( )

This method is designed to return true if islands exist in the ControlNet Graph and False otherwise.

Returns: True if islands exist, False otherwise.

Definition at line 521 of file ControlNetVitals.cpp.

References numIslands().

Referenced by validate().

◆ initializeVitals()

void Isis::ControlNetVitals::initializeVitals ( )

This will initialize all necessary values and set up the point measure and image measure QMaps appropriately.

Definition at line 63 of file ControlNetVitals.cpp.

References addPoint(), Isis::ControlPoint::Constrained, Isis::ControlPoint::Fixed, Isis::ControlPoint::Free, Isis::ControlNet::GetCubeSerials(), Isis::ControlNet::GetNumberOfValidMeasuresInImage(), Isis::ControlNet::GetNumMeasures(), Isis::ControlNet::GetPoints(), Isis::ControlNet::GetSerialConnections(), m_controlNet, m_imageMeasureCounts, m_islandList, m_numMeasures, m_numPoints, m_numPointsIgnored, m_numPointsLocked, m_pointMeasureCounts, and m_pointTypeCounts.

Referenced by ControlNetVitals(), and validateNetwork().

◆ measureModified

void Isis::ControlNetVitals::measureModified	(	ControlMeasure *	measure,
		ControlMeasure::ModType	type,
		QVariant	oldValue,
		QVariant	newValue )

slot

This SLOT is designed to intercept the measureModified() signal emitted by a Control Network whenever a measure is modified in one of it's Control Points.

This SLOT receives the ControlMeasure that was modified, as well with the ControlMeasure::ModType enum indicating what type of modification was made to the Control Measure. The appropriate methods are called depending on which modification was made.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Parameters

point	The Control Measure that was modified in the observed Control Network.
type	The type of modification that was made to the Control Measure.
oldValue	The old value (if any) of whatever modification was made to the Control Measure.
newValue	The new value (if any) of whatever modification was made to the Control Measure.

Definition at line 353 of file ControlNetVitals.cpp.

References addMeasureToCounts(), emitHistoryEntry(), removeMeasureFromCounts(), and validate().

Referenced by ControlNetVitals().

◆ numConstrainedPoints()

int Isis::ControlNetVitals::numConstrainedPoints ( )

This method is designed to return the number of constrained points in the Control Network.

Returns: The number of constrained points in the Control Network.

Definition at line 594 of file ControlNetVitals.cpp.

References Isis::ControlPoint::Constrained, and m_pointTypeCounts.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numFixedPoints()

int Isis::ControlNetVitals::numFixedPoints ( )

This method is designed to return the number of fixed points in the Control Network.

Returns: The number of fixed points in the Control Network.

Definition at line 584 of file ControlNetVitals.cpp.

References Isis::ControlPoint::Fixed, and m_pointTypeCounts.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numFreePoints()

int Isis::ControlNetVitals::numFreePoints ( )

This method is designed to return the number of free points in the Control Network.

Returns: The number of free points in the Control Network.

Definition at line 604 of file ControlNetVitals.cpp.

References Isis::ControlPoint::Free, and m_pointTypeCounts.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numIgnoredPoints()

int Isis::ControlNetVitals::numIgnoredPoints ( )

This method is designed to return the number of ignored points in the Control Network.

Returns: The number of ignored points in the Control Network.

Definition at line 564 of file ControlNetVitals.cpp.

References m_numPointsIgnored.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numImages()

int Isis::ControlNetVitals::numImages ( )

This method is designed to return the number of images in the Control Network.

Returns: The number of images in the Control Network.

Definition at line 638 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetCubeSerials(), and m_controlNet.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numImagesBelowHullTolerance()

int Isis::ControlNetVitals::numImagesBelowHullTolerance ( int tolerance = 75 )

This method is designed to return the number of images that fall below a hull tolerance.

For instance, a tolerance of .75 would return all images with a hull tolerance of < 75%.

Parameters

num	The number of measures an image needs to have to meet the threshold.

Returns: The number of images with number of measures less than the threshold.

Definition at line 685 of file ControlNetVitals.cpp.

Referenced by Isis::ControlHealthMonitorWidget::update(), and validate().

◆ numImagesBelowMeasureThreshold()

int Isis::ControlNetVitals::numImagesBelowMeasureThreshold ( int num = 3 )

This method is designed to return the number of images that fall below a measure threshold.

For instance, a measure threshold of 3 would return all images with less than 3 measures.

Parameters

num	The number of measures an image needs to have to meet the threshold.

Returns: The number of images with number of measures less than the threshold.

Definition at line 661 of file ControlNetVitals.cpp.

References m_imageMeasureCounts.

Referenced by Isis::ControlHealthMonitorWidget::update(), and validate().

◆ numIslands()

int Isis::ControlNetVitals::numIslands ( )

This method is designed to return the number of islands that exist in the ControlNet Graph.

Returns: The number of islands present in the ControlNet Graph.

Definition at line 532 of file ControlNetVitals.cpp.

References m_islandList.

Referenced by hasIslands(), and validate().

◆ numLockedPoints()

int Isis::ControlNetVitals::numLockedPoints ( )

This method is designed to return the number of edit locked points in the Control Network.

Returns: The number of edit locked points in the Control Network.

Definition at line 574 of file ControlNetVitals.cpp.

References m_numPointsLocked.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numMeasures()

int Isis::ControlNetVitals::numMeasures ( )

This method is designed to return the number of measures in the Control Network.

Returns: The number of measures in the Control Network.

Definition at line 648 of file ControlNetVitals.cpp.

References m_numMeasures.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numPoints()

int Isis::ControlNetVitals::numPoints ( )

This method is designed to return the number of points in the Control Network.

Returns: The number of points in the Control Network.

Definition at line 554 of file ControlNetVitals.cpp.

References m_numPoints.

Referenced by Isis::ControlHealthMonitorWidget::update().

◆ numPointsBelowMeasureThreshold()

int Isis::ControlNetVitals::numPointsBelowMeasureThreshold ( int num = 3 )

This method is designed to return the number of points that fall below a measure threshold.

For instance, a measure threshold of 3 would return all points with less than 3 measures.

Parameters

num	The number of measures a point needs to have to meet the threshold.

Returns: The number of points with number of measures less than the threshold.

Definition at line 617 of file ControlNetVitals.cpp.

References m_pointMeasureCounts.

Referenced by Isis::ControlHealthMonitorWidget::update(), and validate().

◆ pointModified

void Isis::ControlNetVitals::pointModified	(	ControlPoint *	point,
		ControlPoint::ModType	type,
		QVariant	oldValue,
		QVariant	newValue )

slot

This SLOT is designed to receive a signal emitted from the Control Network whenever a modification is made to a Control Point.

This SLOT receives the ControlPoint that was modified, as well with the ControlPoint::ModType enum indicating what type of modification was made to the Control Point.

We then increment or decrement the appropriate internal counters based on which type of modification was made to the Control Point.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Parameters

point	The Control Point that was modified in the observed Control Network.
type	The type of modification that was made to the Control Point.
oldValue	The old value (if any) of whatever modification was made to the Control Point.
newValue	The new value (if any) of whatever modification was made to the Control Point.

Definition at line 176 of file ControlNetVitals.cpp.

References emitHistoryEntry(), Isis::ControlPoint::GetId(), Isis::ControlPoint::GetNumValidMeasures(), Isis::ControlPoint::GetType(), m_numPointsIgnored, m_numPointsLocked, m_pointMeasureCounts, m_pointTypeCounts, Isis::ControlPoint::PointTypeToString(), and validate().

Referenced by ControlNetVitals().

◆ removeMeasureFromCounts()

void Isis::ControlNetVitals::removeMeasureFromCounts ( ControlMeasure * measure )

private

Remove a measure from the internal counters.

Parameters

measure The measure to remove

Definition at line 443 of file ControlNetVitals.cpp.

References Isis::ControlNet::GetNumberOfValidMeasuresInImage(), Isis::ControlPoint::GetNumValidMeasures(), m_controlNet, m_imageMeasureCounts, and m_pointMeasureCounts.

Referenced by deleteMeasure(), and measureModified().

◆ validate

void Isis::ControlNetVitals::validate ( )

slot

This method is designed to evaluate the current vitals of the network to determine if any weaknesses are present and update the status of the network.

The network status is split into 3 states: Healthy, Weak, and Broken.

Healthy - A network is healthy if there are no weaknesses found and it is not broken. Weak - A network is weak if it has points that fall below the measure threshold, A network is weak if it has images that fall below the measure threshold, A network is weak if it has images that fall below a Convex Hull tolerance. Broken - A network is broken if it has more than 1 island.

Definition at line 882 of file ControlNetVitals.cpp.

References hasIslands(), m_status, m_statusDetails, numImagesBelowHullTolerance(), numImagesBelowMeasureThreshold(), numIslands(), numPointsBelowMeasureThreshold(), and Isis::toString().

Referenced by addMeasure(), addPoint(), ControlNetVitals(), deleteMeasure(), deletePoint(), measureModified(), pointModified(), and validateNetwork().

◆ validateNetwork

void Isis::ControlNetVitals::validateNetwork ( ControlNet::ModType type )

slot

This SLOT is designed to intercept the networkModified() signal emitted by a Control Network whenever a modification is made to the network.

This SLOT receives the ControlNet::ModType enum indicating what type of modication was made to the Control Network. It then acts based on what type of change was made.

Once complete, we then call the validate() method to re-validate the status and details of the Control Network.

Parameters

point The type of modification that was made to the observed Control Network.

Definition at line 487 of file ControlNetVitals.cpp.

References emitHistoryEntry(), Isis::ControlNet::GetSerialConnections(), initializeVitals(), m_controlNet, m_islandList, and validate().

Referenced by ControlNetVitals().

Member Data Documentation

◆ m_controlNet

ControlNet* Isis::ControlNetVitals::m_controlNet

private

The Control Network that the vitals class is observing.

Definition at line 117 of file ControlNetVitals.h.

Referenced by addMeasureToCounts(), addPoint(), ControlNetVitals(), getAllPoints(), getConstrainedPoints(), getCubeSerials(), getFixedPoints(), getFreePoints(), getIgnoredPoints(), getImagesBelowMeasureThreshold(), getLockedPoints(), getNetworkId(), getPoint(), getPointsBelowMeasureThreshold(), initializeVitals(), numImages(), removeMeasureFromCounts(), and validateNetwork().

◆ m_imageMeasureCounts

QMap<int, int> Isis::ControlNetVitals::m_imageMeasureCounts

private

The same is true for imageMeasureCounts, except for images.

Definition at line 134 of file ControlNetVitals.h.

Referenced by addMeasureToCounts(), initializeVitals(), numImagesBelowMeasureThreshold(), and removeMeasureFromCounts().

◆ m_islandList

QList< QList< QString > > Isis::ControlNetVitals::m_islandList

private

A QList containing every island in the net. Each island consists of a QList containing All cube serials for that island.

Definition at line 126 of file ControlNetVitals.h.

Referenced by getIslands(), initializeVitals(), numIslands(), and validateNetwork().

◆ m_numMeasures

int Isis::ControlNetVitals::m_numMeasures

private

The number of measures in the network.

Definition at line 149 of file ControlNetVitals.h.

Referenced by addMeasure(), addPoint(), deleteMeasure(), initializeVitals(), and numMeasures().

◆ m_numPoints

int Isis::ControlNetVitals::m_numPoints

private

The number of points in the network.

Definition at line 143 of file ControlNetVitals.h.

Referenced by addPoint(), deletePoint(), initializeVitals(), and numPoints().

◆ m_numPointsIgnored

int Isis::ControlNetVitals::m_numPointsIgnored

private

The number of ignored points in the network.

Definition at line 145 of file ControlNetVitals.h.

Referenced by addPoint(), deletePoint(), initializeVitals(), numIgnoredPoints(), and pointModified().

◆ m_numPointsLocked

int Isis::ControlNetVitals::m_numPointsLocked

private

The number of edit locked points in the network.

Definition at line 147 of file ControlNetVitals.h.

Referenced by addPoint(), deletePoint(), initializeVitals(), numLockedPoints(), and pointModified().

◆ m_pointMeasureCounts

QMap<int, int> Isis::ControlNetVitals::m_pointMeasureCounts

private

The measureCount maps track how many points/images have how many measures. For instance, if I wanted to know how many points have 3 measures I would query the m_pointMeasureCounts with a key of 3 and it would return how many points have 3 measures.

Definition at line 132 of file ControlNetVitals.h.

Referenced by addMeasureToCounts(), addPoint(), deletePoint(), initializeVitals(), numPointsBelowMeasureThreshold(), pointModified(), and removeMeasureFromCounts().

◆ m_pointTypeCounts

QMap<ControlPoint::PointType, int> Isis::ControlNetVitals::m_pointTypeCounts

private

The pointTypeCounts operates in the same fashion as the above two, except that the key would be the ControlPoint::PointType you're searching for. For instance, if I wanted to know how many points were fixed I would query This map at key ControlPoint::Fixed and it would return how many fixed points there are.

Definition at line 140 of file ControlNetVitals.h.

Referenced by addPoint(), deletePoint(), initializeVitals(), numConstrainedPoints(), numFixedPoints(), numFreePoints(), and pointModified().

◆ m_status

QString Isis::ControlNetVitals::m_status

private

The string representing the status of the net. Healthy, Weak, or Broken.

Definition at line 120 of file ControlNetVitals.h.

Referenced by getStatus(), and validate().

◆ m_statusDetails

QString Isis::ControlNetVitals::m_statusDetails

private

The string providing details into the status of the network.

Definition at line 122 of file ControlNetVitals.h.

Referenced by getStatusDetails(), and validate().

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

src/control/objs/ControlNetVitals/ControlNetVitals.h
src/control/objs/ControlNetVitals/ControlNetVitals.cpp

Public Slots

Signals

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ControlNetVitals()

◆ ~ControlNetVitals()

Member Function Documentation

◆ addMeasure

◆ addMeasureToCounts()

◆ addPoint

◆ deleteMeasure

◆ deletePoint

◆ emitHistoryEntry()

◆ getAllPoints()

◆ getConstrainedPoints()

◆ getCubeSerials()

◆ getFixedPoints()

◆ getFreePoints()

◆ getIgnoredPoints()

◆ getImagesBelowHullTolerance()

◆ getImagesBelowMeasureThreshold()

◆ getIslands()

◆ getLockedPoints()

◆ getNetworkId()

◆ getPoint()

◆ getPointsBelowMeasureThreshold()

◆ getStatus()

◆ getStatusDetails()

◆ hasIslands()

◆ initializeVitals()

◆ measureModified

◆ numConstrainedPoints()

◆ numFixedPoints()

◆ numFreePoints()

◆ numIgnoredPoints()

◆ numImages()

◆ numImagesBelowHullTolerance()

◆ numImagesBelowMeasureThreshold()

◆ numIslands()

◆ numLockedPoints()

◆ numMeasures()

◆ numPoints()

◆ numPointsBelowMeasureThreshold()

◆ pointModified

◆ removeMeasureFromCounts()

◆ validate

◆ validateNetwork

Member Data Documentation

◆ m_controlNet

◆ m_imageMeasureCounts

◆ m_islandList

◆ m_numMeasures

◆ m_numPoints

◆ m_numPointsIgnored

◆ m_numPointsLocked

◆ m_pointMeasureCounts

◆ m_pointTypeCounts

◆ m_status

◆ m_statusDetails