visu_configFile
Defines methods to access (read/write) to config files and to create different entries
V_Sim uses two different configuration files. The first stores the configuration of the
program itself and is called parameters file. The second stores differents values that
control the way files are rendered. It is called resources file. For example, their is an
entry in the parameters file that controls your favorite rendering method ; and there is
is an entry in the resources file that codes that vacancy elements are rendered by
cube in the atomic rendering method. Most methods of this part uses a first argument usually
called 'kind', that control if the method will apply on the parameters file or on the
resources file. #VISU_CONFIGFILE_PARAMETER and #VISU_CONFIGFILE_RESOURCE are the two
flags that should be used for the 'kind' argument.
There are different paths where these files can be stored. These paths are stored in V_Sim
with an order : for example parameters file are first looked for in the current working
directory, then in the $HOME/.v_sim directory and finally in the installation directory.
This is transparent for the user and visuConfigFileGet_validPath() is the right method to
access to the best readable configuration file.
Different part of V_Sim can add entries in these files. The method visuConfigFileAdd_entry()
is designed to this purpose. The entries are defined by their name and they appear in
the configuration file as 'name:' followed by the data associated to this entry. In the
parameters file, the data are on the same line. In the resources file, the data begin the
line after and can be longer that one line. When a configuration file is read, the method
associated to each entry (visuConfigFileReadFunc()) is called with a copy of their data lines.
The method visuConfigFileAdd_exportFunction() should be used to add a callback when the
configurations files are written, then each part of V_Sim that have entries can put some
lines in the configuration files.
@data:
@nbLinesWritten:
@dataObj:
@Returns:
@lines:
@nbLines:
@position:
@errorMessage:
@Returns:
@data:
@nbLinesWritten:
@dataObj:
@kind:
@key:
@description:
@nbLines:
@readFunc:
@Returns:
@kind:
@writeFunc:
@tag:
@entry:
@tag:
@kind:
@fileName:
@message:
@Returns:
@kind:
@fileName:
@message:
@lines:
@dataObj:
@Returns:
@kind:
@Returns:
@kind:
@mode:
@utf8:
@Returns:
@kind:
@accessMode:
@list:
@utf8:
@Returns:
@kind:
@Returns:
@variable:
@value:
@min:
@max:
@Returns:
@Returns: