PyTuflow: Difference between revisions
Content deleted Content added
Ellis Symons (talk | contribs) |
Ellis Symons (talk | contribs) No edit summary |
||
Line 17:
'''Methods'''
{|class="wikitable" style="text-align:
! 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=
|-
|rowspan='1' style='text-align: left'|<b>channelConnectionCount (</b> ''str'' Node ID <b>)</b>
|rowspan='1'|Returns the number of channels connected to a given node
|''int'' Count▼
▲|int Count
|-
|rowspan='1'|<b>channelConnections (</b> ''str'' Node ID <b>)</b>
|rowspan='1'|Returns a list of the channels connected to a given node
|-
▲|list -> str Channel ID
|rowspan='1'|<b>channelCount (</b> ''str'' Node ID <b>)</b>
|rowspan='1'|Returns the total number of channels in results
|''int'' Count
|-
|rowspan='1'|<b>channelResultTypes ()</b>
|rowspan='1'|Returns a list of all the available result types for channels
|list of Result Types
|-
|rowspan='1'|<b>channels ()</b>
|rowspan='1'|Returns a list of all the channels in the results
|''list'' Channel IDs
|-
|rowspan='1'|<b>channelsDownstream (</b> ''str'' Node ID <b>)</b>
|rowspan='1'|Returns a list of all the channels downstream of a given node
|''list'' Channel IDs
|-
|rowspan='1'|<b>channelsUpstream (</b> ''str'' Node ID <b>)</b>
|rowspan='1'|Returns a list of all the channels upstream of a given node
|''list'' Channel IDs
|-
|rowspan='1'|<b>format ()</b>
|rowspan='1'|Returns the result format i.e. '2013' or '2016'
|''str'' Format
|-
|rowspan='2'|<b>getAdverseGradients ()</b>
|rowspan='2'|Returns locations of any adverse water level or energy level (if result type available) gradients in long profile. Note getLongProfileData method must be called prior to calling this method
|Adverse Water Level Gradient Locations ( ''list' x data, ''list'' y data )
|-
|Adverse Energy Level Gradient Locations ( ''list'' x data, ''list'' y data )
|-
|rowspan='4'|<b>getLongProfileData (</b> ''float'' Timestep, ''str'' Result Type, ''str'' Channel ID, '[optional] ''str'' 2nd Channel ID <b>)</b>
|rowspan='4'|Returns long profile data from a given channel to another channel. If no second channel is specified will continue until no further channels downstream
|''bool'' Error
|-
|''str'' Message
|-
|Profile Data ( ''list'' x values, ''list'' y values )
|-
|rowspan='1'|<b>getLongProfileTimeOfMax ()</b>
|rowspan='1'|Returns the time of maximum water level along the profile. Note getLongProfileData method must be called prior to calling this method
|Profile Data ( ''list'' x values, ''list'' y values )
|-
|}
| |||