id_interface
Name the interface block; helpful when there are multiple
Topics
Specification
Alias: None
Arguments: None
JSON argument key: None
Description
The optional id_interface keyword accepts a string that uniquely
identifies this interface block. A model can then use this interface
by specifying the same string in its interface_pointer
specification.
Default Behavior
If the id_interface specification is omitted, a particular
interface specification will be used by a model only if that model
does not include an interface_pointer and the interface block was
the last (or only) one parsed.
Usage Tips
It is a best practice to always use explicit interface IDs and pointers to avoid confusion.
If only one interface block exists, then
id_interfacecan be safely omitted from the interface block (andinterface_pointeromitted from the model specification(s)), since there is no ambiguity.
Examples
For example, a model specification including
model
interface_pointer = 'I1'
{
"model": [
{
"single": {
"interface_pointer": "I1"
}
}
]
}
will link to an interface with
interface
id_interface = 'I1'
{
"interface": [
{
"id_interface": "I1",
"analysis_drivers": {
"drivers": ["text_book"],
"interface_type": {
"fork": {}
}
}
}
]
}

