PyTuflow: Difference between revisions

Content deleted Content added
No edit summary
Line 110:
|''float'' Maximum Value
|-
|rowspan='1'|<b>[[#name|name]] ()</b>
|rowspan='1'|Returns the name of the result
|''str'' Name
Line 1,031:
# print to console
print('Max flow change in any given timestep at {0} is {1} m3/s'.format(loc, tsMaximum)
else:
# did not load correctly, print error message to console
print(message)
</pre>
 
==name==
<b>name ()</b><br>
Returns the name of the result<br>
;Parameters:
: -
;Returns:
: '''Name:''' ''str''
:: Name of results
'''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:
name = res.name()
# print to console
print('Results from {0} loaded successfully.format(name))
else:
# did not load correctly, print error message to console