program

program

Functions

void gebr_geoxml_program_foreach_parameter ()
GebrGeoXmlFlow * gebr_geoxml_program_flow ()
GebrGeoXmlParameters * gebr_geoxml_program_get_parameters ()
gsize gebr_geoxml_program_count_parameters ()
void gebr_geoxml_program_set_stdin ()
void gebr_geoxml_program_set_stdout ()
void gebr_geoxml_program_set_stderr ()
void gebr_geoxml_program_set_status ()
void gebr_geoxml_program_set_title ()
void gebr_geoxml_program_set_binary ()
void gebr_geoxml_program_set_description ()
void gebr_geoxml_program_set_help ()
void gebr_geoxml_program_set_version ()
void gebr_geoxml_program_set_mpi ()
void gebr_geoxml_program_set_url ()
gboolean gebr_geoxml_program_get_stdin ()
gboolean gebr_geoxml_program_get_stdout ()
gboolean gebr_geoxml_program_get_stderr ()
GebrGeoXmlProgramStatus gebr_geoxml_program_get_status ()
gchar * gebr_geoxml_program_get_title ()
const gchar * gebr_geoxml_program_get_binary ()
gchar * gebr_geoxml_program_get_description ()
gchar * gebr_geoxml_program_get_help ()
gchar * gebr_geoxml_program_get_version ()
const gchar * gebr_geoxml_program_get_mpi ()
const gchar * gebr_geoxml_program_get_url ()
GebrGeoXmlProgramControl gebr_geoxml_program_get_control ()
gchar * gebr_geoxml_program_control_get_n ()
void gebr_geoxml_program_control_get_labels ()
void gebr_geoxml_program_control_set_n ()
gint gebr_geoxml_program_control_get_eval_n ()
gboolean gebr_geoxml_program_is_var_used ()
void gebr_geoxml_program_set_error_id ()
gboolean gebr_geoxml_program_get_error_id ()
gboolean gebr_geoxml_program_is_valid ()
void gebr_geoxml_program_mpi_set_n_process ()
gchar * gebr_geoxml_program_mpi_get_n_process ()
GebrGeoXmlParameters * gebr_geoxml_program_mpi_get_parameters ()
GebrGeoxmlProgramMpiType gebr_geoxml_program_mpi_type_str_to_enum ()
const char * gebr_geoxml_program_mpi_type_enum_to_str ()

Types and Values

Description

Functions

gebr_geoxml_program_foreach_parameter ()

void
gebr_geoxml_program_foreach_parameter (GebrGeoXmlProgram *program,
                                       GebrGeoXmlCallback callback,
                                       gpointer user_data);

gebr_geoxml_program_flow ()

GebrGeoXmlFlow *
gebr_geoxml_program_flow (GebrGeoXmlProgram *program);

Get the flow to which program belongs to.

program should not be passed as NULL, or an error will occur.

Parameters

program

a program appended in a flow

 

Returns

the flow to which program belongs.


gebr_geoxml_program_get_parameters ()

GebrGeoXmlParameters *
gebr_geoxml_program_get_parameters (GebrGeoXmlProgram *program);

gebr_geoxml_program_count_parameters ()

gsize
gebr_geoxml_program_count_parameters (GebrGeoXmlProgram *program);

gebr_geoxml_program_set_stdin ()

void
gebr_geoxml_program_set_stdin (GebrGeoXmlProgram *program,
                               const gboolean enable);

gebr_geoxml_program_set_stdout ()

void
gebr_geoxml_program_set_stdout (GebrGeoXmlProgram *program,
                                const gboolean enable);

gebr_geoxml_program_set_stderr ()

void
gebr_geoxml_program_set_stderr (GebrGeoXmlProgram *program,
                                const gboolean enable);

gebr_geoxml_program_set_status ()

void
gebr_geoxml_program_set_status (GebrGeoXmlProgram *program,
                                GebrGeoXmlProgramStatus status);

gebr_geoxml_program_set_title ()

void
gebr_geoxml_program_set_title (GebrGeoXmlProgram *program,
                               const gchar *title);

gebr_geoxml_program_set_binary ()

void
gebr_geoxml_program_set_binary (GebrGeoXmlProgram *program,
                                const gchar *binary);

gebr_geoxml_program_set_description ()

void
gebr_geoxml_program_set_description (GebrGeoXmlProgram *program,
                                     const gchar *description);

gebr_geoxml_program_set_help ()

void
gebr_geoxml_program_set_help (GebrGeoXmlProgram *program,
                              const gchar *help);

gebr_geoxml_program_set_version ()

void
gebr_geoxml_program_set_version (GebrGeoXmlProgram *program,
                                 const gchar *version);

gebr_geoxml_program_set_mpi ()

void
gebr_geoxml_program_set_mpi (GebrGeoXmlProgram *program,
                             const gchar *mpi_type);

gebr_geoxml_program_set_url ()

void
gebr_geoxml_program_set_url (GebrGeoXmlProgram *program,
                             const gchar *url);

gebr_geoxml_program_get_stdin ()

gboolean
gebr_geoxml_program_get_stdin (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_stdout ()

gboolean
gebr_geoxml_program_get_stdout (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_stderr ()

gboolean
gebr_geoxml_program_get_stderr (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_status ()

GebrGeoXmlProgramStatus
gebr_geoxml_program_get_status (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_title ()

gchar *
gebr_geoxml_program_get_title (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_binary ()

const gchar *
gebr_geoxml_program_get_binary (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_description ()

gchar *
gebr_geoxml_program_get_description (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_help ()

gchar *
gebr_geoxml_program_get_help (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_version ()

gchar *
gebr_geoxml_program_get_version (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_mpi ()

const gchar *
gebr_geoxml_program_get_mpi (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_url ()

const gchar *
gebr_geoxml_program_get_url (GebrGeoXmlProgram *program);

gebr_geoxml_program_get_control ()

GebrGeoXmlProgramControl
gebr_geoxml_program_get_control (GebrGeoXmlProgram *program);

gebr_geoxml_program_control_get_n ()

gchar *
gebr_geoxml_program_control_get_n (GebrGeoXmlProgram *prog,
                                   gchar **step,
                                   gchar **ini);

Parameters

prog

A GebrGeoXmlProgram

 

Returns

0 if prog is NULL or the parameter is not defined, otherwise it returns the non-negative value representing the number of iterations.


gebr_geoxml_program_control_get_labels ()

void
gebr_geoxml_program_control_get_labels
                               (GebrGeoXmlProgram *prog,
                                gchar **ini,
                                gchar **step,
                                gchar **niter);

Parameters

prog

A Loop program.

 

ini

Return location for initial value label.

 

step

Return location for step label.

 

niter

Return location for number of iterations label.

 

gebr_geoxml_program_control_set_n ()

void
gebr_geoxml_program_control_set_n (GebrGeoXmlProgram *prog,
                                   const gchar *step,
                                   const gchar *ini,
                                   const gchar *n);

gebr_geoxml_program_control_get_eval_n ()

gint
gebr_geoxml_program_control_get_eval_n
                               (GebrGeoXmlProgram *prog,
                                GebrValidator *validator);

Parameters

prog

A Loop program.

 

validator

The validator

 

Returns

The evaluated n of prog


gebr_geoxml_program_is_var_used ()

gboolean
gebr_geoxml_program_is_var_used (GebrGeoXmlProgram *self,
                                 const gchar *var_name);

gebr_geoxml_program_set_error_id ()

void
gebr_geoxml_program_set_error_id (GebrGeoXmlProgram *self,
                                  gboolean clear,
                                  GebrIExprError id);

Sets the error id for self program. If clear is TRUE, id is ignored and the error id is set to the empty string.

Parameters

self

a GebrGeoXmlProgram

 

clear

TRUE to set error to id , FALSE to clear

 

id

one of GebrIExprError enumerations

 

gebr_geoxml_program_get_error_id ()

gboolean
gebr_geoxml_program_get_error_id (GebrGeoXmlProgram *self,
                                  GebrIExprError *id);

Parameters

program

a GebrGeoXmlProgram

 

id

return location for the error id if program has an error.

[out]

Returns

TRUE if the program has an error id, FALSE otherwise


gebr_geoxml_program_is_valid ()

gboolean
gebr_geoxml_program_is_valid (GebrGeoXmlProgram *self,
                              GebrValidator *validator,
                              GError **err);

Parameters

program

a GebrGeoXmlProgram

 

validator

A GebrValidator

 

err

return location for error, or NULL

 

Returns

TRUE if program is valid, FALSE otherwise.


gebr_geoxml_program_mpi_set_n_process ()

void
gebr_geoxml_program_mpi_set_n_process (GebrGeoXmlProgram *self,
                                       gint n);

gebr_geoxml_program_mpi_get_n_process ()

gchar *
gebr_geoxml_program_mpi_get_n_process (GebrGeoXmlProgram *self);

gebr_geoxml_program_mpi_get_parameters ()

GebrGeoXmlParameters *
gebr_geoxml_program_mpi_get_parameters
                               (GebrGeoXmlProgram *self);

gebr_geoxml_program_mpi_type_str_to_enum ()

GebrGeoxmlProgramMpiType
gebr_geoxml_program_mpi_type_str_to_enum
                               (const gchar *mpi_flavor);

gebr_geoxml_program_mpi_type_enum_to_str ()

const char *
gebr_geoxml_program_mpi_type_enum_to_str
                               (GebrGeoxmlProgramMpiType flavor);

Types and Values

enum GebrGeoxmlProgramMpiType

Members

GEBR_GEOXML_PROGRAM_MPI_TYPE_OPENMPI

   

GEBR_GEOXML_PROGRAM_MPI_TYPE_MPICH2