![]() |
![]() |
![]() |
V_Sim API - Reference Manual | ![]() |
---|---|---|---|---|
enum toolConfigFileError; gboolean configFileClamp_float (float *variable, float value, float min, float max); gboolean configFileRead_elementFromTokens (gchar **tokens, int *position, VisuElement **values, guint size, int lineId, GError **error); gboolean configFileRead_float (gchar *line, int position, float *values, guint size, GError **error); gboolean configFileRead_floatWithElement (gchar *line, int position, float *values, guint size, VisuElement **ele, GError **error); gboolean configFileRead_floatFromTokens (gchar **tokens, int *position, float *values, guint size, int lineId, GError **error); gboolean configFileRead_integer (gchar *line, int position, int *values, guint size, GError **error); gboolean configFileRead_integerFromTokens (gchar **tokens, int *position, int *values, guint size, int lineId, GError **error); gboolean configFileRead_string (gchar *line, int position, gchar ***values, guint size, gboolean join, GError **error); gboolean configFileRead_stringFromTokens (gchar **tokens, int *position, gchar ***values, guint size, int lineId, GError **error); gboolean configFileRead_stringWithElement (gchar *line, int position, gchar ***values, guint size, VisuElement **ele, GError **error); gboolean configFileRead_boolean (gchar *line, int position, gboolean *values, guint size, GError **error); gboolean configFileRead_booleanWithElement (gchar *line, int position, gboolean *values, guint size, VisuElement **ele, GError **error); gboolean configFileRead_booleanFromTokens (gchar **tokens, int *position, gboolean *values, guint size, int lineId, GError **error);
These methods give generic tools to read common data in the
configuration files, such as arrays of float values or one
VisuElement... It also defines a enumeration of detailed errors
(see toolConfigFileError) when reading a file. All read elements
are either from tokens (given g_strsplit()
) or strings.
typedef enum { CONFIG_FILE_ERROR_EMPTY_LINE, CONFIG_FILE_ERROR_BAD_ELEMENT_NAME, CONFIG_FILE_ERROR_MAX_ELEMENT, CONFIG_FILE_ERROR_CREATED_ELEMENT, CONFIG_FILE_ERROR_VALUE, CONFIG_FILE_ERROR_READ, CONFIG_FILE_ERROR_MISSING, CONFIG_FILE_ERROR_TAG, CONFIG_FILE_ERROR_MARKUP } toolConfigFileError;
Possible errors when parsing a config file.
error when reading the file, found an empty line, where something should have been. | |
error when reading a VisuElement name. | |
error because too much VisuElement have been created. | |
error when creating a new VisuElement. | |
error of file format, values read are out of bounds. | |
error of file format (can't read variables...). | |
error of file format (missing variables...). | |
error dealing with a tag. | |
error dealing with a markup (unkown one...). |
gboolean configFileClamp_float (float *variable, float value, float min, float max);
It puts value in a variable if value is in min and max or put min or max in if not. It return true if value is out of bounds. Min and max are inclusive values. If there is no max bounds then put max at a lower value than min and if there is no min bound, put min at a higher value than max.
|
a pointer to a storage for the value ; |
|
the value to put in the storage ; |
|
a lower bound ; |
|
a upper bound. |
Returns : |
TRUE if the value is out of bounds. |
gboolean configFileRead_elementFromTokens (gchar **tokens, int *position, VisuElement **values, guint size, int lineId, GError **error);
Read size
VisuElement from tokens
, store them in values
and returns
the new head in tokens
.
|
array of tokens resulting from a call to g_strsplit() with " " as separator ;
|
|
IN, the position of the beginning in tokens ; OUT, one token
after the last read ;
|
|
allocated area to store read values ; |
|
the number of VisuElement to be read ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_float (gchar *line, int position, float *values, guint size, GError **error);
Read size
floating point values from line
and store them in values
.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
allocated area to store read values ; |
|
the number of floating point values to be read ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_floatWithElement (gchar *line, int position, float *values, guint size, VisuElement **ele, GError **error);
Same as configFileRead_float()
but begins by reading an element
at the begining of the line.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
allocated area to store read values ; |
|
the number of floating point values to be read ; |
|
a pointer to a VisuElement location ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_floatFromTokens (gchar **tokens, int *position, float *values, guint size, int lineId, GError **error);
Read size
floating point values from tokens
, store them in values
and returns
the new head in tokens
.
|
array of tokens resulting from a call to g_strsplit() with " " as separator ;
|
|
IN, the position of the beginning in tokens ; OUT, one token
after the last read ;
|
|
allocated area to store read values ; |
|
the number of floating point values to be read ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_integer (gchar *line, int position, int *values, guint size, GError **error);
Read size
integers from line
and store them in values
.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
allocated area to store read values ; |
|
the number of floating point values to be read ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_integerFromTokens (gchar **tokens, int *position, int *values, guint size, int lineId, GError **error);
Read size
integer values from tokens
, store them in values
and returns
the new head in tokens
.
|
array of tokens resulting from a call to g_strsplit() with " " as separator ;
|
|
IN, the position of the beginning in tokens ; OUT, one token
after the last read ;
|
|
allocated area to store read values ; |
|
the number of floating point values to be read ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_string (gchar *line, int position, gchar ***values, guint size, gboolean join, GError **error);
Read size
strings from line
and values
points on them. If more
strings than size
are available, an error is raised ; except if
join
is TRUE. In that case, the method return size
tokens,
joining all remaining ones.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to point on a gchar** ; |
|
the number of strings to be read ; |
|
a boolean ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured, then values point on an allocated
memory area that is NULL terminated and that must be freed
with g_strfreev() .
|
gboolean configFileRead_stringFromTokens (gchar **tokens, int *position, gchar ***values, guint size, int lineId, GError **error);
Read size
strings from tokens
, store them in values
and returns
the new head in tokens
.
|
array of tokens resulting from a call to g_strsplit() with " " as separator ;
|
|
IN, the position of the beginning in tokens ; OUT, one token
after the last read ;
|
|
a location to point on a gchar** ; |
|
the number of floating point values to be read ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_stringWithElement (gchar *line, int position, gchar ***values, guint size, VisuElement **ele, GError **error);
Same as configFileRead_string()
but begins by reading an element
at the begining of the line.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to point on a gchar** ; |
|
the number of strings to be read ; |
|
a pointer to a VisuElement location ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured, then values point on an allocated
memory area that is NULL terminated and that must be freed
with g_strfreev() .
|
gboolean configFileRead_boolean (gchar *line, int position, gboolean *values, guint size, GError **error);
Read size
boolean values from line
and store them in values
.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
allocated area to store read values ; |
|
the number of boolean values to be read ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_booleanWithElement (gchar *line, int position, gboolean *values, guint size, VisuElement **ele, GError **error);
Same as configFileRead_boolean()
but begins by reading an element
at the begining of the line.
|
string where values are read from ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
allocated area to store read values ; |
|
the number of boolean values to be read ; |
|
a pointer to a VisuElement location ; |
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |
gboolean configFileRead_booleanFromTokens (gchar **tokens, int *position, gboolean *values, guint size, int lineId, GError **error);
Read size
boolean values from tokens
, store them in values
and returns
the new head in tokens
.
|
array of tokens resulting from a call to g_strsplit() with " " as separator ;
|
|
IN, the position of the beginning in tokens ; OUT, one token
after the last read ;
|
|
allocated area to store read values ; |
|
the number of floating point values to be read ; |
|
the number of the line of the config
file which the line argument is taken from ;
|
|
a location to store a possible reading error. |
Returns : |
TRUE if no error occured. |