PyTuflow: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
Line 154:
|''list'' RL ID
|-
|rowspan='1'|<b>[[#rlPointCount|rlPointCount]] ()</b>
|rowspan='1'|Returns the total number of point Reporting Locations in the results
|''int'' Count
Line 1,364:
for rl_name in rl_names:
print(rl_name)
else:
# did not load correctly, print error message to console
print(message)
</pre>
 
==rlPointCount==
<b>rlPointCount ()</b><br>
Returns the total number of point Reporting Locations in the results<br>
;Parameters:
: -
;Returns:
: '''Count:''' ''int''
:: Number of RL Point objects
'''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:
rl_point_count = res.rlPointCount()
# print to console
print('{0} RL Point objects in results.format(node_line_count))
else:
# did not load correctly, print error message to console