USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::ControlGraph Class Reference

Control Network statistics and connectivity. More...

#include <ControlGraph.h>

Public Member Functions

 ControlGraph (ControlNet *someControlNet)
 construct a ControlGraph given a ControlNet
 
 ControlGraph (const ControlGraph &other)
 copy construct a ControlGraph object
 
 ~ControlGraph ()
 Destruct a ControlGraph.
 
const bool IsConnected () const
 Returns true if this ControlGraph is connected or false otherwise.
 
const int GetIslandCount () const
 There can be 0 islands or 2 or more islands.
 
const QVector< QString > GetCubesOnIsland (const int &island) const
 
const QVector< QString > GetCubeList () const
 
const GroupedStatisticsGetMeasureStats (const QString &CubeSerialNumber) const
 
ControlGraphoperator= (const ControlGraph &other)
 

Detailed Description

Control Network statistics and connectivity.

This class is used to store statistics on a Control Network

This class is include safe meaning that includers of this class will only get this class.

Author
2009-09-23 Eric Hyer
See Also
ControlNet ControlPoint ControlMeasure GroupedStatistics

Constructor & Destructor Documentation

Isis::ControlGraph::ControlGraph ( ControlNet someControlNet)

construct a ControlGraph given a ControlNet

Parameters
someControlNetControlNet to construct a ControlGraph from

References Isis::ControlNet::GetNumPoints().

Isis::ControlGraph::ControlGraph ( const ControlGraph other)

copy construct a ControlGraph object

Parameters
otherThe ControlGraph to construct a copy of
Isis::ControlGraph::~ControlGraph ( )

Destruct a ControlGraph.

Member Function Documentation

const QVector< QString > Isis::ControlGraph::GetCubeList ( ) const
Returns
A list of all CubeSerialNumbers in the given ControlNet
const QVector< QString > Isis::ControlGraph::GetCubesOnIsland ( const int &  island) const
Parameters
islandA list of all cubes that are on this island are desired
Returns
A list of CubeSerialNumbers which are located on the given island

References _FILEINFO_, ASSERT, and Isis::IException::Programmer.

const int Isis::ControlGraph::GetIslandCount ( ) const

There can be 0 islands or 2 or more islands.

GetIslandCount will never return 1 since 1 island is really just a connected graph (with 0 islands).

const GroupedStatistics & Isis::ControlGraph::GetMeasureStats ( const QString &  CubeSerialNumber) const
Parameters
CubeSerialNumberThe Serial number of the cube to get Statistics on
Returns
Statistics for all measures associated with the given cube
const bool Isis::ControlGraph::IsConnected ( ) const

Returns true if this ControlGraph is connected or false otherwise.

ControlGraph & Isis::ControlGraph::operator= ( const ControlGraph other)
Parameters
otherThe ControlGraph on the right side of the =

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