USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::SerialNumber Class Reference
[Control Networks]

Serial Number composer. More...

#include <SerialNumber.h>

Inherited by Isis::ObservationNumber.

List of all members.

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.

Detailed Description

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.

Author:
2005-07-28 Stuart Sides

Constructor & Destructor Documentation

Isis::SerialNumber::SerialNumber (  ) 

Create an empty SerialNumber object.

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

Destroy a SerialNumber object.

Member Function Documentation

QString Isis::SerialNumber::Compose ( const QString &  filename,
bool  def2filename = false 
) [static]

Compose a SerialNumber from a file.

Parameters:
filename a filename to open
def2filename If a serial number could not be found, try to return the filename
Returns:
Calculated SerialNumber or FileName

Reimplemented in Isis::ObservationNumber.

References Compose().

QString Isis::SerialNumber::Compose ( Cube &  cube,
bool  def2filename = false 
) [static]

Compose a SerialNumber from a Cube.

Parameters:
cube An opened Isis cub
def2filename If a serial number could not be found, try to return the filename
Returns:
Calculated SerialNumber or FileName

Reimplemented in Isis::ObservationNumber.

References Compose(), and Isis::Cube::label().

QString Isis::SerialNumber::Compose ( Pvl &  label,
bool  def2filename = false 
) [static]

Compose a SerialNumber from a PVL.

Parameters:
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
Returns:
Calculated SerialNumber or FileName

Reimplemented in Isis::ObservationNumber.

References CreateSerialNumber(), and Isis::PvlContainer::FileName().

Referenced by Isis::SerialNumberList::Add(), Compose(), ComposeObservation(), Isis::ChipViewport::paintEvent(), Isis::StereoTool::paintViewport(), and Isis::ProcessMosaic::SetMosaicOrigin().

QString Isis::SerialNumber::ComposeObservation ( const QString &  sn,
SerialNumberList &  list,
bool  def2filename = false 
) [static]

Creates the ObservationNumber from a string representing the SerialNumber and a SerialList.

Parameters:
sn the string representing the SerialNumber
list the SerialNumberList
def2filename If a serial number could not be found, try to return the filename
Returns:
Calculated SerialNumber or FileName

References Compose(), and Isis::SerialNumberList::FileName().

QString Isis::SerialNumber::CreateSerialNumber ( PvlGroup &  snGroup,
int  keys 
) [static, protected]

Create the SerialNumber string by concatenating the keywords in the label with '/' in between serialNumber groups and the number of observationKeys.

Parameters:
snGroup A PvlGroup containing the keywords to concatenate
keys the number of strings to contatenate

Referenced by Compose(), and Isis::ObservationNumber::Compose().

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