Isis Developer Reference
Isis::BundleObservationVector Class Reference

This class is a container class for BundleObservations. More...

#include <BundleObservationVector.h>

Inheritance diagram for Isis::BundleObservationVector:
Inheritance graph
Collaboration diagram for Isis::BundleObservationVector:
Collaboration graph

Public Member Functions

 BundleObservationVector ()
 Constructs an empty BundleObservationVector. More...
 
 BundleObservationVector (const BundleObservationVector &src)
 Copy constructor. More...
 
 ~BundleObservationVector ()
 Destructor. More...
 
BundleObservationVectoroperator= (const BundleObservationVector &src)
 Assignment operator. More...
 
BundleObservationQsp addNew (BundleImageQsp image, QString observationNumber, QString instrumentId, BundleSettingsQsp bundleSettings)
 Adds a new BundleObservation to this vector or fetches an existing BundleObservation if this vector already contains the passed observation number. More...
 
int numberParameters ()
 Returns the sum of the position parameters and pointing parameters for the contained BundleObservations. More...
 
BundleObservationQsp observationByCubeSerialNumber (QString cubeSerialNumber)
 Accesses a BundleObservation associated with the passed serial number. More...
 
QList< QString > instrumentIds () const
 Get a list of all instrument IDs that there are observations for. More...
 
QList< BundleObservationQspobservationsByInstId (QString instrumentId) const
 Get all of the observations with a specific instrument ID. More...
 

Detailed Description

This class is a container class for BundleObservations.

It can be used for managing multiple BundleObservations.

Contained BundleObservations are stored as shared pointers, so they will be automatically deleted when all shared pointers are deleted.

Author
2014-05-22 Ken Edmundson

Constructor & Destructor Documentation

◆ BundleObservationVector() [1/2]

Isis::BundleObservationVector::BundleObservationVector ( )

Constructs an empty BundleObservationVector.

◆ BundleObservationVector() [2/2]

Isis::BundleObservationVector::BundleObservationVector ( const BundleObservationVector src)

Copy constructor.

Constructs a BundleObservationVector as a copy of another BundleObservationVector.

Parameters
srcA reference to the BundleObservationVector to copy from.

◆ ~BundleObservationVector()

Isis::BundleObservationVector::~BundleObservationVector ( )

Destructor.

Contained BundleObservations will remain until all shared pointers to them are deleted.

Member Function Documentation

◆ addNew()

BundleObservationQsp Isis::BundleObservationVector::addNew ( BundleImageQsp  bundleImage,
QString  observationNumber,
QString  instrumentId,
BundleSettingsQsp  bundleSettings 
)

Adds a new BundleObservation to this vector or fetches an existing BundleObservation if this vector already contains the passed observation number.

If observation mode is off, adds a new BundleObservation to this vector. Otherwise, if observation mode is on and the BundleObservation has already been added with the same observation number, the passed BundleImage is added to the existing BundleObservation.

Parameters
bundleImageQSharedPointer to the BundleImage to create or fetch a BundleObservation from
observationNumberObservation number of the observation to add or fetch
instrumentIdInstrument id of the observation
bundleSettingsQsp to BundleSettings for the observation
Exceptions
IException::Programmer"Unable to allocate new BundleObservation"
Returns
BundleObservationQsp Returns a pointer to the BundleObservation that was added

References _FILEINFO_, Isis::Camera::Csm, and Isis::IException::Programmer.

◆ instrumentIds()

QList< QString > Isis::BundleObservationVector::instrumentIds ( ) const

Get a list of all instrument IDs that there are observations for.

Referenced by Isis::BundleSolutionInfo::outputImagesCSV().

◆ numberParameters()

int Isis::BundleObservationVector::numberParameters ( )

Returns the sum of the position parameters and pointing parameters for the contained BundleObservations.

Returns
int Returns the total number of parameters for the contained BundleObservations

◆ observationByCubeSerialNumber()

BundleObservationQsp Isis::BundleObservationVector::observationByCubeSerialNumber ( QString  cubeSerialNumber)

Accesses a BundleObservation associated with the passed serial number.

If there is no BundleObservation associated with the serial number, a NULL pointer is returned.

Parameters
cubeSerialNumberSerial number of a cube to try to find an associated BundleObservation
Returns
BundleObservationQsp Pointer to the associated BundleObservation (NULL if not found)

◆ observationsByInstId()

QList< BundleObservationQsp > Isis::BundleObservationVector::observationsByInstId ( QString  instrumentId) const

Get all of the observations with a specific instrument ID.

Referenced by Isis::BundleSolutionInfo::outputImagesCSV().

◆ operator=()

BundleObservationVector & Isis::BundleObservationVector::operator= ( const BundleObservationVector src)

Assignment operator.

Assigns the state of the source BundleObservationVector to this BundleObservationVector.

Parameters
srcThe BundleObservationVector to assign from.
Returns
BundleObservationVector& A reference to this BundleObservationVector.

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