Grid Stream File¶

File extension: gst

File Object¶

class gsshapy.orm.GridStreamFile[source]¶

Bases: sqlalchemy.ext.declarative.api.Base, gsshapy.base.file_base.GsshaPyFileObjectBase

Object interface for the Grid Stream File.

The grid stream file is used to map the stream network to the model grid. The contents of the grid stream file is abstracted into two types of objects including: GridStreamCell and GridStreamNode. Each cell lists the stream nodes that are contained in it and each stream node defines the percentage of that stream that is contained inside a cell. See the documentation provided for each object for a more details.

See: http://www.gsshawiki.com/Surface_Water_Routing:Channel_Routing#5.1.4.2.1_-_STREAM_CELL_file_identifier

tableName = u'gst_grid_stream_files'¶: Database tablename

id¶: PK

streamCells¶: INTEGER

fileExtension¶: STRING

gridStreamCells¶: RELATIONSHIP

projectFile¶: RELATIONSHIP

Supporting Objects¶

class gsshapy.orm.GridStreamCell(cellI, cellJ, numNodes)[source]¶

Bases: sqlalchemy.ext.declarative.api.Base

Object containing the stream data for a single grid cell. A cell can contain several stream nodes.

tableName = u'gst_grid_stream_cells'¶: Database tablename

id¶: PK

gridStreamFileID¶: FK

gridStreamFile¶: RELATIONSHIP

gridStreamNodes¶: RELATIONSHIP

cellI¶: INTEGER

cellJ¶: INTEGER

numNodes¶: INTEGER

class gsshapy.orm.GridStreamNode(linkNumber, nodeNumber, nodePercentGrid)[source]¶

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single stream.

tableName = u'gst_grid_stream_nodes'¶: Database tablename

id¶: PK

gridStreamCellID¶: FK

gridStreamCell¶: RELATIONSHIP

linkNumber¶: INTEGER

nodeNumber¶: INTEGER

nodePercentGrid¶: FLOAT