PyTuflow: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
Line 68:
|''tuple'' Profile Data ( ''list'' x values, ''list'' y values )
|-
|rowspan='12'|<b>getLongProfileTimeOfMax ()</b>
|rowspan='12'|Returns the time of maximum water level along the current profile. Note getLongProfileData method must be called prior to calling this method
|Profile Data ''list'' x values, ''list'' y values
|-
|''list'' y values
|-
|rowspan='1'|<b>getPipes ()</b>
|rowspan='1'|Returns any pipe or culvert data in the current profile. Note getLongProfileData method must be called prior to calling this method
|''list'' pipes [ ''list'' pipe vertexes [ ''tuple'' vertex ( x point, y point ) ] ]
|-
|rowspan='3'|<b>getTimeSeriesData (</b> ''str'' Element, ''str'' Result Type, [optional] ''str'' domain <b>)</b>
|rowspan='3'|Returns time series data for the given element (1D node, 1D channel, 2D PO, RL) for a the given result type. If there are duplicate names between 1D, PO, or RL elements it will give priority return to 1D elements first, PO elements second, and lastly RL elements unless 'domain' variable is explicitly specified (domain options: '1D', '2D', 'RL')
|''bool'' Error
|-
|''str'' Message
|-
|''tuple'' time series data ( ''list'' x data, ''list'' y data )
|-
|rowspan='2'|<b>load (</b> ''str'' filepath <b>)</b>
|rowspan='2'|Loads result file. File formats are *.tpc for TUFLOW release 2016 and later, or *.info for TUFLOW release 2013
|''bool'' Error
|-
|''str'' Message
|}