TiePointList Class Reference
Stores a set of tie points. More...
#include <TiePointList.h>
Public Member Functions | |
| virtual void | setMissionDatasetName (std::string missionName)=0 |
| virtual const std::string & | getMissionDatasetName () const =0 |
| virtual const std::vector < TiePoint > & | getTiePoints () const =0 |
| virtual void | adoptTiePoints (std::vector< TiePoint > &points)=0 |
Protected Member Functions | |
| virtual | ~TiePointList () |
Detailed Description
Stores a set of tie points.A TiePointList is a DataElement that stores a set of tie points.
This subclass of Subject will notify upon the following conditions:
- The following method is called: adoptTiePoints().
- Everything else documented in DataElement.
- See also:
- DataElement
Definition at line 68 of file TiePointList.h.
Constructor & Destructor Documentation
| virtual TiePointList::~TiePointList | ( | ) | [protected, virtual] |
This should be destroyed by calling ModelServices::destroyElement.
Definition at line 131 of file TiePointList.h.
Member Function Documentation
| virtual void TiePointList::setMissionDatasetName | ( | std::string | missionName | ) | [pure virtual] |
Sets the name of the mission dataset on the tie point list.
Sets the name of the mission dataset of the tie point list. A tie point list has two associated datasets. This method allows the specification of the second one. The name of the reference dataset is the name that is used when the tie point list is created.
- Parameters:
-
missionName The name of the mission dataset.
- See also:
- ModelServices::createElement()
| virtual const std::string& TiePointList::getMissionDatasetName | ( | ) | const [pure virtual] |
Gets the name of the mission dataset of the tie point list.
Gets the name of the mission dataset of the tie point list. A tie point list has two associated datasets. This method allows querying of the second one. The normal DataElement::getName() method gets the name of the reference dataset.
- Returns:
- The name of the mission dataset.
| virtual const std::vector<TiePoint>& TiePointList::getTiePoints | ( | ) | const [pure virtual] |
Gets a reference to the tie points in the list.
- Returns:
- The tie points in the list.
| virtual void TiePointList::adoptTiePoints | ( | std::vector< TiePoint > & | points | ) | [pure virtual] |
Sets the tie points in the list.
This method sets the tie points in the list and overwrites whatever tie points have already been to the list. It replaces rather than appends to the list.
The implementation of this method calls swap() on the given vector to avoid allocating potentially large amounts of memory. After calling this method, the contents of the given vector will be empty.
- Parameters:
-
points The points to set in the list. This is a non-const vector so that swap() can be called on the vector to avoid allocating potentially large amounts of memory.
- Subject Notifications:
- This method will notify Subject::signalModified.