 |
Isis 3 Programmer Reference
|
|
Isis 3 Programmer Reference
|
Serial Number composer. More...
#include <SerialNumber.h>
Public Member Functions | |
| SerialNumber () | |
| Create an empty SerialNumber object. | |
| virtual | ~SerialNumber () |
| Destroy a SerialNumber object. | |
Static Public Member Functions | |
| static QString | Compose (Pvl &label, bool def2filename=false) |
| Compose a SerialNumber from a PVL. | |
| static QString | Compose (Cube &cube, bool def2filename=false) |
| Compose a SerialNumber from a Cube. | |
| static QString | Compose (const QString &filename, bool def2filename=false) |
| Compose a SerialNumber from a file. | |
| static QString | ComposeObservation (const QString &sn, SerialNumberList &list, bool def2filename=false) |
| Creates the ObservationNumber from a string representing the SerialNumber and a SerialList. | |
Static Protected Member Functions | |
| static QString | CreateSerialNumber (PvlGroup &snGroup, int key) |
| Create the SerialNumber string by concatenating the keywords in the label with '/' in between serialNumber groups and the number of observationKeys. | |
Static Private Member Functions | |
| static PvlGroup | FindSerialTranslation (Pvl &label) |
| Get Groups by translating from correct Translation table. | |
Serial Number composer.
A Serial Number is a unique identification for some object such as an Isis cube. A Serial Number for a specific object must be repeatable. This class is intended to be used to create all Serial Numbers for Isis.
2005-07-28 Stuart Sides Original version
2005-08-02 Jeff Anderson added new static methods for serial number composition from a cube or filename
2006-01-24 Jacob Danton Updated the SerialNumber Compose method to use .trn files specific to the mission
2006-06-15 Kris Becker Added the return of the filename as the fallback default condition. "Unknown" will still be returned if the input source is a label created in memory and does not have a valid serial number signature and it was not read in from a file. Add a test for this to the unitTest.
2006-12-08 Stuart Sides Added parameter the the Compose methods to allow or disallow defaulting to the filename. This parameter has a default of false. Which will cause "Unknown" to be returned for files where a SN could not be correctly produced.
2007-07-09 Steven Lambright Changed missions translation filename from Missions.trn to MissionName2DataDir.trn
2007-09-11 Steven Koechle Added three ComposeObservation methods and made code reusable by seperating existing code into two private methods.
2007-09-13 Steven Koechle Fixed boolean paramaters passed into FindSerialTranslation
2008-01-10 Christpher Austin Removed the use of the system default file in FindSerialTranslation() and detached ObservationNumber functionality into its own class
2008-05-09 Steven Lambright Optimized the FindSerialTranslation method
2008-05-18 Steven Lambright Fixed documentation
2020-03-03 Kristin Berry - Updated to use translation files moved into source. References #3727.
Definition at line 71 of file SerialNumber.h.
| Isis::SerialNumber::SerialNumber | ( | ) |
Create an empty SerialNumber object.
Definition at line 23 of file SerialNumber.cpp.
|
virtual |
Destroy a SerialNumber object.
Definition at line 28 of file SerialNumber.cpp.
|
static |
Compose a SerialNumber from a file.
| filename | a filename to open |
| def2filename | If a serial number could not be found, try to return the filename |
Definition at line 86 of file SerialNumber.cpp.
References Compose().
|
static |
Compose a SerialNumber from a Cube.
| cube | An opened Isis cub |
| def2filename | If a serial number could not be found, try to return the filename |
Definition at line 73 of file SerialNumber.cpp.
References Compose(), and Isis::Cube::label().
|
static |
Compose a SerialNumber from a PVL.
| label | A pvl formatted label to be used to generate the serial number |
| def2filename | If a serial number could not be found, try to return the filename |
Definition at line 38 of file SerialNumber.cpp.
References CreateSerialNumber(), Isis::PvlContainer::fileName(), FindSerialTranslation(), and Isis::FileName::name().
Referenced by Isis::SerialNumberList::add(), Compose(), Compose(), Isis::ControlNetTool::drawAllMeasurements(), Isis::QnetTool::drawAllMeasurments(), Isis::QnetFileTool::loadImage(), Isis::ControlNetTool::mouseButtonRelease(), Isis::QnetTool::openGround(), Isis::ChipViewport::paintEvent(), Isis::StereoTool::paintViewport(), Isis::Image::serialNumber(), Isis::MatchTool::serialNumberList(), Isis::StereoTool::setFiles(), Isis::ControlPointEditWidget::setGroundSourceInfo(), Isis::Shape::XmlHandler::startElement(), Isis::ProcessMosaic::StartProcess(), and Isis::AdvancedTrackTool::updateRow().
|
static |
Creates the ObservationNumber from a string representing the SerialNumber and a SerialList.
| sn | the string representing the SerialNumber |
| list | the SerialNumberList |
| def2filename | If a serial number could not be found, try to return the filename |
Definition at line 185 of file SerialNumber.cpp.
References Isis::ObservationNumber::Compose(), and Isis::SerialNumberList::fileName().
|
staticprotected |
Create the SerialNumber string by concatenating the keywords in the label with '/' in between serialNumber groups and the number of observationKeys.
| snGroup | A PvlGroup containing the keywords to concatenate |
| keys | the number of strings to contatenate |
Definition at line 164 of file SerialNumber.cpp.
Referenced by Isis::ObservationNumber::Compose(), and Compose().
Get Groups by translating from correct Translation table.
| label | A pvl formatted label to be used to generate the serial number |
Definition at line 97 of file SerialNumber.cpp.
References Isis::PvlObject::findObject(), and Isis::toString().
Referenced by Compose().