PyTuflow: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
Line 122:
|''str'' Node ID
|-
|rowspan='1'|<b>[[#nodeResultTypes|nodeResultTypes]] (</b> ''str'' Channel ID <b>)</b>
|rowspan='1'|Returns a list of all the available result types for nodes
|''list'' Result Types
Line 1,120:
# print to console
print('Downstream node of channel {0} is {1}'.format(channel, dns_node))
else:
# did not load correctly, print error message to console
print(message)
</pre>
 
==nodeResultTypes==
<b>nodeResultTypes (</b> ''str'' Channel ID <b>)</b><br>
Returns a list of all the available result types for nodes<br>
;Parameters:
: -
;Returns:
: '''Out:''' ''list''
:: List of available result types for nodes e.g. ['H', 'E']
'''Example'''<br>
<pre>
import pytuflow as tu
 
# Initialise result class
res = tu.ResData()
 
# load .tpc result file
path = r'C:\TUFLOW\results\M04_5m_001.tpc'
err, message = res.load(path)
 
# check results were loaded successfully before calling function
if not err:
result_types = res.nodeResultTypes()
# print to console
print('Available result types for nodes are:)
for result_type in result_types:
print(result_type)
else:
# did not load correctly, print error message to console