USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::ControlPointList Class Reference
[Control Networks]

#include <ControlPointList.h>

Collaboration diagram for Isis::ControlPointList:

Collaboration graph
[legend]
List of all members.

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

For internal use only.

History:
2009-08-11 Sharmila Prasad Original Version

Definition at line 48 of file ControlPointList.h.

Public Member Functions

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

Private Attributes

QStringList mqCpList
std::vector< bool > mbFound


Constructor & Destructor Documentation

Isis::ControlPointList::ControlPointList ( const std::string &  psListFile  ) 

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

Parameters:
psListFile The file withe list of control point ids'

Definition at line 13 of file ControlPointList.cpp.

References _FILEINFO_, e, mbFound, Isis::iException::Message(), mqCpList, and size.

Isis::ControlPointList::~ControlPointList (  )  [virtual]

Destructor.

Definition at line 36 of file ControlPointList.cpp.


Member Function Documentation

std::string Isis::ControlPointList::ControlPointId ( int  piIndex  ) 

Return a control point id given an index.

Parameters:
piIndex The index of the desired control point id
Returns:
std::string The control point id returned

Definition at line 76 of file ControlPointList.cpp.

References _FILEINFO_, Isis::iException::Message(), mqCpList, Size(), and size.

int Isis::ControlPointList::ControlPointIndex ( const std::string &  psCpId  ) 

return a list index given a control point id

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

Definition at line 95 of file ControlPointList.cpp.

References _FILEINFO_, HasControlPoint(), Isis::iException::Message(), and mqCpList.

bool Isis::ControlPointList::HasControlPoint ( const std::string &  psCpId  ) 

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

Parameters:
psCpId The control point id to be checked for
Returns:
bool

Definition at line 48 of file ControlPointList.cpp.

References mbFound, mqCpList, and Size().

Referenced by ControlPointIndex().

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

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

Parameters:
Pvl Will contain stats in pvl keywords

Definition at line 112 of file ControlPointList.cpp.

References mbFound, mqCpList, Size(), and 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 64 of file ControlPointList.cpp.

References mqCpList.

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


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