Isis::ObservationNumberList Class Reference

Needs Documentation. More...

#include <ObservationNumberList.h>

Inherits Isis::SerialNumberList.

Public Member Functions
	ObservationNumberList (const QString &list, bool checkTarget=true)
	Creates an ObservationNumberList from a filename.
	ObservationNumberList (Isis::SerialNumberList *snlist)
	Creates an ObservationNumberList from a SerialNumberList.
	~ObservationNumberList ()
	Destructor.
void	Add (int isn, const int observationIndex, QString observationNumber)
	Adds a new serial number index / observation number index / observation number to the SerialNumberList.
int	ObservationSize () const
	How many unique observations are in the list?
int	ObservationNumberMapIndex (const int serialNumberIndex)
	Return a observation index given a serial number index.
void	Remove (Isis::SerialNumberList *snlist)
	Removes all of the listed serial numbers from the observation.
void	Remove (const QString &listfile)
	Removes all of the listed serial numbers from the observation.
bool	HasObservationNumber (const QString &on)
	Determines whether or not the requested observation number exists in the list.
QString	ObservationNumber (const QString &filename)
	return an observation number given a filename
QString	ObservationNumber (int index)
	Return a observation number given an index.
std::vector< QString >	PossibleFileNames (const QString &on)
	Return possible filenames given an observation number.
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.
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

Needs Documentation.

Needs Documentation

Author

2007-09-17 Debbie A. Cook

Constructor & Destructor Documentation

Isis::ObservationNumberList::ObservationNumberList	(	const QString &	listfile,
		bool	checkTarget = true
	)

Creates an ObservationNumberList from a filename.

Parameters

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

Isis::ObservationNumberList::ObservationNumberList

(

Isis::SerialNumberList *

snlist

)

Creates an ObservationNumberList from a SerialNumberList.

Parameters

snlist

The serial number list from which to generate an observation number list

Isis::ObservationNumberList::~ObservationNumberList

(

)

Destructor.

Member Function Documentation

void Isis::ObservationNumberList::Add	(	int	isn,
		const int	observationIndex,
		QString	observationNumber
	)

Adds a new serial number index / observation number index / observation number to the SerialNumberList.

Parameters

isn	The serial number index of the observation set to be added
observationIndex	The observation number index of the observation set to be added
observationNumber	The observation number of the observation set to be added

Referenced by Remove().

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

inherited

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::FileName::expanded(), Isis::SerialNumberList::FileName(), Isis::SerialNumberList::Pair::filename, Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::SerialNumberList::HasSerialNumber(), Isis::SerialNumberList::Pair::observationNumber, Isis::SerialNumberList::p_checkTarget, Isis::SerialNumberList::p_fileMap, Isis::SerialNumberList::p_pairs, Isis::SerialNumberList::p_serialMap, Isis::SerialNumberList::p_target, Isis::SerialNumberList::Pair::serialNumber, Isis::SerialNumberList::SerialNumberIndex(), and Isis::IException::User.

Referenced by Isis::SerialNumberList::Add(), and Isis::SerialNumberList::SerialNumberList().

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

inherited

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::FileName::expanded(), Isis::SerialNumberList::FileName(), Isis::SerialNumberList::Pair::filename, Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::SerialNumberList::HasSerialNumber(), Isis::SerialNumberList::Pair::observationNumber, Isis::SerialNumberList::p_checkTarget, Isis::SerialNumberList::p_fileMap, Isis::SerialNumberList::p_pairs, Isis::SerialNumberList::p_serialMap, Isis::SerialNumberList::p_target, Isis::SerialNumberList::Pair::serialNumber, Isis::SerialNumberList::SerialNumberIndex(), and Isis::IException::User.

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

inherited

References Isis::SerialNumberList::Add().

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

inherited

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

Author

Sharmila Prasad (9/9/2010)

Parameters

sn	- serial number

References Isis::SerialNumberList::FileName(), Isis::SerialNumberList::p_fileMap, Isis::SerialNumberList::p_pairs, Isis::SerialNumberList::p_serialMap, and Isis::SerialNumberList::SerialNumberIndex().

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

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

inherited

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_, Isis::SerialNumberList::HasSerialNumber(), Isis::SerialNumberList::p_pairs, Isis::SerialNumberList::p_serialMap, and Isis::IException::Programmer.

Referenced by Isis::SerialNumberList::Add(), Isis::SerialNumber::ComposeObservation(), Isis::QnetPointCubeNameFilter::createCubeList(), Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::SerialNumberList::Delete(), Isis::MatchTool::deletePoint(), Isis::QnetTool::deletePoint(), Isis::QnetCubeNameFilter::filter(), Isis::InterestOperator::FindCnetRef(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::InterestByPoint(), Isis::QnetFileTool::loadImage(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PrintCubeFileSerialNum(), Isis::InterestOperator::ProcessLocked_Point_Reference(), Isis::QnetNewPointDialog::setFiles(), Isis::QnetNewMeasureDialog::setFiles(), Isis::QnetFixedPointDialog::setFiles(), Isis::ControlNet::SetImages(), and Isis::ControlNetGraphicsItem::snToFileName().

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

inherited

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_, Isis::SerialNumberList::p_pairs, Isis::IException::Programmer, and Isis::toString().

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

inherited

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_, Isis::FileName::expanded(), Isis::SerialNumberList::p_fileMap, and Isis::IException::Programmer.

Referenced by Isis::QnetTool::createFixedPoint(), Isis::QnetTool::createPoint(), ObservationNumber(), and Isis::SerialNumberList::SerialNumber().

bool Isis::ObservationNumberList::HasObservationNumber

(

const QString &

on

)

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

Parameters

on	The observation number to be checked for

Returns

bool

References Isis::SerialNumberList::p_pairs.

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

inherited

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 Isis::SerialNumberList::p_serialMap.

Referenced by Isis::SerialNumberList::Add(), Isis::MatchTool::deletePoint(), Isis::SerialNumberList::FileName(), Remove(), Isis::SerialNumberList::SerialNumberIndex(), and Isis::ControlNet::SetImages().

QString Isis::ObservationNumberList::ObservationNumber

(

const QString &

filename

)

return an observation number given a filename

Parameters

filename

The filename to be matched

Returns

QString The observation number corresponding to the input filename

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

Referenced by Remove().

QString Isis::ObservationNumberList::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

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

int Isis::ObservationNumberList::ObservationNumberMapIndex

(

const int

serialNumberIndex

)

Return a observation index given a serial number index.

Parameters

serialNumberIndex

The index of the serial number to map

Returns

int The observation index mapped to the serial number

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

int Isis::ObservationNumberList::ObservationSize

(

)

const

How many unique observations are in the list?

Returns

int Returns number of unique observations currently in the list

std::vector< QString > Isis::ObservationNumberList::PossibleFileNames

(

const QString &

on

)

Return possible filenames given an observation number.

Parameters

on	The observation number of the desired filename

Returns

vector<QString> The list of possible filenames matching the input observation number

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

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

inherited

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_, Isis::SerialNumberList::p_pairs, and Isis::IException::Programmer.

void Isis::ObservationNumberList::Remove

(

Isis::SerialNumberList *

snlist

)

Removes all of the listed serial numbers from the observation.

Parameters

snlist

The list of SerialNumbers to remove

References _FILEINFO_, Add(), Isis::SerialNumberList::HasSerialNumber(), ObservationNumber(), Isis::SerialNumberList::Size(), and Isis::IException::User.

Referenced by Remove().

void Isis::ObservationNumberList::Remove

(

const QString &

listfile

)

Removes all of the listed serial numbers from the observation.

Parameters

listfile

The list of SerialNumbers to remove

References Remove().

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

inherited

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_, Isis::FileName::expanded(), Isis::SerialNumberList::FileNameIndex(), Isis::SerialNumberList::p_fileMap, Isis::SerialNumberList::p_pairs, and Isis::IException::Programmer.

Referenced by 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::StereoTool::rubberBandComplete(), Isis::QnetNewMeasureDialog::setFiles(), and Isis::ControlNet::SetImages().

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

inherited

Return a serial number given an index.

Parameters

index

The index of the desired serial number

Returns

QString The serial number returned

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

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

inherited

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_, Isis::SerialNumberList::HasSerialNumber(), Isis::SerialNumberList::p_serialMap, and Isis::IException::Programmer.

Referenced by Isis::SerialNumberList::Add(), Isis::SerialNumberList::Delete(), and Isis::QnetPointDistanceFilter::filter().

int Isis::SerialNumberList::Size ( ) const

inherited

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

Returns

int Returns number of serial numbers current in the list

References Isis::SerialNumberList::p_pairs.

Referenced by 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::BundleAdjust::Images(), Isis::ObservationNumber::PossibleSerial(), Remove(), Isis::QnetNavTool::resetList(), Isis::QnetNewPointDialog::setFiles(), Isis::QnetNewMeasureDialog::setFiles(), Isis::QnetFixedPointDialog::setFiles(), Isis::ControlNet::SetImages(), and Isis::ControlNetGraphicsItem::snToFileName().

Member Data Documentation

bool Isis::SerialNumberList::p_checkTarget

protectedinherited

Referenced by Isis::SerialNumberList::Add(), and Isis::SerialNumberList::SerialNumberList().

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

protectedinherited

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

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

protectedinherited

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

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

protectedinherited

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

QString Isis::SerialNumberList::p_target

protectedinherited

Referenced by Isis::SerialNumberList::Add(), and Isis::SerialNumberList::SerialNumberList().

---

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

• src/base/objs/ObservationNumberList/ObservationNumberList.h
• src/base/objs/ObservationNumberList/ObservationNumberList.cpp