amxd_action.h File Reference

Ambiorix Data Model Default actions header file. More...

#include <stdint.h>
#include <amxd/amxd_types.h>

Go to the source code of this file.

Functions
amxd_status_t	amxd_action_param_read (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default parameter read action implementation. More...
amxd_status_t	amxd_action_param_read_hidden_value (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default parameter read action implementation for hidden values. More...
amxd_status_t	amxd_action_param_write (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default parameter write action implementation. More...
amxd_status_t	amxd_action_param_validate (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default parameter validate action implementation. More...
amxd_status_t	amxd_action_param_check_range (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default check range parameter validate action implementation. More...
amxd_status_t	amxd_action_param_check_minimum (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default check minimum parameter validate action implementation. More...
amxd_status_t	amxd_action_param_check_maximum (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default check maximum parameter validate action implementation. More...
amxd_status_t	amxd_action_param_check_enum (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default check enum parameter validate action implementation. More...
amxd_status_t	amxd_action_param_check_is_in (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default check is in parameter validate action implementation. More...
void	amxd_param_build_description (amxc_var_t *description, const char *name, uint32_t type_id, uint32_t attrs, amxc_var_t *flags)
amxd_status_t	amxd_action_param_describe (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default parameter describe action implementation. More...
amxd_status_t	amxd_action_param_destroy (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default parameter destroy action implementation. More...
amxd_status_t	amxd_action_object_list (amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default object list action implementation. More...
amxd_status_t	amxd_action_object_describe (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default object describe action implementation. More...
amxd_status_t	amxd_action_object_read_filter (amxc_string_t *filter, const amxc_var_t *args)
amxd_status_t	amxd_action_object_read (amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
amxd_status_t	amxd_action_object_write (amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
amxd_status_t	amxd_action_object_add_inst (amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
amxd_status_t	amxd_action_object_del_inst (amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
amxd_status_t	amxd_action_object_destroy (amxd_object_t *object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default object destroy action implementation. More...
amxd_status_t	amxd_action_object_validate (amxd_object_t *const object, amxd_param_t *const param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval, void *priv)
	Default object validate action implementation. More...

Detailed Description

Ambiorix Data Model Default actions header file.

Definition in file amxd_action.h.

Function Documentation

amxd_action_object_add_inst()

amxd_status_t amxd_action_object_add_inst	(	amxd_object_t *const	object,
		amxd_param_t *const	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		amxc_var_t *const	retval,
		void *	priv
	)

amxd_action_object_del_inst()

amxd_status_t amxd_action_object_del_inst	(	amxd_object_t *const	object,
		amxd_param_t *const	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		amxc_var_t *const	retval,
		void *	priv
	)

amxd_action_object_read()

amxd_status_t amxd_action_object_read	(	amxd_object_t *const	object,
		amxd_param_t *const	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		amxc_var_t *const	retval,
		void *	priv
	)

amxd_action_object_read_filter()

amxd_status_t amxd_action_object_read_filter	(	amxc_string_t *	filter,
		const amxc_var_t *	args
	)

Definition at line 233 of file amxd_action_object_read.c.

                                                                     {
    amxd_status_t status = amxd_status_ok;
    amxc_var_t* temp = NULL;
    const char* f = GET_CHAR(args, "filter");
 
    if((f != NULL) && (*f != 0)) {
        amxc_string_setf(filter, "%s", f);
        goto exit;
    }
 
    temp = GET_ARG(args, "parameters");
    when_true_status(!amxc_var_is_null(temp) && amxc_var_type_of(temp) != AMXC_VAR_ID_LIST,
                     exit,
                     status = amxd_status_invalid_function_argument);
    if(temp != NULL) {
        filter_add_params(filter, amxc_var_constcast(amxc_llist_t, temp));
    }
 
    temp = GET_ARG(args, "attributes");
    if(temp != NULL) {
        filter_add_attributes(filter, amxc_var_dyncast(uint32_t, temp));
    }
 
exit:
    return status;
}

amxd_action_object_write()

amxd_status_t amxd_action_object_write	(	amxd_object_t *const	object,
		amxd_param_t *const	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		amxc_var_t *const	retval,
		void *	priv
	)

amxd_param_build_description()

void amxd_param_build_description	(	amxc_var_t *	description,
		const char *	name,
		uint32_t	type_id,
		uint32_t	attrs,
		amxc_var_t *	flags
	)

Definition at line 109 of file amxd_action_param_describe.c.

                                                     {
    static const char* attr_name[] = {
        "template", "instance", "private", "read-only", "persistent",
        "volatile", "counter", "key", "unique", "protected", "mutable"
    };
    amxc_var_t* subvar = NULL;
    amxc_var_set_type(description, AMXC_VAR_ID_HTABLE);
 
    amxc_var_add_key(cstring_t, description, "name", name);
    amxc_var_add_key(uint32_t, description, "type_id", type_id);
    amxc_var_add_key(cstring_t, description, "type_name", amxc_var_get_type_name_from_id(type_id));
    amxc_var_add_new_key(description, "value");
    subvar = amxc_var_add_key(amxc_htable_t, description, "attributes", NULL);
    for(int i = 0; i <= amxd_pattr_max; i++) {
        amxc_var_add_key(bool, subvar, attr_name[i], IS_BIT_SET(attrs, i));
    }
    subvar = amxc_var_add_key(amxc_llist_t, description, "flags", NULL);
    if(flags != NULL) {
        const amxc_htable_t* ht_flags = amxc_var_constcast(amxc_htable_t, flags);
        amxc_htable_iterate(it, ht_flags) {
            amxc_var_t* flag = amxc_var_from_htable_it(it);
            if(amxc_var_dyncast(bool, flag)) {
                amxc_var_add(cstring_t, subvar, amxc_htable_it_get_key(it));
            }
        }
    }
}