GcpList Class Reference

A list containing a set of GCPs. More...

#include <GcpList.h>

Inheritance diagram for GcpList:

List of all members.

Public Member Functions
virtual const std::list < GcpPoint > &	getSelectedPoints () const =0
virtual void	addPoints (const std::list< GcpPoint > &points)=0
virtual void	addPoint (const GcpPoint &point)=0
virtual int	getCount () const =0
virtual void	removePoints (const std::list< GcpPoint > &points)=0
virtual void	removePoint (const GcpPoint &point)=0
virtual void	clearPoints ()=0
Static Public Member Functions
static const std::string &	signalPointAdded ()
static const std::string &	signalPointsAdded ()
static const std::string &	signalPointRemoved ()
static const std::string &	signalPointsRemoved ()
static const std::string &	signalCleared ()
Protected Member Functions
virtual	~GcpList ()

---

Detailed Description

A list containing a set of GCPs.

The GcpList class stores a list of GcpPoint structs and allows for editing of the list and saving to disk. It is an abstract class providing the interface for this capability. The GcpList is used primarily for georeferencing.

This subclass of Subject will notify upon the following conditions:

• The following methods are called: addPoints(), addPoint(), removePoints(), removePoint(), clearPoints().
• Everything else documented in DataElement.

Definition at line 77 of file GcpList.h.

---

Constructor & Destructor Documentation

virtual GcpList::~GcpList

(

)

[protected, virtual]

This should be destroyed by calling ModelServices::destroyElement.

Definition at line 175 of file GcpList.h.

---

Member Function Documentation

static const std::string& GcpList::signalPointAdded

(

)

[static]

Emitted with any<GcpPoint> when a GCP is added to the list.

Definition at line 83 of file GcpList.h.

static const std::string& GcpList::signalPointsAdded

(

)

[static]

Emitted with any<list<GcpPoint> > when GCPs are added to the list.

Definition at line 87 of file GcpList.h.

static const std::string& GcpList::signalPointRemoved

(

)

[static]

Emitted with any<GcpPoint> when a GCP is removed from the list.

Definition at line 91 of file GcpList.h.

static const std::string& GcpList::signalPointsRemoved

(

)

[static]

Emitted with any<list<GcpPoint> > when GCPs are removed from the list.

Definition at line 95 of file GcpList.h.

static const std::string& GcpList::signalCleared

(

)

[static]

Emitted when the list is cleared.

Definition at line 99 of file GcpList.h.

virtual const std::list<GcpPoint>& GcpList::getSelectedPoints

(

)

const [pure virtual]

Gets the list of GcpPoints the comprise the GcpList.

Returns:

Returns a reference to the internal list of GcpPoint structs.

virtual void GcpList::addPoints

(

const std::list< GcpPoint > &

points

)

[pure virtual]

Merges GcpPoints into the GcpList.

The added points will be placed at the end of the list.

Parameters:

points

A list of GcpPoints to add to the GcpList.

Subject Notifications:

This method will notify signalGcpsAdded with any<list<GcpPoint> >

virtual void GcpList::addPoint

(

const GcpPoint &

point

)

[pure virtual]

Merges a GcpPoint into the GcpList.

The added point will be placed at the end of the list.

Parameters:

point

A GcpPoint to add to the GcpList.

Subject Notifications:

This method will notify signalGcpAdded with any<GcpPoint>

virtual int GcpList::getCount

(

)

const [pure virtual]

Returns the number of GCPs in the list.

This method is equivalent to getSelectedPoints().size().

Returns:

The number of GCPs in the list.

virtual void GcpList::removePoints

(

const std::list< GcpPoint > &

points

)

[pure virtual]

Removes GcpPoints from the GcpList.

Any GcpPoints in the GcpList that are also in the list provided as parameter will be removed from the GcpList.

Parameters:

points

A list of GcpPoints to remove from the GcpList

Subject Notifications:

This method will notify signalGcpsRemoved with any<list<GcpPoint> >

virtual void GcpList::removePoint

(

const GcpPoint &

point

)

[pure virtual]

Removes a GcpPoint from the GcpList.

If the GcpPoint matches a point in the GcpList, it will be removed from the GcpList.

Parameters:

point

The GcpPoint to remove from the GcpList

Subject Notifications:

This method will notify signalGcpRemoved with GcpPoint

virtual void GcpList::clearPoints

(

)

[pure virtual]

Removes all GcpPoints from the GcpList.

Subject Notifications:

This method will notify signalCleared