Robotran C Documentation
Classes | Functions
mbs_user_interface.h File Reference
#include <stdio.h>

Go to the source code of this file.

Classes

struct  UserIoInfo
 Contains information about UserIO. More...
 

Functions

UserModelmbs_new_user_model ()
 
void mbs_delete_user_model (UserModel *ums)
 
void mbs_print_user_model (UserModel *ums)
 
void mbs_get_user_model_size (int *n_user_model)
 
void mbs_get_user_model_list (int *user_model_list)
 
void mbs_save_um (FILE *stream, UserModel *ums)
 
UserIOmbs_new_user_IO (UserIoInfo *ioInfo)
 Initialize the UserIO structure and bind the ioInfo pointer to the allocated memory (project specific -> see definition in project/userfctR/user_IO.c) More...
 
void mbs_delete_user_IO (UserIO *uvs)
 Free the memory associated to the given UserIO structure. More...
 
void mbs_print_user_IO (UserIO *uvs)
 Print the current UserIO values. More...
 
void mbs_save_user_IO (FILE *stream, UserIO *uvs)
 Save the current UserIO values into a file stream. More...
 
void mbs_get_user_IO_size (int *n_in, int *n_out, int *n_user_IO)
 Get the size of the UserIO structure inside the user_IO.c file. More...
 
void mbs_set_user_IO (UserIoInfo *ioInfo, double val)
 Set all the user_IO to the given value (generic code) More...
 

Function Documentation

◆ mbs_delete_user_IO()

void mbs_delete_user_IO ( UserIO uvs)

Free the memory associated to the given UserIO structure.

(project specific -> see definition in project/userfctR/user_IO.c)

◆ mbs_delete_user_model()

void mbs_delete_user_model ( UserModel ums)

◆ mbs_get_user_IO_size()

void mbs_get_user_IO_size ( int *  n_in,
int *  n_out,
int *  n_user_IO 
)

Get the size of the UserIO structure inside the user_IO.c file.

pointors are the ouputs : n_in = number of user input port n_out = number of user output port n_user_IO = number of user IO ports

(project specific -> see definition in project/userfctR/user_IO.c)

◆ mbs_get_user_model_list()

void mbs_get_user_model_list ( int *  user_model_list)

◆ mbs_get_user_model_size()

void mbs_get_user_model_size ( int *  n_user_model)

◆ mbs_new_user_IO()

UserIO* mbs_new_user_IO ( UserIoInfo ioInfo)

Initialize the UserIO structure and bind the ioInfo pointer to the allocated memory (project specific -> see definition in project/userfctR/user_IO.c)

◆ mbs_new_user_model()

UserModel* mbs_new_user_model ( )

◆ mbs_print_user_IO()

void mbs_print_user_IO ( UserIO uvs)

Print the current UserIO values.

Parameters
[in]uvsPointer to the UserIO structure.

◆ mbs_print_user_model()

void mbs_print_user_model ( UserModel ums)

◆ mbs_save_um()

void mbs_save_um ( FILE *  stream,
UserModel ums 
)

◆ mbs_save_user_IO()

void mbs_save_user_IO ( FILE *  stream,
UserIO uvs 
)

Save the current UserIO values into a file stream.

Parameters
[in]uvsPointer to the UserIO structure.
[in]streamPointer to the file stream.

◆ mbs_set_user_IO()

void mbs_set_user_IO ( UserIoInfo ioInfo,
double  val 
)

Set all the user_IO to the given value (generic code)

Set all the user_IO to the given value (generic code)