Top | ![]() |
![]() |
![]() |
![]() |
#define | VISU_COMMAND_LINE_ERROR |
enum | VisuCommandLineErrorFlag |
struct | VisuColorRange |
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.
GQuark visu_command_line_getErrorQuark ();
Internal routine for error handling.
Since: 3.8
int commandLineParse (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.
gboolean commandLineExport (const gchar *filename
,GError **error
);
Export the known command line options to an XML file.
Since: 3.5
char *
commandLineGet_ArgFilename (void
);
This method retrieves the first argument. All other arguments are ignored.
char *
commandLineGet_ArgSpinFileName (void
);
This method retrieves the second argument. All other arguments are ignored.
char *
commandLineGet_ExportFileName (void
);
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.
int
commandLineGet_WithGtk (void
);
This method tells V_Sim is the GTK interface is needed or not.
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 : &dx&d and they give the size of the rendering window.
const gchar *
commandLineGet_colorizeSource (gboolean *isFile
);
Retrieve the string given on command line that is used to identify the source of colourisation, either a VisuNodeValues name or a filename.
Since: 3.8
int *
commandLineGet_colorizeColUsed (void
);
This method retrieves the value of the option --use-column or -u. This value consists of three integer values.
#define commandLineGet_colorizePresetColor() commandLineGet_presetColor();
DEPRECATED, use commandLineGet_presetColor()
instead.
int
commandLineGet_presetColor (void
);
This method returns the value of option --color-preset.
float *
commandLineGet_translation (gboolean *boxTranslation
);
This method retrieves the value of the option --translate or -t. This value consists of three floating values. If -q or --box-translation is present, the returned value is the translations along box axis.
float *
commandLineGet_extension (void
);
This method retrieves the value of the option --expand or -x. This value consists of three floating values.
gchar *
commandLineGet_planesFileName (void
);
This method retrieves the value of the option --planes or -p. This value must be a valid filename.
int
commandLineGet_spinHidingMode (void
);
This method retrieves if the option --hiding-mode or -m has been set.
gboolean
commandLineGet_spinAndAtomic (void
);
This method retrieves if the option --spin-and-atomic or -a has been set.
float *
commandLineGet_isoValues (int *nb
);
This method retrieves the values of the option --ios-values or -v.
const 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(void);
const GList *
commandLineGet_scalarFieldFileNames (void
);
This method retrieves the filename given by the option --scalar-field or -f.
gchar *
commandLineGet_isoVisuSurfaceFileName (void
);
This method retrieves the filename given by the option --iso-surfaces or -i.
gboolean
commandLineGet_fitToBox (void
);
This method gets if the surface should be adapted to the bounding box of the structure.
gchar *
commandLineGet_resourcesFile (void
);
This method gets if a resources file has been given.
GHashTable *
commandLineGet_options (void
);
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.
int *
commandLineGet_coloredMap (void
);
One can pass options on the command line to create colored maps on planes.
Since: 3.6
ToolMatrixScalingFlag
commandLineGet_logScale (void
);
Retrieve if a log scale is required for various plots.
guint
commandLineGet_nIsoLines (void
);
Retrieve if the user asked for isolines on the coloured map (see
commandLineGet_coloredMap()
).
gchar *
commandLineGet_bgImage (void
);
Retrieve if the filename to be loaded as a background image.
float *
commandLineGet_isoLinesColor (void
);
Retrieve the chosen colour for the iso-lines.
Since: 3.5
gchar *
commandLineGet_windowMode (void
);
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.
Since: 3.5
guint
commandLineGet_iSet (void
);
Retrieve the desired id for multi dataset file to render.
Since: 3.5
gchar *
commandLineGet_valueFile (void
);
Retrieve the name of a possible value file, if any has been given.
Since: 3.5
void
commandLineFree_all (void
);
Release all allocated memory related to the command line options.
Since: 3.5
guint
commandLineGet_mapPrecision (void
);
The coloured maps can be rendered with more or less accuracy.
Since: 3.6
float *
commandLineGet_mapMinMax (void
);
The coloured maps can be manually scaled.
Since: 3.6
gchar *
commandLineGet_introspect (void
);
Used only by introspection scanner.
Since: 3.6
GArray *
commandLineGet_colorMinMax (void
);
The external data file colourisation can be manually scaled.
Since: 3.7
const gchar *
commandLineGet_programName (void
);
Get argv[0].
Since: 3.7
int
commandLineGet_scalingColumn (void
);
Get the column used to scale nodes, if any given.
Since: 3.7
const gchar *
commandLineGet_geodiff (void
);
Get the name of the file to compute the difference from, if any given.
Since: 3.8
gint
commandLineGet_phononMode (void
);
Get the desired phonon mode.
Since: 3.8
gfloat
commandLineGet_phononTime (void
);
Get the time offset to apply dislacement from phonons.
Since: 3.8
#define VISU_COMMAND_LINE_ERROR visu_command_line_getErrorQuark()
Internal function for error handling.
struct VisuColorRange { int column; float min, max; };
A structure to pass information from the command line to the code on clamping values for column.
Since: 3.8