Model information functions¶
These functions supply the model name and the model’s exchange items – the variables that the model can use from and provide to other models that have a BMI.
get_component_name¶
int get_component_name(out string name);
def get_component_name(self) -> str:
int get_component_name(void *self, char *name);
This function supplies the name of the model component as a string. There are no restrictions on the name, but it should be unique to prevent conflicts with other components.
Implementation notes
In C and Fortran, the name argument is a a character array, and an integer status code indicating success (zero) or failure (nonzero) is returned.
In C++, Java, and Python, this argument is omitted, and a string – a basic type in these languages – is returned from the function.
get_input_item_count¶
int get_input_item_count(out int count);
def get_input_item_count(self) -> int:
int get_input_item_count(void *self, int *count);
The number of variables the model can use from other models implementing a BMI. Also the number of variables that can be set with set_value.
Implementation notes
In C++, Java, and Python, the argument is omitted and the count is returned from the function.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.
get_output_item_count¶
int get_output_item_count(out int count);
def get_output_item_count(self) -> int:
int get_output_item_count(void *self, int *count);
The number of variables the model can provide other models implementing a BMI. Also the number of variables that can be retrieved with get_value.
Implementation notes
In C++, Java, and Python, the argument is omitted and the count is returned from the function.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.
get_input_var_names¶
int get_input_var_names(out array<string, 1> names);
def get_input_var_names(self) -> tuple[str, ...]:
int get_input_var_names(void *self, char **names);
Gets an array of names for the variables the model can use from other models implementing a BMI. The length of the array is given by get_input_item_count. The names are preferably in the form of CSDMS Standard Names. Standard Names enable a modeling framework to determine whether an input variable in one model is equivalent to, or compatible with, an output variable in another model. This allows the framework to automatically connect components. Standard Names do not have to be used within the model.
Implementation notes
In C and Fortran, the names are passed back as an array of character pointers (because the variable names could have differing lengths), and an integer status code indicating success (zero) or failure (nonzero) is returned.
In C++, the argument is omitted and the names are returned from the function in a vector, a standard container in the language.
In Java, the argument is omitted and the names are returned from the function in a string array, a standard container in the language.
In Python, the argument is omitted and the names are returned from the function in a tuple, a standard container in the language.
A model might have no input variables.
get_output_var_names¶
int get_output_var_names(out array<string, 1> names);
def get_output_var_names(self) -> tuple[str, ...]:
int get_output_var_names(void *self, char **names);
Gets an array of names for the variables the model can provide to other models implementing a BMI. The length of the array is given by get_output_item_count. The names are preferably in the form of CSDMS Standard Names. Standard Names enable a modeling framework to determine whether an input variable in one model is equivalent to, or compatible with, an output variable in another model. This allows the framework to automatically connect components. Standard Names do not have to be used within the model.
Implementation notes
In C and Fortran, the names are passed back as an array of character pointers (because the variable names could have differing lengths), and an integer status code indicating success (zero) or failure (nonzero) is returned.
In C++, the argument is omitted and the names are returned from the function in a vector, a standard container in the language.
In Java, the argument is omitted and the names are returned from the function in a string array, a standard container in the language.
In Python, the argument is omitted and the names are returned from the function in a tuple, a standard container in the language.
A model may have no output variables.