USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::SerialNumberList Class Reference
[Control Networks]

Serial Number list generator. More...

#include <SerialNumberList.h>

Inherited by Isis::ObservationNumberList.

List of all members.

Classes

struct  Pair

Public Member Functions

 SerialNumberList (bool checkTarget=true)
 Creates an empty SerialNumberList.
 SerialNumberList (const QString &list, bool checkTarget=true, Progress *progress=NULL)
 Creates a SerialNumberList from a list of filenames.
virtual ~SerialNumberList ()
 Destructor.
void Add (const QString &filename, bool def2filename=false)
 Adds a new filename / serial number pair to the SerialNumberList.
void Add (const QString &serialNumber, const QString &filename)
 Adds a new filename / and pre-composed serial number pair to the SerialNumberList.
void Add (const char *serialNumber, const char *filename)
bool HasSerialNumber (QString sn)
 Delete a serial number off of the list.
void Delete (const QString &sn)
 Delete a serial number off of the list given the Serial Number.
int Size () const
 How many serial number / filename combos are in the list.
QString FileName (const QString &sn)
 Return a filename given a serial number.
QString FileName (int index)
 Return the filename at the given index.
QString SerialNumber (const QString &filename)
 return a serial number given a filename
QString SerialNumber (int index)
 Return a serial number given an index.
QString ObservationNumber (int index)
 Return a observation number given an index.
int SerialNumberIndex (const QString &sn)
 return a list index given a serial number
int FileNameIndex (const QString &filename)
 Return a list index given a filename.
std::vector< QString > PossibleSerialNumbers (const QString &on)
 Return possible serial numbers given an observation number.

Protected Attributes

std::vector< Pair > p_pairs
std::map< QString, int > p_serialMap
std::map< QString, int > p_fileMap
bool p_checkTarget
QString p_target

Detailed Description

Serial Number list generator.

Create a list of serial numbers from a list of files

Author:
2005-08-03 Jeff Anderson

Constructor & Destructor Documentation

Isis::SerialNumberList::SerialNumberList ( bool  checkTarget = true  ) 

Creates an empty SerialNumberList.

References p_checkTarget, and p_target.

Isis::SerialNumberList::SerialNumberList ( const QString &  listfile,
bool  checkTarget = true,
Progress *  progress = NULL 
)

Creates a SerialNumberList from a list of filenames.

Parameters:
listfile The list of files to be given serial numbers
checkTarget Boolean value that specifies whether or not to check to make sure the target names match between files added to the serialnumber list

References _FILEINFO_, Add(), Isis::Progress::CheckStatus(), p_checkTarget, p_target, Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::toString(), and Isis::IException::User.

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

Destructor.

Member Function Documentation

void Isis::SerialNumberList::Add ( const char *  serialNumber,
const char *  filename 
)

References Add().

void Isis::SerialNumberList::Add ( const QString &  serialNumber,
const QString &  filename 
)

Adds a new filename / and pre-composed serial number pair to the SerialNumberList.

Parameters:
serialNumber the serial number to be added
filename the filename to be added
Author:
2012-07-12 Tracie Sucharski

References _FILEINFO_, Isis::SerialNumberList::Pair::filename, FileName(), Isis::PvlObject::FindGroup(), Isis::PvlObject::FindObject(), Isis::PvlObject::HasGroup(), HasSerialNumber(), Isis::SerialNumberList::Pair::observationNumber, p_checkTarget, p_fileMap, p_pairs, p_serialMap, p_target, Isis::SerialNumberList::Pair::serialNumber, SerialNumberIndex(), and Isis::IException::User.

void Isis::SerialNumberList::Add ( const QString &  filename,
bool  def2filename = false 
)

Adds a new filename / serial number pair to the SerialNumberList.

Parameters:
filename the filename to be added
def2filename If a serial number could not be found, try to return the filename

References _FILEINFO_, Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), Isis::SerialNumberList::Pair::filename, FileName(), Isis::PvlObject::FindGroup(), Isis::PvlObject::FindObject(), Isis::PvlObject::HasGroup(), HasSerialNumber(), Isis::SerialNumberList::Pair::observationNumber, p_checkTarget, p_fileMap, p_pairs, p_serialMap, p_target, Isis::SerialNumberList::Pair::serialNumber, SerialNumberIndex(), and Isis::IException::User.

Referenced by Add(), and SerialNumberList().

void Isis::SerialNumberList::Delete ( const QString &  sn  ) 

Delete a serial number off of the list given the Serial Number.

Author:
Sharmila Prasad (9/9/2010)
Parameters:
sn - serial number

References FileName(), p_fileMap, p_pairs, p_serialMap, and SerialNumberIndex().

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), and Isis::ControlNetFilter::CubeNumPointsFilter().

QString Isis::SerialNumberList::FileName ( int  index  ) 

Return the filename at the given index.

Parameters:
index The index of the desired filename
Returns:
QString The filename at the given index

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

QString Isis::SerialNumberList::FileName ( const QString &  sn  ) 

Return a filename given a serial number.

Parameters:
sn The serial number of the desired filename
Returns:
QString The filename matching the input serial number

References _FILEINFO_, HasSerialNumber(), p_pairs, p_serialMap, and Isis::IException::Programmer.

Referenced by Add(), Isis::SerialNumber::ComposeObservation(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Delete(), Isis::MatchTool::deletePoint(), Isis::BundleAdjust::FileName(), FileNameIndex(), Isis::InterestOperator::FindCnetRef(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::InterestByPoint(), Isis::ObservationNumberList::ObservationNumber(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PrintCubeFileSerialNum(), Isis::ControlNetStatistics::PrintImageStats(), Isis::InterestOperator::ProcessLocked_Point_Reference(), SerialNumber(), Isis::ControlNet::SetImages(), Isis::BundleAdjust::SetObservationMode(), and Isis::ControlNetGraphicsItem::snToFileName().

int Isis::SerialNumberList::FileNameIndex ( const QString &  filename  ) 

Return a list index given a filename.

Parameters:
filename The filename to be searched for
Returns:
int The index of the input filename

References _FILEINFO_, FileName(), p_fileMap, pos, and Isis::IException::Programmer.

Referenced by Isis::ObservationNumberList::ObservationNumber(), and SerialNumber().

bool Isis::SerialNumberList::HasSerialNumber ( QString  sn  ) 

Delete a serial number off of the list.

Determines whether or not the requested serial number exists in the list.

Parameters:
sn The serial number to be checked for
Returns:
bool

References p_serialMap.

Referenced by Add(), Isis::MatchTool::deletePoint(), FileName(), Isis::BundleAdjust::IsHeld(), Isis::ObservationNumberList::Remove(), SerialNumberIndex(), Isis::ControlNet::SetImages(), and Isis::BundleAdjust::SetObservationMode().

QString Isis::SerialNumberList::ObservationNumber ( int  index  ) 

Return a observation number given an index.

Parameters:
index The index of the desired observation number
Returns:
QString The observation number returned

Reimplemented in Isis::ObservationNumberList.

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

Referenced by Isis::BundleAdjust::SetObservationMode().

std::vector< QString > Isis::SerialNumberList::PossibleSerialNumbers ( const QString &  on  ) 

Return possible serial numbers given an observation number.

Parameters:
on The observation number of the possible serial number
Returns:
vector<QString> The list of possible serial numbers matching the input observation number

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

QString Isis::SerialNumberList::SerialNumber ( int  index  ) 

Return a serial number given an index.

Parameters:
index The index of the desired serial number
Returns:
QString The serial number returned

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

QString Isis::SerialNumberList::SerialNumber ( const QString &  filename  ) 

return a serial number given a filename

Parameters:
filename The filename to be matched
Returns:
QString The serial number corresponding to the input filename

References _FILEINFO_, FileName(), FileNameIndex(), p_fileMap, p_pairs, and Isis::IException::Programmer.

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::BundleAdjust::IsHeld(), Isis::MatchTool::mouseButtonRelease(), Isis::ObservationNumber::PossibleSerial(), Isis::StereoTool::rubberBandComplete(), Isis::ControlNet::SetImages(), and Isis::BundleAdjust::SetObservationMode().

int Isis::SerialNumberList::SerialNumberIndex ( const QString &  sn  ) 

return a list index given a serial number

Parameters:
sn The serial number searched for
Returns:
int The index of the serial number

References _FILEINFO_, HasSerialNumber(), p_serialMap, and Isis::IException::Programmer.

Referenced by Add(), and Delete().

int Isis::SerialNumberList::Size (  )  const

How many serial number / filename combos are in the list.

Returns:
int Returns number of serial numbers current in the list

References p_pairs.

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::BundleAdjust::Images(), Isis::BundleAdjust::Observations(), Isis::ObservationNumber::PossibleSerial(), Isis::ControlNetStatistics::PrintImageStats(), Isis::ObservationNumberList::Remove(), Isis::ControlNet::SetImages(), Isis::BundleAdjust::SetObservationMode(), and Isis::ControlNetGraphicsItem::snToFileName().

Member Data Documentation

bool Isis::SerialNumberList::p_checkTarget [protected]

Referenced by Add(), and SerialNumberList().

std::map<QString, int> Isis::SerialNumberList::p_fileMap [protected]

Referenced by Add(), Delete(), FileNameIndex(), Isis::ObservationNumberList::ObservationNumber(), and SerialNumber().

std::vector<Pair> Isis::SerialNumberList::p_pairs [protected]

Referenced by Add(), Delete(), FileName(), Isis::ObservationNumberList::HasObservationNumber(), ObservationNumber(), Isis::ObservationNumberList::ObservationNumber(), Isis::ObservationNumberList::PossibleFileNames(), PossibleSerialNumbers(), SerialNumber(), and Size().

std::map<QString, int> Isis::SerialNumberList::p_serialMap [protected]

Referenced by Add(), Delete(), FileName(), HasSerialNumber(), and SerialNumberIndex().

QString Isis::SerialNumberList::p_target [protected]

Referenced by Add(), and SerialNumberList().

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