Skip to content

Commit 91791de

Browse files
committed
use map-bmi-function directive for time functions
1 parent e5f9458 commit 91791de

File tree

1 file changed

+60
-30
lines changed

1 file changed

+60
-30
lines changed

docs/source/bmi.time_funcs.md

Lines changed: 60 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,26 @@ Model time is always expressed as a floating point value.
1414

1515
:::{tab-item} SIDL
1616
:sync: sidl
17-
```java
18-
int get_current_time(out double time);
17+
```{map-bmi-function} get_current_time
18+
:language: sidl
1919
```
2020
:::
2121
:::{tab-item} Python
2222
:sync: python
23-
```python
24-
def get_current_time(self) -> float:
23+
```{map-bmi-function} get_current_time
24+
:language: python
2525
```
2626
:::
2727
:::{tab-item} c
2828
:sync: c
29-
```c
30-
int get_current_time(void *self, double *time);
29+
```{map-bmi-function} get_current_time
30+
:language: c
31+
```
32+
:::
33+
:::{tab-item} c++
34+
:sync: c++
35+
```{map-bmi-function} get_current_time
36+
:language: c++
3137
```
3238
:::
3339
::::
@@ -50,20 +56,26 @@ The current model time.
5056

5157
:::{tab-item} SIDL
5258
:sync: sidl
53-
```java
54-
int get_start_time(out double time);
59+
```{map-bmi-function} get_start_time
60+
:language: sidl
5561
```
5662
:::
5763
:::{tab-item} Python
5864
:sync: python
59-
```python
60-
def get_start_time(self) -> float:
65+
```{map-bmi-function} get_start_time
66+
:language: python
6167
```
6268
:::
6369
:::{tab-item} c
6470
:sync: c
65-
```c
66-
int get_start_time(void *self, double *time);
71+
```{map-bmi-function} get_start_time
72+
:language: c
73+
```
74+
:::
75+
:::{tab-item} c++
76+
:sync: c++
77+
```{map-bmi-function} get_start_time
78+
:language: c++
6779
```
6880
:::
6981
::::
@@ -87,20 +99,26 @@ The start time of the model.
8799

88100
:::{tab-item} SIDL
89101
:sync: sidl
90-
```java
91-
int get_end_time(out double time);
102+
```{map-bmi-function} get_end_time
103+
:language: sidl
92104
```
93105
:::
94106
:::{tab-item} Python
95107
:sync: python
96-
``` python
97-
def get_end_time(self) -> float:
108+
```{map-bmi-function} get_end_time
109+
:language: python
98110
```
99111
:::
100112
:::{tab-item} c
101113
:sync: c
102-
```c
103-
int get_end_time(void *self, double *time);
114+
```{map-bmi-function} get_end_time
115+
:language: c
116+
```
117+
:::
118+
:::{tab-item} c++
119+
:sync: c++
120+
```{map-bmi-function} get_end_time
121+
:language: c++
104122
```
105123
:::
106124
::::
@@ -126,21 +144,27 @@ The end time of the model.
126144

127145
:::{tab-item} SIDL
128146
:sync: sidl
129-
```java
130-
int get_time_units(out string units);
147+
```{map-bmi-function} get_time_units
148+
:language: sidl
131149
```
132150
:::
133151

134152
:::{tab-item} Python
135153
:sync: python
136-
```python
137-
def get_time_units(self) -> str:
154+
```{map-bmi-function} get_time_units
155+
:language: python
138156
```
139157
:::
140158
:::{tab-item} c
141159
:sync: c
142-
```c
143-
int get_time_units(void *self, char *units);
160+
```{map-bmi-function} get_time_units
161+
:language: c
162+
```
163+
:::
164+
:::{tab-item} c++
165+
:sync: c++
166+
```{map-bmi-function} get_time_units
167+
:language: c++
144168
```
145169
:::
146170
::::
@@ -172,20 +196,26 @@ It's recommended to use [time unit conventions] from Unidata's
172196

173197
:::{tab-item} SIDL
174198
:sync: sidl
175-
```java
176-
int get_time_step(out double time_step);
199+
```{map-bmi-function} get_time_step
200+
:language: sidl
177201
```
178202
:::
179203
:::{tab-item} Python
180204
:sync: python
181-
```python
182-
def get_time_step(self) -> float:
205+
```{map-bmi-function} get_time_step
206+
:language: python
183207
```
184208
:::
185209
:::{tab-item} c
186210
:sync: c
187-
```c
188-
int get_time_step(void *self, double *time_step);
211+
```{map-bmi-function} get_time_step
212+
:language: c
213+
```
214+
:::
215+
:::{tab-item} c++
216+
:sync: c++
217+
```{map-bmi-function} get_time_step
218+
:language: c++
189219
```
190220
:::
191221
::::

0 commit comments

Comments
 (0)