JIANG/EPANET
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

update api functions/extensions

Browse Source
This commit is contained in:
Marios Kyriakou
2018-11-09 17:15:53 +02:00
parent 123a0c3788
commit 9444646385
1 changed files with 20 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
ReleaseNotes2_2.md
View File

@@ -128,45 +128,14 @@ Both network files are available [here](https://doi.org/10.23719/1375314).
## New API functions ## New API functions
|Function|Description| |Function|Description|
|--|--| |--|--|
|`ENinit`|| |`ENinit`|Initializes an EPANET session|
|`ENsetflowunits`|| |`ENsetflowunits`|Sets the flow units|
|`ENgetdemandmodel`||
|`ENsetdemandmodel`||
|`ENgetdemandname`||
|`ENsetdemandname`||
|`ENsetdemandpattern`||
|`ENgetrule`||
|`ENsetrulepriority`||
|`ENgetpremise`||
|`ENsetpremise`||
|`ENsetpremiseindex`||
|`ENsetpremisestatus`||
|`ENsetpremisevalue`||
|`ENgetthenaction`||
|`ENsetthenaction`||
|`ENgetelseaction`||
|`ENsetelseaction`||
|`ENgetruleID`||
|`ENgetcurvetype`||
|`ENsetlinknodes`||
|`ENsetlinktype`||
|`ENaddnode`||
|`ENaddlink`||
|`ENaddpattern`||
|`ENaddcontrol`||
|`ENaddrule` ||
|`ENdeletenode`||
|`ENdeletelink`||
|`ENdeletecontrol`||
|`ENdeleterule` ||
|`ENsetnodeid` ||
|`ENsetlinkid` ||
|`ENgetcurvetype`|Get the type of a curve|
|`ENgetdemandmodel`|Retrieves the type of demand model in use and its parameters| |`ENgetdemandmodel`|Retrieves the type of demand model in use and its parameters|
|`ENsetdemandmodel`|Sets the type of demand model to use and its parameters| |`ENsetdemandmodel`|Sets the type of demand model to use and its parameters|
|`ENsetflowunits`|Sets the flow units| |`ENgetdemandname`|Sets the node's demand name for a category|
|`ENaddcontrol`|Specify parameters to add a new simple control| |`ENsetdemandname`|Sets the node's demand name for a category|
|`ENsetdemandpattern`|Sets the index of the demand pattern assigned to a node for a category index| |`ENsetdemandpattern`|Sets the index of the demand pattern assigned to a node for a category index|
|`ENsetheadcurveindex`|Sets the curve id for a specified pump index|
|`ENgetrule`|Gets the number of premises, true actions, and false actions and the priority of an existing rule-based control| |`ENgetrule`|Gets the number of premises, true actions, and false actions and the priority of an existing rule-based control|
|`ENsetrulepriority`|Sets the priority of the existing rule-based control| |`ENsetrulepriority`|Sets the priority of the existing rule-based control|
|`ENgetpremise`|Gets the components of a premise/condition in an existing rule-based control| |`ENgetpremise`|Gets the components of a premise/condition in an existing rule-based control|
@@ -174,22 +143,24 @@ Both network files are available [here](https://doi.org/10.23719/1375314).
|`ENsetpremiseindex`|Sets the index of an object in a premise of an existing rule-based control| |`ENsetpremiseindex`|Sets the index of an object in a premise of an existing rule-based control|
|`ENsetpremisestatus`|Sets the status in a premise of an existing rule-based control| |`ENsetpremisestatus`|Sets the status in a premise of an existing rule-based control|
|`ENsetpremisevalue`|Sets the value in a premise of an existing rule-based control| |`ENsetpremisevalue`|Sets the value in a premise of an existing rule-based control|
|`ENgettrueaction`|Gets the components of a true-action in an existing rule-based control| |`ENgetthenaction`|Get the components of a THEN action in a rule-based control|
|`ENsettrueaction`|Sets the components of a true-action in an existing rule-based control| |`ENsetthenaction`|Set the components of a THEN action in a rule-based control|
|`ENgetfalseaction`|Gets the components of a false-action in an existing rule-based control| |`ENgetelseaction`|Get the components of an ELSE action in a rule-based control|
|`ENsetfalseaction`|Sets the components of a false-action in an existing rule-based control| |`ENsetelseaction`|Set the components of an ELSE action in a rule-based control|
|`ENgetruleID`|Returns the ID of a rule| |`ENgetruleID`|Returns the ID of a rule|
|`ENinit`|Initializes an EPANET session| |`ENgetcurvetype`|Get the type of a curve|
|`ENsetheadcurveindex`|Sets the curve id for a specified pump index| |`ENsetlinknodes`|Set the indexes of a link's start- and end-nodes|
|`ENsetlinktype`|Set the link type code for a specified link| |`ENsetlinktype`|Set the link type code for a specified link|
|`ENaddnode`|Adds a new node| |`ENaddnode`|Adds a new node|
|`ENaddlink`|Adds a new link| |`ENaddlink`|Adds a new link|
|`ENdeletelink`|Deletes a link| |`ENaddcontrol`|Specify parameters to add a new simple control|
|`ENaddrule`|Add a new control rule to the project|
|`ENdeletenode`|Deletes a node| |`ENdeletenode`|Deletes a node|
| `ENsetnodeid` |Change the ID name for a node| |`ENdeletelink`|Deletes a link|
| `ENsetlinkid` |Change the ID name for a link| |`ENdeletecontrol`|Delete an existing simple control|
|`ENgetdemandname`|Sets the node's demand name for a category| |`ENdeleterule`|Delete a rule-based control|
|`ENsetdemandname`|Sets the node's demand name for a category| |`ENsetnodeid`|Change the ID name for a node|
|`ENsetlinkid`|Change the ID name for a link|
## API Extensions (additional definitions) ## API Extensions (additional definitions)
### Link value types: ### Link value types:
@@ -215,6 +186,7 @@ Both network files are available [here](https://doi.org/10.23719/1375314).
- `EN_MAXHEADERROR` - `EN_MAXHEADERROR`
- `EN_MAXFLOWCHANGE` - `EN_MAXFLOWCHANGE`
- `EN_MASSBALANCE` - `EN_MASSBALANCE`
### Action code types:
- `EN_UNCONDITIONAL` - `EN_UNCONDITIONAL`
- `EN_CONDITIONAL` - `EN_CONDITIONAL`
### Curve types: ### Curve types:
@@ -228,5 +200,4 @@ Both network files are available [here](https://doi.org/10.23719/1375314).
- `EN_PDA` - `EN_PDA`
## Authors contributing to this release: ## Authors contributing to this release:
- List item - List item