VariableInformationApi

All URIs are relative to http://localhost:50051

getvargrid

getvargrid(api::VariableInformationApi, name::String; _mediaType=nothing) -> Int64, OpenAPI.Clients.ApiResponse <br/> getvargrid(api::VariableInformationApi, response_stream::Channel, name::String; _mediaType=nothing) -> Channel{ Int64 }, OpenAPI.Clients.ApiResponse

Each input and output variable is defined on a grid. This function returns the grid identifier for a given variable.

Required Parameters

Return type

Int64

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getvaritemsize

getvaritemsize(api::VariableInformationApi, name::String; _mediaType=nothing) -> Int64, OpenAPI.Clients.ApiResponse <br/> getvaritemsize(api::VariableInformationApi, response_stream::Channel, name::String; _mediaType=nothing) -> Channel{ Int64 }, OpenAPI.Clients.ApiResponse

Provides the size, in bytes, of a single element of the variable.

Required Parameters

Return type

Int64

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getvarlocation

getvarlocation(api::VariableInformationApi, name::String; _mediaType=nothing) -> GetVarLocationResponseLocation, OpenAPI.Clients.ApiResponse <br/> getvarlocation(api::VariableInformationApi, response_stream::Channel, name::String; _mediaType=nothing) -> Channel{ GetVarLocationResponseLocation }, OpenAPI.Clients.ApiResponse

Indicates on what grid element the variable is defined.

Required Parameters

Return type

GetVarLocationResponseLocation

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getvarnbytes

getvarnbytes(api::VariableInformationApi, name::String; _mediaType=nothing) -> Int64, OpenAPI.Clients.ApiResponse <br/> getvarnbytes(api::VariableInformationApi, response_stream::Channel, name::String; _mediaType=nothing) -> Channel{ Int64 }, OpenAPI.Clients.ApiResponse

Provides the total amount of memory used to store a variable; i.e., the number of items multiplied by the size of each item.

Required Parameters

Return type

Int64

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getvartype

getvartype(api::VariableInformationApi, name::String; _mediaType=nothing) -> GetVarTypeResponse, OpenAPI.Clients.ApiResponse <br/> getvartype(api::VariableInformationApi, response_stream::Channel, name::String; _mediaType=nothing) -> Channel{ GetVarTypeResponse }, OpenAPI.Clients.ApiResponse

Provides the data type of the variable.

Required Parameters

Return type

GetVarTypeResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getvarunits

getvarunits(api::VariableInformationApi, name::String; _mediaType=nothing) -> GetVarUnitsResponse, OpenAPI.Clients.ApiResponse <br/> getvarunits(api::VariableInformationApi, response_stream::Channel, name::String; _mediaType=nothing) -> Channel{ GetVarUnitsResponse }, OpenAPI.Clients.ApiResponse

Get the units of the given variable.

Required Parameters

Return type

GetVarUnitsResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]