Isis::PolygonSeederFactory Class Reference

This class is used to create PolygonSeeder objects. More...

#include <PolygonSeederFactory.h>

Collaboration diagram for Isis::PolygonSeederFactory:

Static Public Member Functions
static PolygonSeeder *	Create (Pvl &pvl)
	Create a PolygonSeeder object using a PVL specification.

Private Member Functions
	PolygonSeederFactory ()
	Constructor (its private so you can't use it).
	~PolygonSeederFactory ()
	Destroys the PolygonSeederFactory.

Detailed Description

This class is used to create PolygonSeeder objects.

Applications which use autoseeding of points in polygons can use different techniques such as Grid or ????. If this factory is given a Pvl object which contains a PolygonSeeder definition it will create that specific instance of the class. For example,

Object = PolygonSeeder
  Group = Algorithm
    Name = Grid
    ...
  EndGroup
  ...
EndObject
End

Will create a GridPolygonSeeder object (which is derived from PolygonSeeder). The simplest way to create an PolygonSeeder class is to use the static Create method

Pvl p("myPolygonSeeder.pvl");
PolygonSeeder *ps = PolygonSeederFactory::Create(p);

Author

2006-01-20 Stuart Sides

History:

2008-12-17 Christopher Austin - Fixed memory leak

Definition at line 64 of file PolygonSeederFactory.h.

Constructor & Destructor Documentation

Isis::PolygonSeederFactory::PolygonSeederFactory ( )

inlineprivate

Constructor (its private so you can't use it).

Use the Create Method instead.

Definition at line 73 of file PolygonSeederFactory.h.

Isis::PolygonSeederFactory::~PolygonSeederFactory ( )

inlineprivate

Destroys the PolygonSeederFactory.

Definition at line 76 of file PolygonSeederFactory.h.

Member Function Documentation

PolygonSeeder * Isis::PolygonSeederFactory::Create ( Pvl &  pvl )

static

Create a PolygonSeeder object using a PVL specification.

An example of the PVL required for this is:

Object = AutoSeed
  Group = PolygonSeederAlgorithm
    Name      = Grid
    Tolerance = 0.7
  EndGroup

  Group = InterestOperatorAlgorithm
    Name      = StandardDeviation
    Tolerance = 10
  EndGroup

EndObject

Parameters

pvl	The pvl object containing the PolygonSeeder specification

Definition at line 52 of file PolygonSeederFactory.cpp.

References Isis::PvlObject::findGroup(), Isis::Plugin::GetPlugin(), Isis::Pvl::read(), and Isis::PvlObject::Traverse.

---

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

• src/base/objs/PolygonSeederFactory/PolygonSeederFactory.h
• src/base/objs/PolygonSeederFactory/PolygonSeederFactory.cpp