Isis 3.0 Object Programmers' Reference |
Home |
Serial Number list generator. More...
#include <SerialNumberList.h>
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 |
Serial Number list generator.
Create a list of serial numbers from a list of files
2005-08-03 Jeff Anderson Original Version
2006-02-10 Jacob Danton Added SerialNumber function
2006-02-13 Stuart Sides Added checks to make sure all the serial number items have the same target.
2006-06-15 Jeff Anderson Added GetIndex method
2006-06-22 Brendan George Added functions to get index, modified/added functions to get filename and serial number, and modified so that index corresponds to order files are input.
2006-08-16 Brendan George Added/fixed error checking in FileNameIndex() and SerialNumber(string filename).
2006-08-18 Brendan George Modified to use Expanded FileName on input, allowing for filenames that use environment variables
2006-09-13 Steven Koechle Added method to get the ObservationNumber when you give it an index
2008-01-10 Christopher Austin - Adapted for the new ObservationNumber class.
2008-10-30 Steven Lambright - Fixed problem with definition of struct Pair, pointed out by "novus0x2a" (Support Board Member)
2009-10-20 Jeannie Walldren - Added Progress flag to Constructor
2009-11-05 Jeannie Walldren - Modified number of maximum steps for Progress flag in Constructor
2010-09-09 Sharmila Prasad - Added API to delete serial# off of the list given Serial #
2010-11-24 Tracie Sucharski - Added bool def2filename parameter to the Add method. This will allow level 2 images to be added to a serial number list.
2012-07-12 Tracie Sucharski - Added new method Add, which takes a pre-composed serial number and a filename.
Definition at line 87 of file SerialNumberList.h.
Isis::SerialNumberList::SerialNumberList | ( | bool | checkTarget = true | ) |
Creates an empty SerialNumberList.
Definition at line 17 of file SerialNumberList.cpp.
Isis::SerialNumberList::SerialNumberList | ( | const QString & | listfile, |
bool | checkTarget = true , |
||
Progress * | progress = NULL |
||
) |
Creates a SerialNumberList from a list of filenames.
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 |
2009-10-20 Jeannie Walldren - Added Progress flag
2009-11-05 Jeannie Walldren - Modified number of maximum steps for Progress flag
Definition at line 35 of file SerialNumberList.cpp.
References _FILEINFO_, Add(), Isis::Progress::CheckStatus(), Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::toString(), and Isis::IException::User.
|
virtual |
Destructor.
Definition at line 61 of file SerialNumberList.cpp.
void Isis::SerialNumberList::Add | ( | const QString & | filename, |
bool | def2filename = false |
||
) |
Adds a new filename / serial number pair to the SerialNumberList.
filename | the filename to be added |
def2filename | If a serial number could not be found, try to return the filename |
2007-06-04 Tracie Sucharski - Expand filename to include full path before adding to list.
2010-11-24 Tracie Sucharski - Added bool def2filename parameter. This will allow level 2 images to be added to a serial number list.
2010-11-29 Tracie Sucharski - Only read the Instrument group if p_checkTarget is True. If def2filename is True, check for Mapping group if Target does not exist.
Definition at line 104 of file SerialNumberList.cpp.
References _FILEINFO_, Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), FileName(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), HasSerialNumber(), SerialNumberIndex(), and Isis::IException::User.
Referenced by Isis::ControlNetGraphicsItem::buildChildren(), Isis::QnetTool::openGround(), SerialNumberList(), Isis::MatchTool::serialNumberList(), and Isis::StereoTool::setFiles().
void Isis::SerialNumberList::Add | ( | const QString & | serialNumber, |
const QString & | filename | ||
) |
Adds a new filename / and pre-composed serial number pair to the SerialNumberList.
serialNumber | the serial number to be added |
filename | the filename to be added |
Definition at line 193 of file SerialNumberList.cpp.
References _FILEINFO_, FileName(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), HasSerialNumber(), SerialNumberIndex(), and Isis::IException::User.
void Isis::SerialNumberList::Delete | ( | const QString & | sn | ) |
Delete a serial number off of the list given the Serial Number.
sn | - serial number |
Definition at line 72 of file SerialNumberList.cpp.
References FileName(), and SerialNumberIndex().
Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), and Isis::MatchTool::serialNumberList().
QString Isis::SerialNumberList::FileName | ( | const QString & | sn | ) |
Return a filename given a serial number.
sn | The serial number of the desired filename |
Definition at line 290 of file SerialNumberList.cpp.
References _FILEINFO_, HasSerialNumber(), and Isis::IException::Programmer.
Referenced by Add(), Isis::QnetTool::addMeasure(), Isis::SerialNumber::ComposeObservation(), Isis::QnetPointCubeNameFilter::createCubeList(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Delete(), Isis::MatchTool::deletePoint(), Isis::QnetTool::deletePoint(), Isis::QnetCubeNameFilter::filter(), Isis::InterestOperator::FindCnetRef(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ImageOverlapSet::HandleError(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::InterestByPoint(), Isis::QnetTool::loadGroundMeasure(), Isis::QnetFileTool::loadImage(), Isis::MatchTool::loadMeasureTable(), Isis::QnetTool::loadMeasureTable(), Isis::MatchTool::loadPoint(), Isis::QnetTool::loadPoint(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PrintCubeFileSerialNum(), Isis::InterestOperator::ProcessLocked_Point_Reference(), Isis::MatchTool::selectLeftMeasure(), Isis::MatchTool::selectRightMeasure(), Isis::MatchTool::serialNumberList(), Isis::QnetNewPointDialog::setFiles(), Isis::QnetNewMeasureDialog::setFiles(), Isis::QnetFixedPointDialog::setFiles(), and Isis::ControlNet::SetImages().
QString Isis::SerialNumberList::FileName | ( | int | index | ) |
Return the filename at the given index.
index | The index of the desired filename |
Definition at line 410 of file SerialNumberList.cpp.
References _FILEINFO_, Isis::IException::Programmer, and Isis::toString().
int Isis::SerialNumberList::FileNameIndex | ( | const QString & | filename | ) |
Return a list index given a filename.
filename | The filename to be searched for |
Definition at line 391 of file SerialNumberList.cpp.
References _FILEINFO_, and Isis::IException::Programmer.
Referenced by Isis::QnetTool::addMeasure(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), 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.
sn | The serial number to be checked for |
Definition at line 266 of file SerialNumberList.cpp.
Referenced by Add(), Isis::MatchTool::deletePoint(), Isis::QnetTool::drawAllMeasurments(), FileName(), Isis::QnetTool::openGround(), Isis::ObservationNumberList::Remove(), SerialNumberIndex(), Isis::MatchTool::serialNumberList(), Isis::StereoTool::setFiles(), and Isis::ControlNet::SetImages().
QString Isis::SerialNumberList::ObservationNumber | ( | int | index | ) |
Return a observation number given an index.
index | The index of the desired observation number |
Definition at line 350 of file SerialNumberList.cpp.
References _FILEINFO_, and Isis::IException::Programmer.
Referenced by Isis::ObservationNumberList::init().
std::vector< QString > Isis::SerialNumberList::PossibleSerialNumbers | ( | const QString & | on | ) |
Return possible serial numbers given an observation number.
on | The observation number of the possible serial number |
Definition at line 431 of file SerialNumberList.cpp.
References _FILEINFO_, and Isis::IException::Programmer.
QString Isis::SerialNumberList::SerialNumber | ( | const QString & | filename | ) |
return a serial number given a filename
filename | The filename to be matched |
Definition at line 314 of file SerialNumberList.cpp.
References _FILEINFO_, FileNameIndex(), and Isis::IException::Programmer.
Referenced by Isis::QnetTool::addMeasure(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::QnetCubeDistanceFilter::filter(), Isis::QnetPointCubeNameFilter::filter(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::ObservationNumber::PossibleSerial(), Isis::MatchTool::selectLeftMeasure(), Isis::QnetTool::selectLeftMeasure(), Isis::MatchTool::selectRightMeasure(), Isis::QnetTool::selectRightMeasure(), Isis::QnetNewMeasureDialog::setFiles(), and Isis::ControlNet::SetImages().
QString Isis::SerialNumberList::SerialNumber | ( | int | index | ) |
Return a serial number given an index.
index | The index of the desired serial number |
Definition at line 332 of file SerialNumberList.cpp.
References _FILEINFO_, and Isis::IException::Programmer.
int Isis::SerialNumberList::SerialNumberIndex | ( | const QString & | sn | ) |
return a list index given a serial number
sn | The serial number searched for |
Definition at line 368 of file SerialNumberList.cpp.
References _FILEINFO_, HasSerialNumber(), and Isis::IException::Programmer.
Referenced by Add(), Isis::QnetTool::addMeasure(), Delete(), Isis::QnetPointDistanceFilter::filter(), Isis::QnetTool::loadGroundMeasure(), Isis::QnetTool::loadPoint(), and Isis::QnetSetAprioriDialog::setApriori().
int Isis::SerialNumberList::Size | ( | ) | const |
How many serial number / filename combos are in the list.
Definition at line 277 of file SerialNumberList.cpp.
Referenced by Isis::QnetTool::addMeasure(), Isis::QnetPointCubeNameFilter::createCubeList(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::QnetNavTool::filterList(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ObservationNumberList::init(), Isis::ObservationNumber::PossibleSerial(), Isis::ObservationNumberList::Remove(), Isis::QnetNavTool::resetList(), Isis::QnetNewPointDialog::setFiles(), Isis::QnetNewMeasureDialog::setFiles(), Isis::QnetFixedPointDialog::setFiles(), and Isis::ControlNet::SetImages().