Serial Number list generator. More...

#include <SerialNumberList.h>

Inheritance diagram for Isis::SerialNumberList:

Collaboration diagram for Isis::SerialNumberList:

Classes
struct	Pair
	A serial number list entity that contains the filename serial number pair. More...

Public Member Functions
	SerialNumberList (bool checkTarget=true)
	Creates an empty SerialNumberList. More...

	SerialNumberList (const QString &list, bool checkTarget=true, Progress *progress=NULL)
	Creates a SerialNumberList from a list of filenames. More...

virtual	~SerialNumberList ()
	Destructor. More...

void	add (const QString &filename, bool def2filename=false)
	Adds a new filename / serial number pair to the SerialNumberList. More...

void	add (const QString &serialNumber, const QString &filename)
	Adds a new filename / and pre-composed serial number pair to the SerialNumberList. More...

void	add (const char serialNumber, const char filename)
	Overloaded add method that takes char * parameters. More...

bool	hasSerialNumber (QString sn)
	Determines whether or not the requested serial number exists in the list. More...

void	remove (const QString &sn)
	Remove the specified serial number from the list. More...

int	size () const
	How many serial number / filename combos are in the list. More...

QString	fileName (const QString &sn)
	Return a filename given a serial number. More...

QString	fileName (int index)
	Return the filename at the given index. More...

QString	serialNumber (const QString &filename)
	Return a serial number given a filename. More...

QString	serialNumber (int index)
	Return a serial number given an index. More...

QString	observationNumber (int index)
	Return a observation number given an index. More...

QString	spacecraftInstrumentId (int index)
	Return the spacecraftname/instrumentid at the given index. More...

QString	spacecraftInstrumentId (const QString &sn)
	Return the spacecraftname/instrumentid given a serial number. More...

int	serialNumberIndex (const QString &sn)
	Return a list index given a serial number. More...

int	fileNameIndex (const QString &filename)
	Return a list index given a filename. More...

std::vector< QString >	possibleSerialNumbers (const QString &on)
	Return possible serial numbers given an observation number. More...

Protected Attributes
std::vector< Pair >	m_pairs
	List of serial number Pair entities. More...

std::map< QString, int >	m_serialMap
	Maps serial numbers to their positions in the list. More...

std::map< QString, int >	m_fileMap
	Maps filenames to their positions in the list. More...

bool	m_checkTarget
	Specifies whether or not to check to make sure the target names match between files added to the serialnumber list. More...

QString	m_target
	Target name that the files must have if m_checkTarget is true More...

Detailed Description

Serial Number list generator.

Create a list of serial numbers from a list of files

Author: 2005-08-03 Jeff Anderson

History:: 2005-08-03 Jeff Anderson - Original Version

History:: 2006-02-10 Jacob Danton - Added SerialNumber function

History:: 2006-02-13 Stuart Sides - Added checks to make sure all the serial number items have the same target.

History:: 2006-05-31 Tracie Sucharski - Added filename function that uses index instead of serial number.

History:: 2006-06-15 Jeff Anderson - Added GetIndex method

History:: 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.

History:: 2006-08-16 Brendan George - Added/fixed error checking in FileNameIndex() and SerialNumber(string filename).

History:: 2006-08-18 Brendan George - Modified to use Expanded FileName on input, allowing for filenames that use environment variables

History:: 2006-09-13 Steven Koechle - Added method to get the ObservationNumber when you give it an index

History:: 2008-01-10 Christopher Austin - Adapted for the new ObservationNumber class.

History:: 2008-10-30 Steven Lambright - Fixed problem with definition of struct Pair, pointed out by "novus0x2a" (Support Board Member)

History:: 2009-10-20 Jeannie Walldren - Added Progress flag to Constructor

History:: 2009-11-05 Jeannie Walldren - Modified number of maximum steps for Progress flag in Constructor

History:: 2010-09-09 Sharmila Prasad - Added API to delete serial# off of the list given Serial #

History:: 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.

History:: 2012-07-12 Tracie Sucharski - Added new method Add, which takes a pre-composed serial number and a filename.

History:: 2016-06-02 Ian Humphrey - Removed SpacecraftInstrumentId method prototypes Fixes #3967.

History:: 2017-08-09 Adam Goins - Modified code to be consistent with ISIS coding standards Fixes #3991.

Definition at line 64 of file SerialNumberList.h.

Constructor & Destructor Documentation

◆ SerialNumberList() [1/2]

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

Creates an empty SerialNumberList.

Parameters

checkTarget Specifies whether or not to check to make sure the target names match between files added to the serialnumber list

Definition at line 26 of file SerialNumberList.cpp.

References m_checkTarget, and m_target.

◆ SerialNumberList() [2/2]

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	Specifies whether or not to check to make sure the target names match between files added to the serialnumber list
progress	Monitors progress of serial number creation

Exceptions

IException::User "Can't open or invalid file list"

History:: 2009-10-20 Jeannie Walldren - Added Progress flag

History:: 2009-11-05 Jeannie Walldren - Modified number of maximum steps for Progress flag

Definition at line 46 of file SerialNumberList.cpp.

References add(), Isis::Progress::CheckStatus(), m_checkTarget, m_target, Isis::Progress::SetMaximumSteps(), Isis::Progress::SetText(), Isis::toString(), and Isis::IException::User.

◆ ~SerialNumberList()

Isis::SerialNumberList::~SerialNumberList ( )

virtual

Destructor.

Definition at line 77 of file SerialNumberList.cpp.

Member Function Documentation

◆ add() [1/3]

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

Overloaded add method that takes char * parameters.

Adds a new filename / serial number pair to the SerialNumberList

Parameters

serialNumber	The serial number to be added
filename	The filename to be added

See also: add(QString, QString)

Definition at line 227 of file SerialNumberList.cpp.

References add(), and serialNumber().

◆ add() [2/3]

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

Exceptions

IException::User	"Unable to find Instrument or Mapping group for comparing target."
IException::User	"Unable to find Instrument group for comparing target."
IException::User	"Target name from file does not match."
IException::User	"Invalid serial number [Unknown] from file."
IException::User	"Duplicate serial number from files [file1] and [file2]."
IException::User	"FileName cannot be added to serial number list."

History:: 2007-06-04 Tracie Sucharski - Expand filename to include full path before adding to list.

History:: 2010-11-24 Tracie Sucharski - Added bool def2filename parameter. This will allow level 2 images to be added to a serial number list.

History:: 2010-11-29 Tracie Sucharski - Only read the Instrument group if m_checkTarget is True. If def2filename is True, check for Mapping group if Target does not exist.

Definition at line 121 of file SerialNumberList.cpp.

References Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), Isis::FileName::expanded(), fileName(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::PvlContainer::hasKeyword(), hasSerialNumber(), m_checkTarget, m_fileMap, m_pairs, m_serialMap, m_target, serialNumberIndex(), and Isis::IException::User.

Referenced by add(), Isis::ControlNetGraphicsItem::buildChildren(), Isis::BundleAdjust::BundleAdjust(), Isis::QnetTool::openGround(), Isis::ImageList::serialNumberList(), Isis::MatchTool::serialNumberList(), Isis::ShapeList::serialNumberList(), SerialNumberList(), Isis::StereoTool::setFiles(), and Isis::ControlPointEditWidget::setGroundSourceInfo().

◆ add() [3/3]

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

Exceptions

IException::User	"Unable to find Instrument or Mapping group for comparing target."
IException::User	"Target name from file does not match."
IException::User	"Invalid serial number [Unknown] from file."
IException::User	"Duplicate serial number from files [file1] and [file2]."
IException::User	"Unable to find Instrument group need for performing bundle adjustment."
IException::User	"Unable to find Spacecraftname or InstrumentId keywords needed for performing bundle adjustment."
IException::User	"[SerialNumber, FileName] can not be added to serial number list."

Author: 2012-07-12 Tracie Sucharski

Definition at line 251 of file SerialNumberList.cpp.

References Isis::FileName::expanded(), fileName(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::PvlContainer::hasKeyword(), hasSerialNumber(), m_checkTarget, m_fileMap, m_pairs, m_serialMap, m_target, observationNumber(), serialNumber(), serialNumberIndex(), and Isis::IException::User.

◆ fileName() [1/2]

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

Return a filename given a serial number.

Parameters

sn	The serial number of the desired filename

Exceptions

IException::Programmer "Unable to get the FileName. The given serial number does not exist in the list."

Returns: QString The filename matching the input serial number

Definition at line 399 of file SerialNumberList.cpp.

References hasSerialNumber(), m_pairs, m_serialMap, and Isis::IException::Programmer.

◆ fileName() [2/2]

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

Return the filename at the given index.

Parameters

index The index of the desired filename

Exceptions

IException::Programmer "Unable to get the FileName. The given index is invalid."

Returns: QString The filename at the given index

Definition at line 537 of file SerialNumberList.cpp.

References m_pairs, Isis::IException::Programmer, and Isis::toString().

◆ fileNameIndex()

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

Return a list index given a filename.

Parameters

filename The filename to be searched for

Exceptions

IException::Programmer "Unable to get the FileName index. The given file name does not exist in the list."

Returns: int The index of the input filename

History:: 2007-06-04 Tracie Sucharski - Expand filename to include full path before searching list.

History:: 2007-07-11 Stuart Sides - Fixed bug where the correct index was not returned.

Definition at line 517 of file SerialNumberList.cpp.

References Isis::FileName::expanded(), m_fileMap, and Isis::IException::Programmer.

Referenced by Isis::QnetTool::addMeasure(), Isis::ControlPointEditWidget::createControlPoint(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::ObservationNumberList::observationNumber(), and serialNumber().

◆ hasSerialNumber()

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

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

Parameters

sn	The serial number to be checked for

Returns: bool

Definition at line 373 of file SerialNumberList.cpp.

References m_serialMap.

Referenced by add(), Isis::QnetTool::drawAllMeasurments(), fileName(), Isis::QnetTool::openGround(), Isis::ObservationNumberList::remove(), serialNumberIndex(), Isis::MatchTool::serialNumberList(), Isis::StereoTool::setFiles(), Isis::ControlNet::SetImages(), and spacecraftInstrumentId().

◆ observationNumber()

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

Return a observation number given an index.

Parameters

index The index of the desired observation number

Exceptions

IException::Programmer "Unable to get the ObservationNumber. The given index is invalid."

Returns: QString The observation number returned

Definition at line 468 of file SerialNumberList.cpp.

References m_pairs, Isis::IException::Programmer, and Isis::toString().

Referenced by add(), Isis::ObservationNumberList::init(), and possibleSerialNumbers().

◆ possibleSerialNumbers()

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

Exceptions

IException::Programmer "Unable to get the possible serial numbers. The given observation number does not exist in the list."

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

Definition at line 613 of file SerialNumberList.cpp.

References m_pairs, observationNumber(), Isis::IException::Programmer, and serialNumber().

◆ remove()

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

Remove the specified serial number from the list.

Parameters

sn	Name of serial number to remove

Author: 2010-09-09 Sharmila Prasad

Definition at line 88 of file SerialNumberList.cpp.

References fileName(), m_fileMap, m_pairs, m_serialMap, and serialNumberIndex().

Referenced by Isis::ControlPointEditWidget::clearGroundSource(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), and Isis::MatchTool::serialNumberList().

◆ serialNumber() [1/2]

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

Return a serial number given a filename.

Parameters

filename The filename to be matched

Exceptions

IException::Programmer "Unable to get the SerialNumber. The given file name does not exist in the list."

Returns: QString The serial number corresponding to the input filename

History:: 2007-06-04 Tracie Sucharski - Expand filename to include full path before searching list.

Definition at line 426 of file SerialNumberList.cpp.

References Isis::FileName::expanded(), fileNameIndex(), m_fileMap, m_pairs, and Isis::IException::Programmer.

Referenced by add(), Isis::QnetTool::addMeasure(), Isis::ControlMeasureEditWidget::blinkStartRight(), Isis::ControlPointEditWidget::createControlPoint(), 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::ControlNetStatistics::InitSerialNumMap(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::ObservationNumber::PossibleSerial(), possibleSerialNumbers(), Isis::ControlPointEditWidget::selectLeftMeasure(), Isis::MatchTool::selectLeftMeasure(), Isis::QnetTool::selectLeftMeasure(), Isis::ControlPointEditWidget::selectRightMeasure(), Isis::MatchTool::selectRightMeasure(), Isis::QnetTool::selectRightMeasure(), Isis::QnetNewMeasureDialog::setFiles(), and Isis::ControlNet::SetImages().

◆ serialNumber() [2/2]

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

Return a serial number given an index.

Parameters

index The index of the desired serial number

Exceptions

IException::Programmer "Unable to get the SerialNumber. The given index is invalid."

Returns: QString The serial number returned

Definition at line 446 of file SerialNumberList.cpp.

References m_pairs, Isis::IException::Programmer, and Isis::toString().

◆ serialNumberIndex()

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

Return a list index given a serial number.

Parameters

sn	The serial number searched for

Exceptions

IException::Programmer "Unable to get the SerialNumber index. The given serial number does not exist in the list."

Returns: int The index of the serial number

Definition at line 490 of file SerialNumberList.cpp.

References hasSerialNumber(), m_serialMap, and Isis::IException::Programmer.

Referenced by add(), Isis::QnetTool::addMeasure(), Isis::ControlPointEditWidget::createTemporaryGroundMeasure(), Isis::QnetSetAprioriDialog::fillReferenceAprioriLineEdits(), Isis::QnetPointDistanceFilter::filter(), Isis::QnetTool::findPointLocation(), Isis::ObservationNumberList::observationNumberMapIndex(), remove(), and Isis::ControlPointEditWidget::setShapesForPoint().

◆ size()

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

Definition at line 384 of file SerialNumberList.cpp.

References m_pairs.

Referenced by Isis::QnetTool::addMeasure(), Isis::ControlPointEditWidget::createControlPoint(), Isis::QnetPointCubeNameFilter::createCubeList(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::ObservationNumberList::init(), Isis::ControlNetStatistics::InitSerialNumMap(), Isis::BundleAdjust::numberOfImages(), Isis::ObservationNumber::PossibleSerial(), Isis::ControlNetStatistics::PrintImageStats(), Isis::ObservationNumberList::remove(), Isis::QnetNavTool::resetList(), Isis::QnetNewMeasureDialog::setFiles(), Isis::NewControlPointDialog::setFiles(), Isis::QnetFixedPointDialog::setFiles(), and Isis::ControlNet::SetImages().

◆ spacecraftInstrumentId() [1/2]

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

Return the spacecraftname/instrumentid given a serial number.

Parameters

sn	The serial number of the desired spacecraftname/instrumentid

Exceptions

IException::Programmer "Unable to get the Spacecraft InstrumentId. The given serial number does not exist in the list."

Returns: QString The spacecraftname/instrumentid matching the input serial number

Definition at line 585 of file SerialNumberList.cpp.

References hasSerialNumber(), m_pairs, m_serialMap, and Isis::IException::Programmer.

◆ spacecraftInstrumentId() [2/2]

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

Return the spacecraftname/instrumentid at the given index.

Parameters

index The index of the desired spacecraftname/instrumentid

Exceptions

IException::Programmer "Unable to get the Spacecraft InstrumentId. The given index is invalid."

Returns: QString The spacecraftname/instrumentid at the given index

Definition at line 559 of file SerialNumberList.cpp.

References m_pairs, Isis::IException::Programmer, and Isis::toString().

Member Data Documentation

◆ m_checkTarget

bool Isis::SerialNumberList::m_checkTarget

protected

Specifies whether or not to check to make sure the target names match between files added to the serialnumber list.

Definition at line 112 of file SerialNumberList.h.

Referenced by add(), and SerialNumberList().

◆ m_fileMap

std::map<QString, int> Isis::SerialNumberList::m_fileMap

protected

Maps filenames to their positions in the list.

Definition at line 106 of file SerialNumberList.h.

Referenced by add(), fileNameIndex(), Isis::ObservationNumberList::observationNumber(), remove(), and serialNumber().

◆ m_pairs

std::vector<Pair> Isis::SerialNumberList::m_pairs

protected

List of serial number Pair entities.

Definition at line 104 of file SerialNumberList.h.

Referenced by add(), fileName(), Isis::ObservationNumberList::hasObservationNumber(), Isis::ObservationNumberList::observationNumber(), observationNumber(), Isis::ObservationNumberList::possibleFileNames(), possibleSerialNumbers(), remove(), serialNumber(), size(), and spacecraftInstrumentId().

◆ m_serialMap

std::map<QString, int> Isis::SerialNumberList::m_serialMap

protected

Maps serial numbers to their positions in the list.

Definition at line 105 of file SerialNumberList.h.

Referenced by add(), fileName(), hasSerialNumber(), remove(), serialNumberIndex(), and spacecraftInstrumentId().

◆ m_target

QString Isis::SerialNumberList::m_target

protected

Target name that the files must have if m_checkTarget is true

Definition at line 113 of file SerialNumberList.h.

Referenced by add(), and SerialNumberList().

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

src/base/objs/SerialNumberList/SerialNumberList.h
src/base/objs/SerialNumberList/SerialNumberList.cpp

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SerialNumberList() [1/2]

◆ SerialNumberList() [2/2]

◆ ~SerialNumberList()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ fileName() [1/2]

◆ fileName() [2/2]

◆ fileNameIndex()

◆ hasSerialNumber()

◆ observationNumber()

◆ possibleSerialNumbers()

◆ remove()

◆ serialNumber() [1/2]

◆ serialNumber() [2/2]

◆ serialNumberIndex()

◆ size()

◆ spacecraftInstrumentId() [1/2]

◆ spacecraftInstrumentId() [2/2]

Member Data Documentation

◆ m_checkTarget

◆ m_fileMap

◆ m_pairs

◆ m_serialMap

◆ m_target