RHESSysCalibrator  2.1.0
Public Member Functions | Public Attributes | List of all members
rhessys_calibrator_results.ClusterCalibratorResults Class Reference

Main driver class for cluster_calibrator_results tool. More...

Inheritance diagram for rhessys_calibrator_results.ClusterCalibratorResults:

Public Member Functions

def __init__ (self, args)
 
def OnSessionGridCellClick (self, event)
 Display session details and runs for session. More...
 
def OnRunGridCellClick (self, event)
 Display run details for run. More...
 
def addSessionsToGrid (self, grid, begin_row, begin_col)
 Add session.id to each row of the grid. More...
 
def addRunsToGrid (self, grid, runs, begin_row, begin_col)
 Add run summary information for self.runGrid. More...
 
def setSessionDetail (self, grid, session, begin_row, begin_col)
 Sets session detail in GUI. More...
 
def addRunDetailsToGrid (self, grid, run, begin_row, begin_col)
 Sets run detail in GUI. More...
 
def findIndexByID (cls, collection, id)
 Finds the index of the session in sessions with session_id. More...
 
def OnCloseWindow (self, event)
 
def __del__ (self)
 
def __init__ (self, args)
 
def OnSessionGridCellClick (self, event)
 Display session details and runs for session. More...
 
def OnRunGridCellClick (self, event)
 Display run details for run. More...
 
def addSessionsToGrid (self, grid, begin_row, begin_col)
 Add session.id to each row of the grid. More...
 
def addRunsToGrid (self, grid, runs, begin_row, begin_col)
 Add run summary information for self.runGrid. More...
 
def setSessionDetail (self, grid, session, begin_row, begin_col)
 Sets session detail in GUI. More...
 
def addRunDetailsToGrid (self, grid, run, begin_row, begin_col)
 Sets run detail in GUI. More...
 
def findIndexByID (cls, collection, id)
 Finds the index of the session in sessions with session_id. More...
 
def OnCloseWindow (self, event)
 
def __del__ (self)
 

Public Attributes

 calibratorDB
 
 sessions
 
 runs
 
 selectedSession
 
 mgr
 
 sessionGrid
 
 sessionDetail
 
 runGrid
 
 runDetail
 
 logger
 

Detailed Description

Main driver class for cluster_calibrator_results tool.

Constructor & Destructor Documentation

def rhessys_calibrator_results.ClusterCalibratorResults.__init__ (   self,
  args 
)
def rhessys_calibrator_results.ClusterCalibratorResults.__del__ (   self)
def rhessys_calibrator_results.ClusterCalibratorResults.__init__ (   self,
  args 
)
def rhessys_calibrator_results.ClusterCalibratorResults.__del__ (   self)

Member Function Documentation

def rhessys_calibrator_results.ClusterCalibratorResults.addRunDetailsToGrid (   self,
  grid,
  run,
  begin_row,
  begin_col 
)

Sets run detail in GUI.

Arguments: grid – wx.grid.Grid The grid to add run details to run – model_runner_db.CalibrationRun begin_row – int The row to begin adding values to begin_col – int The column to begin adding values to

def rhessys_calibrator_results.ClusterCalibratorResults.addRunDetailsToGrid (   self,
  grid,
  run,
  begin_row,
  begin_col 
)

Sets run detail in GUI.

Arguments: grid – wx.grid.Grid The grid to add run details to run – model_runner_db.CalibrationRun begin_row – int The row to begin adding values to begin_col – int The column to begin adding values to

def rhessys_calibrator_results.ClusterCalibratorResults.addRunsToGrid (   self,
  grid,
  runs,
  begin_row,
  begin_col 
)

Add run summary information for self.runGrid.

Arguments: grid – wx.grid.Grid Grid to add run information to runs – list<model_runner_db.CalibrationRun> begin_row – int Row at which to begin writing information begin_col – int Column at which to begin writing information

def rhessys_calibrator_results.ClusterCalibratorResults.addRunsToGrid (   self,
  grid,
  runs,
  begin_row,
  begin_col 
)

Add run summary information for self.runGrid.

Arguments: grid – wx.grid.Grid Grid to add run information to runs – list<model_runner_db.CalibrationRun> begin_row – int Row at which to begin writing information begin_col – int Column at which to begin writing information

def rhessys_calibrator_results.ClusterCalibratorResults.addSessionsToGrid (   self,
  grid,
  begin_row,
  begin_col 
)

Add session.id to each row of the grid.

Arguments: grid – wx.grid.Grid The grid to add session IDs to begin_row – int The row to begin adding values to begin_col – int The column to begin adding values to

def rhessys_calibrator_results.ClusterCalibratorResults.addSessionsToGrid (   self,
  grid,
  begin_row,
  begin_col 
)

Add session.id to each row of the grid.

Arguments: grid – wx.grid.Grid The grid to add session IDs to begin_row – int The row to begin adding values to begin_col – int The column to begin adding values to

def rhessys_calibrator_results.ClusterCalibratorResults.findIndexByID (   cls,
  collection,
  id 
)

Finds the index of the session in sessions with session_id.

If more than one item in the collection has the same ID, the index of the first item will be returned

Arguments: collection – A collection of objects that have an "id" attribute id – int The ID to search for

Raises ValueError if a session with session_id is not in sessions

def rhessys_calibrator_results.ClusterCalibratorResults.findIndexByID (   cls,
  collection,
  id 
)

Finds the index of the session in sessions with session_id.

If more than one item in the collection has the same ID, the index of the first item will be returned

Arguments: collection – A collection of objects that have an "id" attribute id – int The ID to search for

Raises ValueError if a session with session_id is not in sessions

def rhessys_calibrator_results.ClusterCalibratorResults.OnCloseWindow (   self,
  event 
)
def rhessys_calibrator_results.ClusterCalibratorResults.OnCloseWindow (   self,
  event 
)
def rhessys_calibrator_results.ClusterCalibratorResults.OnRunGridCellClick (   self,
  event 
)

Display run details for run.

Precondition: self.selectedSession is initialized to an integer representing the session currently selected

Precondition: self.runs[self.selectedSession] is a list of runs in the selected session

Assumption: runGrid stores run IDs in column 0

Arguments: event – wx.GridEvent The event

def rhessys_calibrator_results.ClusterCalibratorResults.OnRunGridCellClick (   self,
  event 
)

Display run details for run.

Precondition: self.selectedSession is initialized to an integer representing the session currently selected

Precondition: self.runs[self.selectedSession] is a list of runs in the selected session

Assumption: runGrid stores run IDs in column 0

Arguments: event – wx.GridEvent The event

def rhessys_calibrator_results.ClusterCalibratorResults.OnSessionGridCellClick (   self,
  event 
)

Display session details and runs for session.

Precondition: self.sessions is initialized

Arguments: event – wx.GridEvent The event

def rhessys_calibrator_results.ClusterCalibratorResults.OnSessionGridCellClick (   self,
  event 
)

Display session details and runs for session.

Precondition: self.sessions is initialized

Arguments: event – wx.GridEvent The event

def rhessys_calibrator_results.ClusterCalibratorResults.setSessionDetail (   self,
  grid,
  session,
  begin_row,
  begin_col 
)

Sets session detail in GUI.

Arguments: grid – wx.grid.Grid The grid to add session details t session – model_runner_db.CalibrationSession begin_row – int The row to begin adding values to begin_col – int The column to begin adding values to

def rhessys_calibrator_results.ClusterCalibratorResults.setSessionDetail (   self,
  grid,
  session,
  begin_row,
  begin_col 
)

Sets session detail in GUI.

Arguments: grid – wx.grid.Grid The grid to add session details t session – model_runner_db.CalibrationSession begin_row – int The row to begin adding values to begin_col – int The column to begin adding values to

Member Data Documentation

rhessys_calibrator_results.ClusterCalibratorResults.calibratorDB
rhessys_calibrator_results.ClusterCalibratorResults.logger
rhessys_calibrator_results.ClusterCalibratorResults.mgr
rhessys_calibrator_results.ClusterCalibratorResults.runDetail
rhessys_calibrator_results.ClusterCalibratorResults.runGrid
rhessys_calibrator_results.ClusterCalibratorResults.runs
rhessys_calibrator_results.ClusterCalibratorResults.selectedSession
rhessys_calibrator_results.ClusterCalibratorResults.sessionDetail
rhessys_calibrator_results.ClusterCalibratorResults.sessionGrid
rhessys_calibrator_results.ClusterCalibratorResults.sessions

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