ARTS  2.3.1285(git:92a29ea9-dirty)
MethodStruct Struct Reference

Representation of workspace methods. More...

#include <arts_api.h>

Public Attributes

long id
 The WSMs index in md_data. More...
 
const char * name
 Method name. More...
 
const char * description
 Method description. More...
 
unsigned long n_out
 Number of non-generic output variables. More...
 
const long * out
 Output variables. More...
 
unsigned long n_g_out
 Number of generic output variables. More...
 
const long * g_out_types
 Generic output types. More...
 
unsigned long n_in
 Number of non-generic input variables. More...
 
const long * in
 Input variables. More...
 
unsigned long n_g_in
 Number of generic input variables. More...
 
const long * g_in_types
 Generic input types. More...
 

Detailed Description

Representation of workspace methods.

This struct is used to return descriptions of a workspace method.

Definition at line 97 of file arts_api.h.

Member Data Documentation

◆ description

const char* MethodStruct::description

Method description.

Pointer to the c string containing the description of the workspace method as defined in methods.cc

Definition at line 111 of file arts_api.h.

◆ g_in_types

const long* MethodStruct::g_in_types

Generic input types.

Pointer to the ArrayOfIndex holding the type indices of the generic input variables.

Definition at line 153 of file arts_api.h.

◆ g_out_types

const long* MethodStruct::g_out_types

Generic output types.

Pointer to the ArrayOfIndex holding the type indices of the generic output variables.

Definition at line 132 of file arts_api.h.

◆ id

long MethodStruct::id

The WSMs index in md_data.

Definition at line 99 of file arts_api.h.

◆ in

const long* MethodStruct::in

Input variables.

Pointer to ArrayOfIndex holding the indices of the input WSVs.

Definition at line 142 of file arts_api.h.

◆ n_g_in

unsigned long MethodStruct::n_g_in

Number of generic input variables.

Holds the length of the array pointed to by g_in_types.

Definition at line 147 of file arts_api.h.

◆ n_g_out

unsigned long MethodStruct::n_g_out

Number of generic output variables.

I.e. length of array pointed to be out.

Definition at line 126 of file arts_api.h.

◆ n_in

unsigned long MethodStruct::n_in

Number of non-generic input variables.

I.e. length of array pointed to by in.

Definition at line 137 of file arts_api.h.

◆ n_out

unsigned long MethodStruct::n_out

Number of non-generic output variables.

I.e. length of array pointed to by out.

Definition at line 116 of file arts_api.h.

◆ name

const char* MethodStruct::name

Method name.

Pointer to the c string containing the name of the method as defined in methods.cc

Definition at line 105 of file arts_api.h.

◆ out

const long* MethodStruct::out

Output variables.

Pointer to ArrayOfIndex holding the indices of the output WSVs.

Definition at line 121 of file arts_api.h.


The documentation for this struct was generated from the following file: