EcohydroLib  1.29
Public Member Functions | Public Attributes | List of all members
ecohydrolib.metadata.ModelRun Class Reference
Inheritance diagram for ecohydrolib.metadata.ModelRun:
ecohydrolib.metadata.MetadataEntity ecohydrolib.metadata.MetadataEntity

Public Member Functions

def __init__
 
def writeToMetadata (self, context)
 Write ModelRun data to model run section of metadata for a given project directory. More...
 
def readFromMetadata (cls, context, fqId)
 Read ModelRun data from model run section of metadata for a given project directory. More...
 
def __init__
 
def writeToMetadata (self, context)
 Write ModelRun data to model run section of metadata for a given project directory. More...
 
def readFromMetadata (cls, context, fqId)
 Read ModelRun data from model run section of metadata for a given project directory. More...
 

Public Attributes

 modelType
 
 runNumber
 
 description
 
 date
 
 command
 
 output
 

Additional Inherited Members

Constructor & Destructor Documentation

def ecohydrolib.metadata.ModelRun.__init__ (   self,
  modelType = None 
)
def ecohydrolib.metadata.ModelRun.__init__ (   self,
  modelType = None 
)

Member Function Documentation

def ecohydrolib.metadata.ModelRun.readFromMetadata (   cls,
  context,
  fqId 
)

Read ModelRun data from model run section of metadata for a given project directory.

Parameters
contextContext object containing projectDir, the path of the project whose metadata store is to be read from
fqIdString representing the fully qualified ID of the model run: <model_type>_<run_number>
Returns
A new ModelRun instance with data populated from metadata

KeyError if required field is not in metadata

def ecohydrolib.metadata.ModelRun.readFromMetadata (   cls,
  context,
  fqId 
)

Read ModelRun data from model run section of metadata for a given project directory.

Parameters
contextContext object containing projectDir, the path of the project whose metadata store is to be read from
fqIdString representing the fully qualified ID of the model run: <model_type>_<run_number>
Returns
A new ModelRun instance with data populated from metadata

KeyError if required field is not in metadata

def ecohydrolib.metadata.ModelRun.writeToMetadata (   self,
  context 
)

Write ModelRun data to model run section of metadata for a given project directory.

Note
Will set run number to value to be stored in metadata
Parameters
contextContext object containing projectDir, the path of the project whose metadata store is to be written to
Exceptions
Exceptionif model type has not known
Exceptionif section is not a valid GenericMetadata section
def ecohydrolib.metadata.ModelRun.writeToMetadata (   self,
  context 
)

Write ModelRun data to model run section of metadata for a given project directory.

Note
Will set run number to value to be stored in metadata
Parameters
contextContext object containing projectDir, the path of the project whose metadata store is to be written to
Exceptions
Exceptionif model type has not known
Exceptionif section is not a valid GenericMetadata section

Member Data Documentation

ecohydrolib.metadata.ModelRun.command
ecohydrolib.metadata.ModelRun.date
ecohydrolib.metadata.ModelRun.description
ecohydrolib.metadata.ModelRun.modelType
ecohydrolib.metadata.ModelRun.output
ecohydrolib.metadata.ModelRun.runNumber

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