Robotran C Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 
38 MbsInfoUserIO *mbs_get_info_user_io(MbsInfos *mbs_infos, const char *name,
39  int verbose, int *err);
40 
56 MbsInfoUserModel *mbs_get_info_user_model(MbsInfos *mbs_infos, const char *name,
57  int verbose, int *err);
58 
75  int verbose, int *err);
76 
94 MbsInfoParameter *mbs_get_um_info_parameter(MbsInfos *mbs_infos, const char *um_name,
95  const char *param_name, int verbose, int *err);
96 
112 MbsInfoBody *mbs_get_info_body(MbsInfos *mbs_infos, const char *name,
113  int verbose, int *err);
114 
130 MbsInfoJoint *mbs_get_info_joint(MbsInfos *mbs_infos, const char *name,
131  int verbose, int *err);
132 
148 MbsInfoPoint *mbs_get_info_point(MbsInfoBody *mbs_body, const char *name,
149  int verbose, int *err);
150 
166 int mbs_info_get_body_id(MbsInfos *mbs_infos, const char *name, int verbose);
167 
183 int mbs_info_get_joint_id(MbsInfos *mbs_infos, const char *name, int verbose);
184 
200 int mbs_info_get_point_id(MbsInfos *mbs_infos, const char *body_name,
201  const char *point_name, int verbose);
202 #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:650
MBS_INFO_FAILURE
#define MBS_INFO_FAILURE
Definition: mbs_define.h:32
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_infos_struct.h:282
useful_functions.h
MbsInfos::base
MbsInfoBase * base
Definition: mbs_infos_struct.h:427
MbsInfoPoint::body_name
char * body_name
Name of the body holding the point.
Definition: mbs_infos_struct.h:104
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_infos_struct.h:394
mbs_get_info_user_io
MbsInfoUserIO * mbs_get_info_user_io(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve a user IO matching a name in the User IOs list of MbsInfos.
Definition: mbs_infos_helper.c:24
MbsInfoJoint
This structure contains all informations about a joint.
Definition: mbs_infos_struct.h:130
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:541
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:568
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_infos_struct.h:182
mbs_infos_helper.h
MbsInfos
Definition: mbs_infos_struct.h:425
MbsInfoPoint::name
char * name
Name of the point.
Definition: mbs_infos_struct.h:103
mbs_get_info_user_io
MbsInfoUserIO * mbs_get_info_user_io(MbsInfos *mbs_infos, const char *name, int verbose, int *err)
Retrieve a user IO matching a name in the User IOs list of MbsInfos.
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:541
MbsInfoJoint::name
char * name
Name of the joint.
Definition: mbs_infos_struct.h:132
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_infos_struct.h:347
MbsInfoUserModel::parameter_list
MbsInfoParameter ** parameter_list
Definition: mbs_infos_struct.h:352
mbs_binder_public.h
This header defines MbsInfos 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_infos_struct.h:173
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_infos_struct.h:432
MbsInfoParameter
Description of a user model parameter loaded from the mbs file.
Definition: mbs_infos_struct.h:280
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_infos_struct.h:351
MbsInfoUserIO::name
char * name
Name of the user IO.
Definition: mbs_infos_struct.h:369
MbsInfoUserIOs::n_user_IO
int n_user_IO
Number of user IO in the system.
Definition: mbs_infos_struct.h:388
MBS_VERBOSE_ERROR
#define MBS_VERBOSE_ERROR
Definition: mbs_define.h:45
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_infos_struct.h:180
MbsInfoBody::n_point
int n_point
Number of point defined on the body.
Definition: mbs_infos_struct.h:172
MbsInfoBody
This structure contains all informations about a body.
Definition: mbs_infos_struct.h:158
mbs_message.h
MbsInfoUserIO
Definition: mbs_infos_struct.h:366
MbsInfoUserModels::n_user_model
int n_user_model
Definition: mbs_infos_struct.h:358
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_infos_struct.h:445
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_infos_struct.h:101
MbsInfos::n_joint
int n_joint
Number of joints in the model
Definition: mbs_infos_struct.h:472
MBS_VERBOSE_WARNING
#define MBS_VERBOSE_WARNING
Definition: mbs_define.h:46
MbsInfos::bodytree
MbsInfoBodytree * bodytree
Definition: mbs_infos_struct.h:428
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:650
MbsInfoUserModels::user_model_list
MbsInfoUserModel ** user_model_list
Definition: mbs_infos_struct.h:359
MbsInfoBodytree::n_body
int n_body
Definition: mbs_infos_struct.h:179
MBS_INFO_SUCCESS
#define MBS_INFO_SUCCESS
Definition: mbs_define.h:30
MbsInfos::user_models
MbsInfoUserModels * user_models
Definition: mbs_infos_struct.h:431
MbsInfoBase::base_body_name
char * base_body_name
baseBodyName as defined in the base body in mbs/json file
Definition: mbs_infos_struct.h:124
MbsInfoUserModel::name
char * name
Definition: mbs_infos_struct.h:349
MbsInfoBody::name
char * name
Name of the body.
Definition: mbs_infos_struct.h:160
MbsInfoBodytree::joint_list
MbsInfoJoint ** joint_list
Definition: mbs_infos_struct.h:183
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_infos_struct.h:443
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:584
MBS_VERBOSE_ALL
#define MBS_VERBOSE_ALL
Definition: mbs_define.h:47
MbsInfos::all_joint_list
MbsInfoJoint ** all_joint_list
Ordered list of all joints in the model
Definition: mbs_infos_struct.h:470
MbsInfoBody::n_joint
int n_joint
Number of joints leaving the body.
Definition: mbs_infos_struct.h:165
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