![]() |
![]() |
![]() |
libgebr Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
GebrValidator * gebr_validator_new (GebrGeoXmlDocument **flow
,GebrGeoXmlDocument **line
,GebrGeoXmlDocument **proj
); gboolean gebr_validator_insert (GebrValidator *self
,GebrGeoXmlParameter *param
,GList **affected
,GError **error
); gboolean gebr_validator_remove (GebrValidator *self
,GebrGeoXmlParameter *param
,GList **affected
,GError **error
); gboolean gebr_validator_rename (GebrValidator *self
,GebrGeoXmlParameter *param
,const gchar *new_name
,GList **affected
,GError **error
); gboolean gebr_validator_change_value (GebrValidator *self
,GebrGeoXmlParameter *param
,const gchar *new_value
,GList **affected
,GError **error
); gboolean gebr_validator_move (GebrValidator *self
,GebrGeoXmlParameter *source
,GebrGeoXmlParameter *pivot
,GebrGeoXmlDocumentType pivot_scope
,GebrGeoXmlParameter **copy
,GList **affected
,GError **error
); gboolean gebr_validator_validate_param (GebrValidator *validator
,GebrGeoXmlParameter *parameter
,gchar **validated
,GError **error
); gboolean gebr_validator_validate_expr_on_scope (GebrValidator *self
,const gchar *str
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
,GError **err
); gboolean gebr_validator_validate_expr (GebrValidator *validator
,const gchar *expression
,GebrGeoXmlParameterType type
,GError **error
); void gebr_validator_get_documents (GebrValidator *validator
,GebrGeoXmlDocument **flow
,GebrGeoXmlDocument **line
,GebrGeoXmlDocument **proj
); void gebr_validator_update (GebrValidator *validator
); void gebr_validator_force_update (GebrValidator *validator
); void gebr_validator_free (GebrValidator *validator
); gboolean gebr_validator_evaluate_interval (GebrValidator *self
,const gchar *expr
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
,gboolean show_interval
,gchar **value
,GError **error
); gboolean gebr_validator_evaluate (GebrValidator *self
,const gchar *expr
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
,gchar **value
,GError **error
); gboolean gebr_validator_evaluate_param (GebrValidator *self
,GebrGeoXmlParameter *myparam
,gchar **value
,GError **error
); gboolean gebr_validator_is_var_in_scope (GebrValidator *self
,const gchar *name
,GebrGeoXmlDocumentType scope
); void gebr_validator_set_document (GebrValidator *self
,GebrGeoXmlDocument **doc
,GebrGeoXmlDocumentType type
,gboolean force
); gboolean gebr_validator_use_iter (GebrValidator *self
,const gchar *expr
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
); gboolean gebr_validator_validate_control_parameter (GebrValidator *self
,const gchar *name
,const gchar *expression
,GError **error
); GebrValidator;
GebrValidator * gebr_validator_new (GebrGeoXmlDocument **flow
,GebrGeoXmlDocument **line
,GebrGeoXmlDocument **proj
);
|
Reference to a flow |
|
Reference to a line |
|
Reference to a project |
Returns : |
A GebrValidator to validate type parameters and/or expressions. |
gboolean gebr_validator_insert (GebrValidator *self
,GebrGeoXmlParameter *param
,GList **affected
,GError **error
);
gboolean gebr_validator_remove (GebrValidator *self
,GebrGeoXmlParameter *param
,GList **affected
,GError **error
);
|
A GebrValidator |
|
The variable to be deleted |
|
A list containing the GebrGeoXmlParameter's affected |
Returns : |
TRUE if the variable was removed, FALSE if variable is not defined |
gboolean gebr_validator_rename (GebrValidator *self
,GebrGeoXmlParameter *param
,const gchar *new_name
,GList **affected
,GError **error
);
If the param
has not been inserted in validator, returns FALSE
|
A GebrValidator |
|
The variable to operate on |
|
The new name for param
|
|
The GebrGeoXmlParameter's affected by this operation |
|
Return location for error, or NULL
|
Returns : |
TRUE if no error ocurred, FALSE otherwise |
gboolean gebr_validator_change_value (GebrValidator *self
,GebrGeoXmlParameter *param
,const gchar *new_value
,GList **affected
,GError **error
);
Find variable on the correct scope, and changes the param
value to new_value
.
|
A GebrValidator |
|
The variable to operate on |
|
The new value for param
|
|
The GebrGeoXmlParameter's affected by this operation |
|
Return location for error, or NULL
|
Returns : |
TRUE if no error ocurred, FALSE otherwise |
gboolean gebr_validator_move (GebrValidator *self
,GebrGeoXmlParameter *source
,GebrGeoXmlParameter *pivot
,GebrGeoXmlDocumentType pivot_scope
,GebrGeoXmlParameter **copy
,GList **affected
,GError **error
);
|
A GebrValidator |
|
The variable to operate on |
|
The pivot for the operation, or NULL to append |
|
The scope of the pivot |
|
The return location for the new parameter |
|
The GebrGeoXmlParameter's affected by this operation |
|
Return location for error |
Returns : |
TRUE if the move was successfull, FALSE otherwise. |
gboolean gebr_validator_validate_param (GebrValidator *validator
,GebrGeoXmlParameter *parameter
,gchar **validated
,GError **error
);
Validates parameter
's values and returns the validated
string. If parameter
is not valid, then error
is filled with the appropriate message and NULL
is
returned.
|
A GebrValidator |
|
The GebrGeoXmlParameter to be validated |
|
Return location for the validated string, free with g_free()
|
|
Return location for the error, or NULL
|
Returns : |
TRUE if param is valid, FALSE otherwise. |
gboolean gebr_validator_validate_expr_on_scope (GebrValidator *self
,const gchar *str
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
,GError **err
);
gboolean gebr_validator_validate_expr (GebrValidator *validator
,const gchar *expression
,GebrGeoXmlParameterType type
,GError **error
);
|
A GebrValidator |
|
The expression to be validated |
|
The type of the expression
|
|
Returns location for the error, or NULL
|
Returns : |
TRUE if expression is valid, FALSE otherwise. |
void gebr_validator_get_documents (GebrValidator *validator
,GebrGeoXmlDocument **flow
,GebrGeoXmlDocument **line
,GebrGeoXmlDocument **proj
);
|
A GebrValidator |
|
Return location for the flow |
|
Return location for the line |
|
Return location for the proj |
void gebr_validator_update (GebrValidator *validator
);
Updates of all variables of the changed documents.
|
The GebrValidator to be updated |
void gebr_validator_force_update (GebrValidator *validator
);
Forces update of all variables, ignoring document cache.
void gebr_validator_free (GebrValidator *validator
);
|
The GebrValidator to be freed |
gboolean gebr_validator_evaluate_interval (GebrValidator *self
,const gchar *expr
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
,gboolean show_interval
,gchar **value
,GError **error
);
gboolean gebr_validator_evaluate (GebrValidator *self
,const gchar *expr
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
,gchar **value
,GError **error
);
gboolean gebr_validator_evaluate_param (GebrValidator *self
,GebrGeoXmlParameter *myparam
,gchar **value
,GError **error
);
Calculate the value of expr
and return it at value
.
|
The GebrValidator to be used |
|
The parameter to evaluate |
|
Returns the value of the expression. |
|
Returns the error, if any. |
Returns : |
TRUE if expr could be evaluated. FALSE otherwise. |
gboolean gebr_validator_is_var_in_scope (GebrValidator *self
,const gchar *name
,GebrGeoXmlDocumentType scope
);
Returns : |
TRUE if name exists in scope , FALSE otherwise |
void gebr_validator_set_document (GebrValidator *self
,GebrGeoXmlDocument **doc
,GebrGeoXmlDocumentType type
,gboolean force
);
Set on validator, a new doc
gboolean gebr_validator_use_iter (GebrValidator *self
,const gchar *expr
,GebrGeoXmlParameterType type
,GebrGeoXmlDocumentType scope
);
gboolean gebr_validator_validate_control_parameter (GebrValidator *self
,const gchar *name
,const gchar *expression
,GError **error
);
Return FALSE
if parameter have error, FALSE
otherwise
|
GebrValidator to validate parameter |
|
GError to set if has error |