EcohydroLib  1.29
Public Member Functions | Public Attributes | List of all members
ecohydrolib.command.hydroshare.HydroShareCreateResource Class Reference
Inheritance diagram for ecohydrolib.command.hydroshare.HydroShareCreateResource:
ecohydrolib.command.base.Command ecohydrolib.command.base.Command

Public Member Functions

def __init__
 Construct a HydroShareCreateResource 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: Acquire USGS DEM data. More...
 
def __init__
 Construct a HydroShareCreateResource 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: Acquire USGS DEM data. More...
 
- Public Member Functions inherited from ecohydrolib.command.base.Command
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

 hydroshare
 
- Public Attributes inherited from ecohydrolib.command.base.Command
 context
 
 outfp
 
 studyArea
 

Constructor & Destructor Documentation

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

Construct a HydroShareCreateResource 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 ecohydrolib.command.hydroshare.HydroShareCreateResource.__init__ (   self,
  projectDir,
  configFile = None,
  outfp = sys.stdout 
)

Construct a HydroShareCreateResource 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 ecohydrolib.command.hydroshare.HydroShareCreateResource.checkMetadata (   self,
  args,
  kwargs 
)

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

def ecohydrolib.command.hydroshare.HydroShareCreateResource.checkMetadata (   self,
  args,
  kwargs 
)

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

def ecohydrolib.command.hydroshare.HydroShareCreateResource.run (   self,
  args,
  kwargs 
)

Run the command: Acquire USGS DEM data.

Arguments: auth hs_restclient.HydroShareAuth object title string representing the title of the resource hydroshare_host string representing DNS name of the HydroShare server in which to create the resource hydroshare_port int representing the TCP port of the HydroShare server use_https True if HTTPS should be used. Default: False resource_type string representing the HydroShare resource type that should be used to create the resource abstract string representing the abstract of the resource keywords list of strings representing the keywords to assign to the resource create_callback user-defined callable that takes as input a file size in bytes, and generates a callable to provide feedback to the user about the progress of the upload of resource_file. For more information, see: http://toolbelt.readthedocs.org/en/latest/uploading-data.html#monitoring-your-streaming-multipart-upload verbose – boolean Produce verbose output. Default: False. overwrite – boolean Overwrite existing output. Default: False.

def ecohydrolib.command.hydroshare.HydroShareCreateResource.run (   self,
  args,
  kwargs 
)

Run the command: Acquire USGS DEM data.

Arguments: auth hs_restclient.HydroShareAuth object title string representing the title of the resource hydroshare_host string representing DNS name of the HydroShare server in which to create the resource hydroshare_port int representing the TCP port of the HydroShare server use_https True if HTTPS should be used. Default: False resource_type string representing the HydroShare resource type that should be used to create the resource abstract string representing the abstract of the resource keywords list of strings representing the keywords to assign to the resource create_callback user-defined callable that takes as input a file size in bytes, and generates a callable to provide feedback to the user about the progress of the upload of resource_file. For more information, see: http://toolbelt.readthedocs.org/en/latest/uploading-data.html#monitoring-your-streaming-multipart-upload verbose – boolean Produce verbose output. Default: False. overwrite – boolean Overwrite existing output. Default: False.

Member Data Documentation

ecohydrolib.command.hydroshare.HydroShareCreateResource.hydroshare

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