Julia API client for BmiClient
OpenAPI specification for the Basic Modeling Interface (BMI). All functions are described on the BMI homepage.
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 2.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.JuliaClientCodegen
For more information, please visit https://www.ewatercycle.org/contact/
Installation
Place the Julia files generated under the src folder in your Julia project. Include BmiClient.jl in the project code. It would include the module named BmiClient.
Documentation is generated as markdown files under the docs folder. You can include them in your project documentation. Documentation is also embedded in Julia which can be used with a Julia specific documentation generator.
API Endpoints
| Class | Method |
|---|---|
| ExchangeItemsApi | getcomponentname<br/>GET /getcomponentname<br/> |
| ExchangeItemsApi | getinputitem_count<br/>GET /getinputitem_count<br/> |
| ExchangeItemsApi | getinputvar_names<br/>GET /getinputvar_names<br/> |
| ExchangeItemsApi | getoutputitem_count<br/>GET /getoutputitem_count<br/> |
| ExchangeItemsApi | getoutputvar_names<br/>GET /getoutputvar_names<br/> |
| GettersApi | get_value<br/>GET /get_value/{name}<br/> |
| GettersApi | getvalueat_indices<br/>POST /getvalueat_indices/{name}<br/> |
| GridInformationApi | getgridrank<br/>GET /getgridrank/{grid}<br/> |
| GridInformationApi | getgridsize<br/>GET /getgridsize/{grid}<br/> |
| GridInformationApi | getgridtype<br/>GET /getgridtype/{grid}<br/> |
| IRFApi | finalize<br/>DELETE /finalize<br/> |
| IRFApi | initialize<br/>POST /initialize<br/> |
| IRFApi | update<br/>POST /update<br/> |
| IRFApi | update_until<br/>POST /update_until<br/> |
| NURCApi | getgridx<br/>GET /getgridx/{grid}<br/> |
| NURCApi | getgridy<br/>GET /getgridy/{grid}<br/> |
| NURCApi | getgridz<br/>GET /getgridz/{grid}<br/> |
| SettersApi | set_value<br/>POST /set_value/{name}<br/> |
| SettersApi | setvalueat_indices<br/>POST /setvalueat_indices/{name}<br/> |
| TimeInformationApi | getcurrenttime<br/>GET /getcurrenttime<br/> |
| TimeInformationApi | getendtime<br/>GET /getendtime<br/> |
| TimeInformationApi | getstarttime<br/>GET /getstarttime<br/> |
| TimeInformationApi | gettimestep<br/>GET /gettimestep<br/> |
| TimeInformationApi | gettimeunits<br/>GET /gettimeunits<br/> |
| UniformRectilinearApi | getgridorigin<br/>GET /getgridorigin/{grid}<br/> |
| UniformRectilinearApi | getgridshape<br/>GET /getgridshape/{grid}<br/> |
| UniformRectilinearApi | getgridspacing<br/>GET /getgridspacing/{grid}<br/> |
| UnstructuredApi | getgridedge_count<br/>GET /getgridedge_count/{grid}<br/> |
| UnstructuredApi | getgridedge_nodes<br/>GET /getgridedge_nodes/{grid}<br/> |
| UnstructuredApi | getgridface_count<br/>GET /getgridface_count/{grid}<br/> |
| UnstructuredApi | getgridface_edges<br/>GET /getgridface_edges/{grid}<br/> |
| UnstructuredApi | getgridface_nodes<br/>GET /getgridface_nodes/{grid}<br/> |
| UnstructuredApi | getgridnode_count<br/>GET /getgridnode_count/{grid}<br/> |
| UnstructuredApi | getgridnodesperface<br/>GET /getgridnodesperface/{grid}<br/> |
| VariableInformationApi | getvargrid<br/>GET /getvargrid/{name}<br/> |
| VariableInformationApi | getvaritemsize<br/>GET /getvaritemsize/{name}<br/> |
| VariableInformationApi | getvarlocation<br/>GET /getvarlocation/{name}<br/> |
| VariableInformationApi | getvarnbytes<br/>GET /getvarnbytes/{name}<br/> |
| VariableInformationApi | getvartype<br/>GET /getvartype/{name}<br/> |
| VariableInformationApi | getvarunits<br/>GET /getvarunits/{name}<br/> |
Models
- GetComponentNameResponse
- GetGridTypeResponse
- GetTimeUnitsResponse
- GetVarLocationResponseLocation
- GetVarTypeResponse
- GetVarUnitsResponse
- InitializeRequest
- ProblemDetails
- SetValueAtIndicesRequest
<a id="authorization"></a>
Authorization
Endpoints do not require authorization.