Description of a user model parameter loaded from the mbs file. More...

#include <mbs_infos_struct.h>

Public Attributes
char *	name
	Name of the parameter in the user model. More...

char *	description
	Description of the parameter in the user model. More...

int	type
	Type of the parameter between 1 and 7. More...

int	n_value
	Number of values in the parameter. More...

double *	value_list
	Vector (index starting at 1) containing the values retrieved from the multibody file. More...

char *	string_name
	Pointer containing the string name (if type is 8). NULL otherwise. More...

void *	val_ptr
	Pointer to the memory storing the value. More...

MbsInfoDData **	d_value
	d_data for the value. More...

int	is_symmmetric
	asymmetric = 0, symmetric master = 1, symmetric salve = 2. More...

char *	symmetric_parameter_name
	The name of the symmetric parameter. More...

char *	structure_name
	Name of the structure, filled if the parameter is a structure. More...

char *	structure_header
	Header name with path (relative or absolute) of header describing a structure parameter. More...

int	flag_PRJPATH
	Flag to indicate that the path to the data file start from the project path (stored as "PRJPATH" in mbs file). More...

char *	structure_lutfile
	File and path (relative or absolute) to the file containing the Look-up-Table dats. More...

Detailed Description

Description of a user model parameter loaded from the mbs file.

Member Data Documentation

◆ d_value

MbsInfoDData** d_value

d_data for the value.

◆ description

char* description

Description of the parameter in the user model.

◆ flag_PRJPATH

int flag_PRJPATH

Flag to indicate that the path to the data file start from the project path (stored as "PRJPATH" in mbs file).

◆ is_symmmetric

int is_symmmetric

asymmetric = 0, symmetric master = 1, symmetric salve = 2.

◆ n_value

int n_value

Number of values in the parameter.

◆ name

char* name

Name of the parameter in the user model.

◆ string_name

char* string_name

Pointer containing the string name (if type is 8). NULL otherwise.

◆ structure_header

char* structure_header

Header name with path (relative or absolute) of header describing a structure parameter.

NULL if the parameter is not a structure.

◆ structure_lutfile

char* structure_lutfile

File and path (relative or absolute) to the file containing the Look-up-Table dats.

NULL if the parameter is not a 1D or 2D Look-up-Table.

◆ structure_name

char* structure_name

Name of the structure, filled if the parameter is a structure.

NULL if the parameter is not a structure.

◆ symmetric_parameter_name

char* symmetric_parameter_name

The name of the symmetric parameter.

Filled if master, NULL if slave or non symmetric.

◆ type

int type

Type of the parameter between 1 and 7.

Valid values are: 1: scalar (one value); 2: vector (one or multiple values); 3: 1D Look-Up-Table; 4: 2D Look-Up-Table; 5: user state (one or multiple values); 6: structure; 7: integer (one value). 8: string (char *)

Each parameter may have zero, one or more values.

◆ val_ptr

void* val_ptr

Pointer to the memory storing the value.

The destination of the pointer differs according to parameter type:

Scalars and integers: the value of the parameter;
Vectors and states: the beginning of the dvec_1 of the value (value_list[0])
String: The adress of the pointer: &(MbsInfosParameter::string_name);
Other: NULL, as value_list is NULL.

This destination is updated by the function mbs_bind_user_model:

Scalars, vectors, states, integers and string : same behavior but pointing the memory in MbsData.user_model
1D LUT: points the MbsLut1D structure in MbsData.user_model.
2D LUT: points the MbsLut2D structure in MbsData.user_model.
structure: points to NULL as loading user model does not allocate them. After allocation by user, it should point to the structure.

◆ value_list

double* value_list

Vector (index starting at 1) containing the values retrieved from the multibody file.

Integers are interpreted as double during loading.

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

mbs_common/mbs_struct/mbs_infos_struct.h

Public Attributes