code::ControlFilter Class Reference

Inheritance diagram for code::ControlFilter:

List of all members.

---

Detailed Description

Derived from ExternalFilter.

This control filter has domain information. Will write parameters' information to a control lb.

Author:

Lulin Song

Version:

Id

code_ControlFilter.h,v 1.2 2009/06/02 20:17:39 lakshman Exp

Public Types
typedef std::map< char, Option >	OptionMap
Public Member Functions
	ControlFilter (const std::string &filterName)
	A configuration file should exist or this executable should itself be in the PATH.
virtual int	launch (const Index::Record &rec, const std::string &outdir)
	write record to the output dir lb.
	ControlFilter ()
	for STL only.
virtual const std::string &	getName () const
std::string	getCommandLine () const
bool	hasDomain () const
code::Location	upperLeftCorner () const
code::Location	bottomRightCorner () const
void	setRegion (float lat_ul, float lon_ul, float lat_br, float lon_br)
void	showUsageLine (const std::string &arg, const std::string &desc) const
void	showUsage () const
const OptionMap &	options () const
	Returns the options that this command takes.
OptionMap &	options ()
	Returns the options that this command takes for changing.
void	setOption (const Option &opt)
	set or change the value of an option.
Protected Attributes
OptionMap	myOptions
XML::Element	config

---

Member Typedef Documentation

typedef std::map< char, Option > code::W2Program::OptionMap [inherited]

---

Constructor & Destructor Documentation

code::ControlFilter::ControlFilter

(

const std::string &

filterName

)

A configuration file should exist or this executable should itself be in the PATH.

code::ControlFilter::ControlFilter

(

)

[inline]

for STL only.

---

Member Function Documentation

code::Location code::ControlFilter::bottomRightCorner

(

)

const

std::string code::ControlFilter::getCommandLine

(

)

const

virtual const std::string& code::ControlFilter::getName

(

)

const [inline, virtual]

Reimplemented from code::W2Program.

bool code::ControlFilter::hasDomain

(

)

const [inline]

virtual int code::ControlFilter::launch	(	const Index::Record &	rec,
		const std::string &	outdir
	)			[virtual]

write record to the output dir lb.

Reimplemented from code::W2Program.

OptionMap& code::W2Program::options

(

)

[inline, inherited]

Returns the options that this command takes for changing.

const OptionMap& code::W2Program::options

(

)

const [inline, inherited]

Returns the options that this command takes.

This information is obtained from the configuration file w2config/filters/executableName

void code::W2Program::setOption

(

const Option &

opt

)

[inherited]

set or change the value of an option.

void code::ControlFilter::setRegion	(	float	lat_ul,
		float	lon_ul,
		float	lat_br,
		float	lon_br
	)			[inline]

void code::W2Program::showUsage

(

)

const [inherited]

void code::W2Program::showUsageLine	(	const std::string &	arg,
		const std::string &	desc
	)			const [inherited]

code::Location code::ControlFilter::upperLeftCorner

(

)

const

---

Member Data Documentation

XML::Element code::W2Program::config [protected, inherited]

OptionMap code::W2Program::myOptions [protected, inherited]

---