casa::PlotLogLocate Class Reference

Used to report located indices. More...

#include <PlotLogger.h>

Inheritance diagram for casa::PlotLogLocate:

List of all members.

Public Member Functions
	PlotLogLocate (const String &origin1, const String &origin2, const PlotRegion &locateRegion, vector< vector< pair< unsigned int, unsigned int > > > *locatedIndices, int eventType=DEFAULT_EVENT_TYPE, bool deleteIndicesOnDestruction=true)
	Non-Static //.
	PlotLogLocate (const PlotLogLocate &copy)
	Copy constructor.
	~PlotLogLocate ()
	Destructor.
const PlotRegion &	locateRegion () const
	Returns the region that was located.
unsigned int	numLocatedIndices () const
	Returns the total number of points that were located.
unsigned int	numSearchedPlots () const
	Returns the number of plots that were searched.
vector< vector< pair< unsigned int, unsigned int > > > *	indices () const
	Returns the located indices.
vector< pair< unsigned int, unsigned int > > *	plotIndices (unsigned int index) const
	Returns the located indices for the plot at the given index, or NULL for invalid.
bool	willDeleteIndices () const
	Returns whether or not this message will delete the indices vector on destruction or not.
Static Public Member Functions
static PlotLogLocate	canvasLocate (PlotCanvas *canvas, const PlotRegion &region)
	Static //.
Private Attributes
PlotRegion	m_region
	Region.
vector< vector< pair< unsigned int, unsigned int > > > *	m_indices
	Indices.
bool	m_shouldDelete
	Should delete indices.

---

Detailed Description

Used to report located indices.

Basically just a container for the results of a PlotCanvas::locate.

Definition at line 188 of file PlotLogger.h.

---

Constructor & Destructor Documentation

casa::PlotLogLocate::PlotLogLocate	(	const String &	origin1,
		const String &	origin2,
		const PlotRegion &	locateRegion,
		vector< vector< pair< unsigned int, unsigned int > > > *	locatedIndices,
		int	eventType = DEFAULT_EVENT_TYPE,
		bool	deleteIndicesOnDestruction = true
	)

Non-Static //.

Constructor which takes the two origins, the region that was located, and the located indices (see PlotCanvas::locate()). If deleteIndicesOnDestruction is true, the given indices vector will be deleted when this message is destroyed. This should be used with care if multiple PlotLogLocates using the same located indices are being used.

casa::PlotLogLocate::PlotLogLocate

(

const PlotLogLocate &

copy

)

Copy constructor.

NOTE: will set the deleteIndicesOnDestruction flag on the original to false so that the indices won't be deleted from out under the copy.

casa::PlotLogLocate::~PlotLogLocate

(

)

Destructor.

---

Member Function Documentation

static PlotLogLocate casa::PlotLogLocate::canvasLocate	(	PlotCanvas *	canvas,
		const PlotRegion &	region
	)		[static]

Static //.

Convenience access to PlotCanvas::locate() to return a PlotLogLocate message.

vector<vector<pair<unsigned int, unsigned int> > >* casa::PlotLogLocate::indices

(

)

const

Returns the located indices.

const PlotRegion& casa::PlotLogLocate::locateRegion

(

)

const

Returns the region that was located.

unsigned int casa::PlotLogLocate::numLocatedIndices

(

)

const

Returns the total number of points that were located.

unsigned int casa::PlotLogLocate::numSearchedPlots

(

)

const

Returns the number of plots that were searched.

vector<pair<unsigned int, unsigned int> >* casa::PlotLogLocate::plotIndices

(

unsigned int

index

)

const

Returns the located indices for the plot at the given index, or NULL for invalid.

bool casa::PlotLogLocate::willDeleteIndices

(

)

const

Returns whether or not this message will delete the indices vector on destruction or not.

---

Member Data Documentation

vector<vector<pair<unsigned int, unsigned int> > >* casa::PlotLogLocate::m_indices [private]

Indices.

Definition at line 247 of file PlotLogger.h.

PlotRegion casa::PlotLogLocate::m_region [private]

Region.

Definition at line 244 of file PlotLogger.h.

bool casa::PlotLogLocate::m_shouldDelete [private]

Should delete indices.

Definition at line 250 of file PlotLogger.h.

---

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

• code/graphics/GenericPlotter/PlotLogger.h