visu_commandLine

visu_commandLine — All methods needed to parse options from the command line.

Synopsis

int                 parseCommandLine                    (int argc,
                                                         char **argv);
gboolean            commandLineExport                   (const gchar *filename,
                                                         GError **error);
char*               commandLineGet_ArgFilename          ();
char*               commandLineGet_ExportFileName       ();
int                 commandLineGet_WithGtk              ();
void                commandLineGet_XWindowGeometry      (int *width,
                                                         int *height);
char*               commandLineGet_ArgSpinFileName      ();
int                 commandLineGet_spinHidingMode       ();
gboolean            commandLineGet_spinAndAtomic        ();
int*                commandLineGet_colorizeColUsed      ();
gchar*              commandLineGet_colorizeFileName     ();
float*              commandLineGet_translation          ();
float*              commandLineGet_extension            ();
#define             commandLineGet_colorizePresetColor  ()
gchar*              commandLineGet_planesFileName       ();
gchar*              commandLineGet_isoSurfacesFileName  ();
gboolean            commandLineGet_fitToBox             ();
gchar*              commandLineGet_resourcesFile        ();
gchar*              commandLineGet_scalarFieldFileName  ();
float*              commandLineGet_isoValues            (int *nb);
gchar**             commandLineGet_isoNames             (int *nb);
int*                commandLineGet_coloredMap           ();
int                 commandLineGet_presetColor          ();
gchar*              commandLineGet_bgImage              ();
OptionTable*        commandLineGet_options              ();
matrix_scaleflag    commandLineGet_logScale             ();
guint               commandLineGet_nIsoLines            ();
guint               commandLineGet_iSet                 ();
float*              commandLineGet_isoLinesColor        ();
gchar*              commandLineGet_valueFile            ();
gchar*              commandLineGet_windowMode           ();

Description

V_Sim parses the command line at startup and store data in private variables. All this values can be retrieve later by the program through calls to commandLineGet_* methods.

Details

parseCommandLine ()

int                 parseCommandLine                    (int argc,
                                                         char **argv);

This method is called at startup to parse the command line and store all important information. If --help is given, or an unknown option, a little help is printed on the standard output.

argc :

the number of arguments.

argv :

the values of all arguments.

Returns :

0 if everything goes well.

commandLineExport ()

gboolean            commandLineExport                   (const gchar *filename,
                                                         GError **error);

Export the known command line options to an XML file.

filename :

a path to a filename to create ;

error :

a location to store a possible error.

Returns :

TRUE on success.

Since 3.5


commandLineGet_ArgFilename ()

char*               commandLineGet_ArgFilename          ();

This method retrieves the first argument. All other arguments are ignored.

Returns :

the value of the first argument.

commandLineGet_ExportFileName ()

char*               commandLineGet_ExportFileName       ();

This method retrieves the value of the option --export or -e. This value must be a valid filename, with an extension known by V_Sim to do the export.

Returns :

the value of the option --export.

commandLineGet_WithGtk ()

int                 commandLineGet_WithGtk              ();

This method tells V_Sim is the GTK interface is needed or not.

Returns :

1 if the interface is needed.

commandLineGet_XWindowGeometry ()

void                commandLineGet_XWindowGeometry      (int *width,
                                                         int *height);

This method retrieves the values of the option --geometry or -g. These values must be formatted with the following format : dxd and they give the size of the rendering window.

width :

an integer to stores the desired width.

height :

an integer to stores the desired height.

commandLineGet_ArgSpinFileName ()

char*               commandLineGet_ArgSpinFileName      ();

This method retrieves the second argument. All other arguments are ignored.

Returns :

the value of the second argument.

commandLineGet_spinHidingMode ()

int                 commandLineGet_spinHidingMode       ();

This method retrieves if the option --hiding-mode or -m has been set.

Returns :

the value of the option.

commandLineGet_spinAndAtomic ()

gboolean            commandLineGet_spinAndAtomic        ();

This method retrieves if the option --spin-and-atomic or -a has been set.

Returns :

the TRUE if the option exists.

commandLineGet_colorizeColUsed ()

int*                commandLineGet_colorizeColUsed      ();

This method retrieves the value of the option --use-column or -u. This value consists of three integer values.

Returns :

the three values of the option --use-column, or NULL if this option is not present.

commandLineGet_colorizeFileName ()

gchar*              commandLineGet_colorizeFileName     ();

This method retrieves the value of the option --colorize or -c. This value must be a valid filename. If this option is called, V_Sim actually enable the colorization, even if parameter file doesn't.

Returns :

the value of the option --colorize.

commandLineGet_translation ()

float*              commandLineGet_translation          ();

This method retrieves the value of the option --translate or -t. This value consists of three floating values.

Returns :

the three values of the option --translate.

commandLineGet_extension ()

float*              commandLineGet_extension            ();

This method retrieves the value of the option --expand or -x. This value consists of three floating values.

Returns :

the three values of the option --expand.

commandLineGet_colorizePresetColor()

#define commandLineGet_colorizePresetColor() commandLineGet_presetColor();

DEPRECATED, use commandLineGet_presetColor() instead.

Returns :

the value of option --color-preset if set, -1 if not.

commandLineGet_planesFileName ()

gchar*              commandLineGet_planesFileName       ();

This method retrieves the value of the option --planes or -p. This value must be a valid filename.

Returns :

the value of the option --planes.

commandLineGet_isoSurfacesFileName ()

gchar*              commandLineGet_isoSurfacesFileName  ();

This method retrieves the filename given by the option --iso-surfaces or -i.

Returns :

a filename, the string is owned by V_Sim.

commandLineGet_fitToBox ()

gboolean            commandLineGet_fitToBox             ();

This method gets if the surface should be adapted to the bounding box of the structure.

Returns :

TRUE if the surface should be fitted.

commandLineGet_resourcesFile ()

gchar*              commandLineGet_resourcesFile        ();

This method gets if a resources file has been given.

Returns :

the name (owned by V_Sim) of the given resources file or NULL if none was present.

commandLineGet_scalarFieldFileName ()

gchar*              commandLineGet_scalarFieldFileName  ();

This method retrieves the filename given by the option --scalar-field or -f.

Returns :

a filename, the string is owned by V_Sim.

commandLineGet_isoValues ()

float*              commandLineGet_isoValues            (int *nb);

This method retrieves the values of the option --ios-values or -v.

nb :

a location to store an integer.

Returns :

an array with the values of a size stored in nb.

commandLineGet_isoNames ()

gchar**             commandLineGet_isoNames             (int *nb);

This method retrieves the names associated to the values of the option --ios-values or -v. It returns an array of size nb, but not all element are set since names are not mandatory. The nb value is guarantied to by equal to the one returned by commandLineGet_isoValues();

nb :

a location to store an integer.

Returns :

an array with the values of a size stored in nb.

commandLineGet_coloredMap ()

int*                commandLineGet_coloredMap           ();

If the return value is TRUE, then the user requests a coloured map using the given plane. The scalar field is given by '--scalar-filed' option (see commandLineGet_scalarFieldFileName()) and the shade by '--color-preset' (see commandLineGet_presetColor()).

planeId :

a location to store the plane to be used.

Returns :

TRUE if a coloured map is requested.

commandLineGet_presetColor ()

int                 commandLineGet_presetColor          ();

This method returns the value of option --color-preset.

Returns :

the value of option --color-preset if set, -1 if not.

commandLineGet_bgImage ()

gchar*              commandLineGet_bgImage              ();

Retrieve if the filename to be loaded as a background image.

Returns :

a string or NULL if option is not used.

commandLineGet_options ()

OptionTable*        commandLineGet_options              ();

This method gets the contents of all -o options. The value is first parsed as letters to check for a boolean value (F/T), then, a float is used and finally an integer. If nothing parsed, the option is dismissed.

Returns :

a OptionTable pointer owned by V_Sim.

commandLineGet_logScale ()

matrix_scaleflag    commandLineGet_logScale             ();

Retrieve if a log scale is required for various plots.

Returns :

the logscale method.

commandLineGet_nIsoLines ()

guint               commandLineGet_nIsoLines            ();

Retrieve if the user asked for isolines on the coloured map (see commandLineGet_coloredMap()).

Returns :

a positive number if some isolines are required, 0 if not.

commandLineGet_iSet ()

guint               commandLineGet_iSet                 ();

Retrieve the desired id for multi dataset file to render.

Returns :

0 as default value.

Since 3.5


commandLineGet_isoLinesColor ()

float*              commandLineGet_isoLinesColor        ();

Retrieve the chosen colour for the iso-lines.

Returns :

an array of three floats or NULL if the colour is auto.

Since 3.5


commandLineGet_valueFile ()

gchar*              commandLineGet_valueFile            ();

Retrieve the name of a possible value file, if any has been given.

Returns :

a path (absolute) or NULL if the option has not been passed. Data are static.

Since 3.5


commandLineGet_windowMode ()

gchar*              commandLineGet_windowMode           ();

Retrieve the windowing mode for V_Sim, 'classic' with the two rendering and command panel windows ; 'oneWindow' with a joined version of the two windows or 'renderOnly' with only the rendering window.

Returns :

one of the three strings.

Since 3.5