ecohydrolib.command.base.Command Class Reference

Inheritance diagram for ecohydrolib.command.base.Command:

Public Member Functions
def	__init__
	Construct a EcohydroLib abstract command. More...
def	checkMetadata (self, args, kwargs)
	Check to make sure the project directory has the necessary metadata to run this command. More...
def	run (self, args, kwargs)
	Run the command. More...
def	__init__
	Construct a EcohydroLib abstract command. More...
def	checkMetadata (self, args, kwargs)
	Check to make sure the project directory has the necessary metadata to run this command. More...
def	run (self, args, kwargs)
	Run the command. More...

Public Attributes
	context
	outfp
	studyArea

Constructor & Destructor Documentation

def ecohydrolib.command.base.Command.__init__	(		self,
			projectDir,
			configFile = None,
			outfp = sys.stdout
	)

Construct a EcohydroLib abstract command.

Concrete commands must call this super class method in their constructor.

Arguments: projectDir – string The path to the project directory configFile – string The path to an EcohydroLib configuration file outfp – file-like object Where output should be written to

def ecohydrolib.command.base.Command.__init__	(		self,
			projectDir,
			configFile = None,
			outfp = sys.stdout
	)

Construct a EcohydroLib abstract command.

Concrete commands must call this super class method in their constructor.

Arguments: projectDir – string The path to the project directory configFile – string The path to an EcohydroLib configuration file outfp – file-like object Where output should be written to

Member Function Documentation

def ecohydrolib.command.base.Command.checkMetadata	(		self,
			args,
			kwargs
	)

Check to make sure the project directory has the necessary metadata to run this command.

Note

Concrete commands must call this super class method in their own implementation of checkMetadata(), and must call their implementation near the beginning of their run method.

def ecohydrolib.command.base.Command.checkMetadata	(		self,
			args,
			kwargs
	)

Check to make sure the project directory has the necessary metadata to run this command.

Note

Concrete commands must call this super class method in their own implementation of checkMetadata(), and must call their implementation near the beginning of their run method.

def ecohydrolib.command.base.Command.run	(		self,
			args,
			kwargs
	)

Run the command.

Note

Concrete classes must call checkMetadata() near the beginning of their run methods.

def ecohydrolib.command.base.Command.run	(		self,
			args,
			kwargs
	)

Run the command.

Note

Concrete classes must call checkMetadata() near the beginning of their run methods.

Member Data Documentation

ecohydrolib.command.base.Command.context

ecohydrolib.command.base.Command.outfp

ecohydrolib.command.base.Command.studyArea

---

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

• build/lib/ecohydrolib/command/base.py