Isis::SerialNumberList Class Reference
[Control Networks]

Serial Number list generator. More...

#include <SerialNumberList.h>

Inheritance diagram for Isis::SerialNumberList:

[legend]

Collaboration diagram for Isis::SerialNumberList:

[legend]

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

For internal use only.

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.

Definition at line 87 of file SerialNumberList.h.

Constructor & Destructor Documentation

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.

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

For internal use only.

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 35 of file SerialNumberList.cpp.

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

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

Destructor.

Definition at line 61 of file SerialNumberList.cpp.

Member Function Documentation

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

For internal use only.

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

For internal use only.

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 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::MatchTool::serialNumberList(), SerialNumberList(), and Isis::StereoTool::setFiles().

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

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