Robotran C Documentation
mbs_infos_helper.h
Go to the documentation of this file.
1 
13 #ifndef MBS_INFOS_HELPER_h
14 #define MBS_INFOS_HELPER_h
15 
16 #include "mbs_binder_public.h"
17 
18 MbsInfoUserIO *mbs_get_info_user_io(MbsInfos *mbs_infos, const char *name,
19  int verbose, int *err);
20 
36 MbsInfoUserModel *mbs_get_info_user_model(MbsInfos *mbs_infos, const char *name,
37  int verbose, int *err);
38 
55  int verbose, int *err);
56 
74 MbsInfoParameter *mbs_get_um_info_parameter(MbsInfos *mbs_infos, const char *um_name,
75  const char *param_name, int verbose, int *err);
76 
92 MbsInfoBody *mbs_get_info_body(MbsInfos *mbs_infos, const char *name,
93  int verbose, int *err);
94 
110 MbsInfoJoint *mbs_get_info_joint(MbsInfos *mbs_infos, const char *name,
111  int verbose, int *err);
112 
128 MbsInfoPoint *mbs_get_info_point(MbsInfoBody *mbs_body, const char *name,
129  int verbose, int *err);
130 
146 int mbs_info_get_body_id(MbsInfos *mbs_infos, const char *name, int verbose);
147 
163 int mbs_info_get_joint_id(MbsInfos *mbs_infos, const char *name, int verbose);
164 
180 int mbs_info_get_point_id(MbsInfos *mbs_infos, const char *body_name,
181  const char *point_name, int verbose);
182 #endif
mbs_info_get_point_id
int mbs_info_get_point_id(MbsInfos *mbs_infos, const char *body_name, const char *point_name, int verbose)
Retrieve a point indice from its names (body and point name).
Definition: mbs_infos_helper.c:648
MBS_INFO_FAILURE
#define MBS_INFO_FAILURE
Definition: mbs_define.h:31
mbs_msg
void mbs_msg(const char *msg,...)
Send a message.
Definition: mbs_message.c:87
mbs_get_info_joint
MbsInfoJoint * mbs_get_info_joint(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve the joint matching the given name.
Definition: mbs_infos_helper.c:328
MbsInfoParameter::name
char * name
Name of the parameter in the user model.
Definition: mbs_binder_public.h:285
useful_functions.h
MbsInfos::base
MbsInfoBase * base
Definition: mbs_binder_public.h:430
MbsInfoPoint::body_name
char * body_name
Name of the body holding the point.
Definition: mbs_binder_public.h:107
mbs_get_info_body
MbsInfoBody * mbs_get_info_body(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve the body matching the given name.
Definition: mbs_infos_helper.c:261
MbsInfoUserIOs::user_IO_list
MbsInfoUserIO ** user_IO_list
The detail of each user IO in the system.
Definition: mbs_binder_public.h:397
mbs_get_info_user_io
MbsInfoUserIO * mbs_get_info_user_io(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Definition: mbs_infos_helper.c:24
MbsInfoJoint
This structure contains all informations about a joint.
Definition: mbs_binder_public.h:133
mbs_info_get_body_id
int mbs_info_get_body_id(MbsInfos *mbs_infos, const char *name, int verbose)
Retrieve a body indice from its name.
Definition: mbs_infos_helper.c:539
mbs_get_um_info_parameter
MbsInfoParameter * mbs_get_um_info_parameter(MbsInfos *mbs_infos, const char *um_name, const char *param_name, int verbose, int *err)
Retrieve a parameter in a user model matching the names in the User Models list of MbsInfos.
Definition: mbs_infos_helper.c:252
mbs_define.h
mbs_strcmp
int mbs_strcmp(const char *__s1, const char *__s2)
Compare two char with strcmp.
Definition: useful_functions.c:388
mbs_get_info_joint
MbsInfoJoint * mbs_get_info_joint(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve the joint matching the given name.
Definition: mbs_infos_helper.c:328
MSG_ERR
#define MSG_ERR
Definition: mbs_infos_helper.c:21
mbs_get_info_point
MbsInfoPoint * mbs_get_info_point(MbsInfoBody *mbs_body, const char *name, int verbose, int *err)
Retrieve the point matching the given name on a body.
Definition: mbs_infos_helper.c:395
mbs_get_um_info_parameter
MbsInfoParameter * mbs_get_um_info_parameter(MbsInfos *mbs_infos, const char *um_name, const char *param_name, int verbose, int *err)
Retrieve a parameter in a user model matching the names in the User Models list of MbsInfos.
Definition: mbs_infos_helper.c:252
MbsInfoBodytree::n_joint
int n_joint
Definition: mbs_binder_public.h:185
mbs_infos_helper.h
MbsInfos
Definition: mbs_binder_public.h:428
MbsInfoPoint::name
char * name
Name of the point.
Definition: mbs_binder_public.h:106
mbs_get_info_user_io
MbsInfoUserIO * mbs_get_info_user_io(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Definition: mbs_infos_helper.c:24
mbs_info_get_body_id
int mbs_info_get_body_id(MbsInfos *mbs_infos, const char *name, int verbose)
Retrieve a body indice from its name.
Definition: mbs_infos_helper.c:539
MbsInfoJoint::name
char * name
Name of the joint.
Definition: mbs_binder_public.h:135
mbs_get_info_user_model
MbsInfoUserModel * mbs_get_info_user_model(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve a user model matching a name in the User Models list of MbsInfos.
Definition: mbs_infos_helper.c:118
MbsInfoUserModel
Definition: mbs_binder_public.h:350
MbsInfoUserModel::parameter_list
MbsInfoParameter ** parameter_list
Definition: mbs_binder_public.h:355
mbs_binder_public.h
This header defines MbsInfos (and its substructures) as well as the loading/deleting functions.
MbsInfoBody::point_list
MbsInfoPoint ** point_list
Array of pointers to the MDS_point_strct describing each point of current body.
Definition: mbs_binder_public.h:176
mbs_get_info_user_model
MbsInfoUserModel * mbs_get_info_user_model(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve a user model matching a name in the User Models list of MbsInfos.
Definition: mbs_infos_helper.c:118
MbsInfos::user_IOs
MbsInfoUserIOs * user_IOs
Definition: mbs_binder_public.h:435
MbsInfoParameter
Description of a user model parameter loaded from the mbs file.
Definition: mbs_binder_public.h:283
mbs_msg_v
void mbs_msg_v(int v_opt, int v_lvl, const char *msg,...)
Send a message only of the message level is lower than the verbosity option.
Definition: mbs_message.c:143
MbsInfoUserModel::n_parameter
int n_parameter
Definition: mbs_binder_public.h:354
MbsInfoUserIO::name
char * name
Name of the user IO.
Definition: mbs_binder_public.h:372
MbsInfoUserIOs::n_user_IO
int n_user_IO
Number of user IO in the system.
Definition: mbs_binder_public.h:391
MBS_VERBOSE_ERROR
#define MBS_VERBOSE_ERROR
Definition: mbs_define.h:44
mbs_get_info_body
MbsInfoBody * mbs_get_info_body(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve the body matching the given name.
Definition: mbs_infos_helper.c:261
MbsInfoBodytree::body_list
MbsInfoBody ** body_list
Definition: mbs_binder_public.h:183
MbsInfoBody::n_point
int n_point
Number of point defined on the body.
Definition: mbs_binder_public.h:175
MbsInfoBody
This structure contains all informations about a body.
Definition: mbs_binder_public.h:161
mbs_message.h
MbsInfoUserIO
Definition: mbs_binder_public.h:369
MbsInfoUserModels::n_user_model
int n_user_model
Definition: mbs_binder_public.h:361
mbs_get_info_parameter
MbsInfoParameter * mbs_get_info_parameter(MbsInfoUserModel *um, const char *name, int verbose, int *err)
Retrieve a user model parameter matching a name in a provided User Model.
Definition: mbs_infos_helper.c:186
MbsInfos::point_list
MbsInfoPoint ** point_list
List of all anchors point in the model
Definition: mbs_binder_public.h:448
mbs_info_get_joint_id
int mbs_info_get_joint_id(MbsInfos *mbs_infos, const char *name, int verbose)
Retrieve a joint indice from its name.
Definition: mbs_infos_helper.c:469
MbsInfoPoint
This structure handle everything that a point on a MBS structure can handle (sensor,...
Definition: mbs_binder_public.h:104
MbsInfos::n_joint
int n_joint
Number of joints in the model
Definition: mbs_binder_public.h:475
MBS_VERBOSE_WARNING
#define MBS_VERBOSE_WARNING
Definition: mbs_define.h:45
MbsInfos::bodytree
MbsInfoBodytree * bodytree
Definition: mbs_binder_public.h:431
mbs_info_get_point_id
int mbs_info_get_point_id(MbsInfos *mbs_infos, const char *body_name, const char *point_name, int verbose)
Retrieve a point indice from its names (body and point name).
Definition: mbs_infos_helper.c:648
MbsInfoUserModels::user_model_list
MbsInfoUserModel ** user_model_list
Definition: mbs_binder_public.h:362
MbsInfoBodytree::n_body
int n_body
Definition: mbs_binder_public.h:182
MbsInfos::user_models
MbsInfoUserModels * user_models
Definition: mbs_binder_public.h:434
MbsInfoBase::base_body_name
char * base_body_name
baseBodyName as defined in the base body in mbs/json file
Definition: mbs_binder_public.h:127
MbsInfoUserModel::name
char * name
Definition: mbs_binder_public.h:352
MbsInfoBody::name
char * name
Name of the body.
Definition: mbs_binder_public.h:163
MbsInfoBodytree::joint_list
MbsInfoJoint ** joint_list
Definition: mbs_binder_public.h:186
mbs_get_info_parameter
MbsInfoParameter * mbs_get_info_parameter(MbsInfoUserModel *um, const char *name, int verbose, int *err)
Retrieve a user model parameter matching a name in a provided User Model.
Definition: mbs_infos_helper.c:186
MbsInfos::n_point
int n_point
Number of anchor points.
Definition: mbs_binder_public.h:446
MSG_TAB
#define MSG_TAB
Definition: mbs_infos_helper.c:22
mbs_info_get_joint_id
int mbs_info_get_joint_id(MbsInfos *mbs_infos, const char *name, int verbose)
Retrieve a joint indice from its name.
Definition: mbs_infos_helper.c:469
mbs_stricmp
int mbs_stricmp(const char *__s1, const char *__s2)
Compare two char with _stricmp (convert strings to lower case, ignoring case sensitive).
Definition: useful_functions.c:404
MBS_VERBOSE_ALL
#define MBS_VERBOSE_ALL
Definition: mbs_define.h:46
MbsInfos::all_joint_list
MbsInfoJoint ** all_joint_list
Ordered list of all joints in the model
Definition: mbs_binder_public.h:473
MbsInfoBody::n_joint
int n_joint
Number of joints leaving the body.
Definition: mbs_binder_public.h:168
mbs_get_info_point
MbsInfoPoint * mbs_get_info_point(MbsInfoBody *mbs_body, const char *name, int verbose, int *err)
Retrieve the point matching the given name on a body.
Definition: mbs_infos_helper.c:395