RHESSysWorkflows  1.33
Public Member Functions | Public Attributes | List of all members
rhessysworkflows.command.flowtable.FlowtableMultiple Class Reference
Inheritance diagram for rhessysworkflows.command.flowtable.FlowtableMultiple:
rhessysworkflows.command.base.GrassCommand rhessysworkflows.command.base.GrassCommand rhessysworkflows.command.base.Command rhessysworkflows.command.base.Command rhessysworkflows.command.base.Command rhessysworkflows.command.base.Command

Public Member Functions

def __init__
 Construct a FlowtableMultiple 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)
 Create flow tables for multiple worldfiles. More...
 
def __init__
 Construct a FlowtableMultiple 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)
 Create flow tables for multiple worldfiles. More...
 
- Public Member Functions inherited from rhessysworkflows.command.base.GrassCommand
def __init__
 Construct a RHESSysWorkflows abstract command that runs GRASS commands. More...
 
def checkMetadata (self, args, kwargs)
 Check to make sure the project directory has the necessary metadata to run this command. More...
 
def setupGrassEnv (self)
 
def run (self, args, kwargs)
 Run the command. More...
 
def __init__
 Construct a RHESSysWorkflows abstract command that runs GRASS commands. More...
 
def checkMetadata (self, args, kwargs)
 Check to make sure the project directory has the necessary metadata to run this command. More...
 
def setupGrassEnv (self)
 
def run (self, args, kwargs)
 Run the command. More...
 
- Public Member Functions inherited from rhessysworkflows.command.base.Command
def __init__
 Construct a RHESSysWorkflows 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 RHESSysWorkflows 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

 paths
 
- Public Attributes inherited from rhessysworkflows.command.base.GrassCommand
 grassMetadata
 
 modulePath
 
 grassDbase
 
 grassConfig
 
 grassLib
 
- Public Attributes inherited from rhessysworkflows.command.base.Command
 context
 
 outfp
 
 studyArea
 
 metadata
 

Constructor & Destructor Documentation

def rhessysworkflows.command.flowtable.FlowtableMultiple.__init__ (   self,
  projectDir,
  configFile = None,
  outfp = sys.stdout 
)

Construct a FlowtableMultiple command.

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 rhessysworkflows.command.flowtable.FlowtableMultiple.__init__ (   self,
  projectDir,
  configFile = None,
  outfp = sys.stdout 
)

Construct a FlowtableMultiple command.

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 rhessysworkflows.command.flowtable.FlowtableMultiple.checkMetadata (   self,
  args,
  kwargs 
)

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

def rhessysworkflows.command.flowtable.FlowtableMultiple.checkMetadata (   self,
  args,
  kwargs 
)

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

def rhessysworkflows.command.flowtable.FlowtableMultiple.run (   self,
  args,
  kwargs 
)

Create flow tables for multiple worldfiles.

Arguments: routeRoads – boolean Whether road routing should be enabled in createflowpaths. Default: False. routeRoofs – boolean Whether roof routing should be enabled in createflowpaths. Default: False. ignoreBurnedDEM – boolean If true, use the base DEM when running createflowpaths. If false, use the stream-burned DEM (if present). Default: False. force – boolean Whether to force createflowpaths to run if DEM X resolution != Y resolution. Default: False. verbose – boolean Produce verbose output. Default: False.

def rhessysworkflows.command.flowtable.FlowtableMultiple.run (   self,
  args,
  kwargs 
)

Create flow tables for multiple worldfiles.

Arguments: routeRoads – boolean Whether road routing should be enabled in createflowpaths. Default: False. routeRoofs – boolean Whether roof routing should be enabled in createflowpaths. Default: False. ignoreBurnedDEM – boolean If true, use the base DEM when running createflowpaths. If false, use the stream-burned DEM (if present). Default: False. force – boolean Whether to force createflowpaths to run if DEM X resolution != Y resolution. Default: False. verbose – boolean Produce verbose output. Default: False.

Member Data Documentation

rhessysworkflows.command.flowtable.FlowtableMultiple.paths

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