PyTuflow: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
Ellis Symons (talk | contribs) |
Ellis Symons (talk | contribs) |
||
| Line 18: | Line 18: | ||
'''Methods''' |
'''Methods''' |
||
{|class="wikitable" style="text-align: center;" |
{|class="wikitable" style="text-align: center;" |
||
! |
! style="background-color:#005581; font-weight:bold; color:white" width=20%| Method |
||
|! style="background-color:#005581; font-weight:bold; color:white;" width=30%|Description |
|||
|! style="background-color:#005581; font-weight:bold; color:white;" width=20%|Inputs |
|||
|! style="background-color:#005581; font-weight:bold; color:white;" width=20%|Returns |
|||
|- |
|- |
||
|rowspan='1'|<b>channelConnectionCount</b> |
|||
|<b>Method</b>||<b>Description</b>||<b>Inputs</b></b>||<b>Returns</b> |
|||
|rowspan='1'|Returns the number of channels connected to a given node |
|||
|str Node ID |
|||
|int Count |
|||
|- |
|- |
||
|rowspan='1'|<b> |
|rowspan='1'|<b>channelConnections</b> |
||
|rowspan='1'|Returns a list of the channels connected to a given node |
|rowspan='1'|Returns a list of the channels connected to a given node |
||
| |
|str Node ID |
||
| |
|list -> str Channel ID |
||
|- |
|||
|} |
|} |
||
Revision as of 15:12, 8 February 2019
Class: ResData
Class for TUFLOW time series results.
Initialised as an empty object, or with results with a *.tpc in TUFLOW 2016 release and later or *.info in TUFLOW 2013 release.
import pytuflow as tu
res = tu.ResData() # initialising as an empty object
# or
res = tu.ResData('M01_5m_001.tpc') # initialising with results
Methods
| Method | Description | Inputs | Returns |
|---|---|---|---|
| channelConnectionCount | Returns the number of channels connected to a given node | str Node ID | int Count |
| channelConnections | Returns a list of the channels connected to a given node | str Node ID | list -> str Channel ID |