Isis 3 Programmer Reference
Isis::ControlPointList Class Reference

Control Point List generator. More...

#include <ControlPointList.h>

Collaboration diagram for Isis::ControlPointList:
Collaboration graph

Public Member Functions

 ControlPointList (const FileName &psFileName)
 Creates a ControlPointList from a list of control point ids'. More...
 
virtual ~ControlPointList ()
 Destructor. More...
 
QString ControlPointId (int piIndex)
 Return a control point id given an index. More...
 
int ControlPointIndex (const QString &psCpId)
 return a list index given a control point id More...
 
bool HasControlPoint (const QString &psCpId)
 Determines whether or not the requested control point id exists in the list. More...
 
int Size () const
 How many control points in the list. More...
 
void RegisterStatistics (Pvl &pcPvlLog)
 Register invalid control point and calculate the valid & invalid point count. More...
 

Private Attributes

QStringList mqCpList
 
QVector< bool > mbFound
 holds one to one correspondence with "mqCpList" on whether the point was valid More...
 

Detailed Description

Control Point List generator.

Create a list of Control Points from a file with control points ids

Author
2009-08-11 Sharmila Prasad
History:

2009-08-11 Sharmila Prasad Original Version

2009-10-04 Steven Lambright Constructor now takes a FileName instead of a string.

2017-12-12 Kristin Berry Updated to use QVector and QString instead of std::vector and std::string. Fixes #5259.

Definition at line 52 of file ControlPointList.h.

Constructor & Destructor Documentation

◆ ControlPointList()

Isis::ControlPointList::ControlPointList ( const FileName psListFile)

Creates a ControlPointList from a list of control point ids'.

Parameters
psListFileThe file withe list of control point ids'

Definition at line 16 of file ControlPointList.cpp.

References _FILEINFO_, Isis::FileName::expanded(), mbFound, Isis::toString(), and Isis::IException::User.

◆ ~ControlPointList()

Isis::ControlPointList::~ControlPointList ( )
virtual

Destructor.

Definition at line 40 of file ControlPointList.cpp.

Member Function Documentation

◆ ControlPointId()

QString Isis::ControlPointList::ControlPointId ( int  piIndex)

Return a control point id given an index.

Parameters
piIndexThe index of the desired control point id
Returns
QString The control point id returned

Definition at line 80 of file ControlPointList.cpp.

References _FILEINFO_, Isis::IException::Programmer, Size(), and Isis::toString().

◆ ControlPointIndex()

int Isis::ControlPointList::ControlPointIndex ( const QString &  psCpId)

return a list index given a control point id

Parameters
ps_cpIdThe control point id to be searched for
Returns
int The index of the control point id

Definition at line 99 of file ControlPointList.cpp.

References _FILEINFO_, HasControlPoint(), and Isis::IException::Programmer.

◆ HasControlPoint()

bool Isis::ControlPointList::HasControlPoint ( const QString &  psCpId)

Determines whether or not the requested control point id exists in the list.

Parameters
psCpIdThe control point id to be checked for
Returns
bool

Definition at line 52 of file ControlPointList.cpp.

References mbFound, and Size().

Referenced by ControlPointIndex().

◆ RegisterStatistics()

void Isis::ControlPointList::RegisterStatistics ( Pvl pcPvlLog)

Register invalid control point and calculate the valid & invalid point count.

Parameters
PvlWill contain stats in pvl keywords

Definition at line 116 of file ControlPointList.cpp.

References mbFound, Size(), and Isis::toString().

◆ Size()

int Isis::ControlPointList::Size ( ) const

How many control points in the list.

Returns
int Returns number of control point in the list

Definition at line 68 of file ControlPointList.cpp.

Referenced by ControlPointId(), HasControlPoint(), and RegisterStatistics().

Member Data Documentation

◆ mbFound

QVector<bool> Isis::ControlPointList::mbFound
private

holds one to one correspondence with "mqCpList" on whether the point was valid

Definition at line 71 of file ControlPointList.h.

Referenced by ControlPointList(), HasControlPoint(), and RegisterStatistics().


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