amxd_dm.h File Reference

Ambiorix Data Model API header file. More...

#include <amxd/amxd_types.h>

Go to the source code of this file.

Functions
amxd_status_t	amxd_dm_new (amxd_dm_t **dm)
	Instantiate a new data model. More...
void	amxd_dm_delete (amxd_dm_t **dm)
	Deletes a data model structure. More...
amxd_status_t	amxd_dm_init (amxd_dm_t *dm)
	Initializes a data model structure. More...
void	amxd_dm_clean (amxd_dm_t *dm)
	Cleans a data model structure. More...
amxd_status_t	amxd_dm_store_mib (amxd_dm_t *const dm, amxd_object_t *const object)
amxd_object_t *	amxd_dm_get_mib (amxd_dm_t *const dm, const char *name)
amxd_status_t	amxd_dm_add_root_object (amxd_dm_t *const dm, amxd_object_t *const object)
	Adds an object to the root of the data model. More...
amxd_status_t	amxd_dm_remove_root_object (amxd_dm_t *const dm, const char *name)
	Removes an object from the root of the data model. More...
amxd_object_t *	amxd_dm_get_root (amxd_dm_t *const dm)
	Fetches the root object of the data model. More...
amxd_object_t *	amxd_dm_get_object (amxd_dm_t *const dm, const char *name)
amxd_object_t *	amxd_dm_findf (amxd_dm_t *const dm, const char *abs_path,...) __attribute__((format(printf
amxd_object_t amxd_status_t	amxd_dm_resolve_pathf (amxd_dm_t *const dm, amxc_llist_t *paths, const char *abs_path,...) __attribute__((format(printf
amxd_object_t amxd_status_t amxd_status_t	amxd_dm_resolve_pathf_ext (amxd_dm_t *const dm, bool *key_path, amxc_llist_t *paths, const char *abs_path,...) __attribute__((format(printf
amxd_object_t amxd_status_t amxd_status_t const char *	amxd_dm_signal_get_path (amxd_dm_t *const dm, const amxc_var_t *const signal_data)
	Get the object path from a data model signal. More...
amxd_object_t *	amxd_dm_signal_get_object (amxd_dm_t *const dm, const amxc_var_t *const signal_data)
	Get the object from a data model using the path in the recieved signal. More...
amxd_status_t	amxd_dm_invoke_action (amxd_object_t *object, amxd_param_t *param, amxd_action_t reason, const amxc_var_t *const args, amxc_var_t *const retval)
static amxd_status_t	amxd_dm_get_status (amxd_dm_t *dm)

Detailed Description

Ambiorix Data Model API header file.

Definition in file amxd_dm.h.

Function Documentation

amxd_dm_findf()

amxd_object_t* amxd_dm_findf	(	amxd_dm_t *const	dm,
		const char *	abs_path,
			...
	)

amxd_dm_get_mib()

amxd_object_t* amxd_dm_get_mib	(	amxd_dm_t *const	dm,
		const char *	name
	)

Definition at line 397 of file amxd_dm.c.

                                                 {
    amxd_object_t* mib = NULL;
 
    when_null(dm, exit);
    when_str_empty(name, exit);
 
    amxc_llist_for_each(it, (&dm->mibs)) {
        const char* mib_name = NULL;
        mib = amxc_llist_it_get_data(it, amxd_object_t, it);
        mib_name = amxd_object_get_name(mib, AMXD_OBJECT_NAMED);
        if((mib_name != NULL) && (strcmp(mib_name, name) == 0)) {
            break;
        }
        mib = NULL;
    }
 
exit:
    return mib;
}

amxd_dm_get_object()

amxd_object_t* amxd_dm_get_object	(	amxd_dm_t *const	dm,
		const char *	name
	)

Definition at line 466 of file amxd_dm.c.

                                                                         {
    return amxd_object_get_child(&dm->object, name);
}

amxd_dm_get_status()

static amxd_status_t amxd_dm_get_status ( amxd_dm_t *  dm )

inlinestatic

Definition at line 292 of file amxd_dm.h.

                                                {
    return dm == NULL ? amxd_status_invalid_arg : dm->status;
}

amxd_dm_invoke_action()

amxd_status_t amxd_dm_invoke_action	(	amxd_object_t *	object,
		amxd_param_t *	param,
		amxd_action_t	reason,
		const amxc_var_t *const	args,
		amxc_var_t *const	retval
	)

Definition at line 591 of file amxd_dm.c.

                                                              {
    static int in_object_action = 0;
    static int in_param_action = 0;
    static amxd_object_t* current = NULL;
 
    amxd_object_t* temp = NULL;
    amxc_llist_t* cb_fns = NULL;
    int* counter = NULL;
    amxd_status_t status = amxd_status_function_not_implemented;
    when_true(object == NULL && param == NULL, exit);
    when_true_status(reason == action_any, exit, status = amxd_status_invalid_action);
 
    temp = current;
    if(param != NULL) {
        when_true_status(!amxd_dm_can_invoke_action(in_param_action, reason, current, object),
                         exit,
                         status = amxd_status_invalid_action);
        counter = &in_param_action;
        cb_fns = &param->cb_fns;
    } else {
        when_true_status(!amxd_dm_can_invoke_action(in_object_action + in_param_action,
                                                    reason, current, object),
                         exit,
                         status = amxd_status_invalid_action);
        counter = &in_object_action;
        cb_fns = &object->cb_fns;
    }
 
    (*counter)++;
    current = object;
    amxd_dm_invoke_action_start(object, param, reason);
    status = amxd_dm_invoke_action_impl(cb_fns, object, param, reason, args, retval);
    if(status == amxd_status_function_not_implemented) {
        status = amxd_dm_invoke_default(object, param, reason, args, retval);
    }
    (*counter)--;
    status = amxd_dm_invoke_action_end(object, param, status, reason, retval);
 
    current = temp;
 
exit:
    return status;
}

amxd_dm_resolve_pathf()

amxd_object_t amxd_status_t amxd_dm_resolve_pathf	(	amxd_dm_t *const	dm,
		amxc_llist_t *	paths,
		const char *	abs_path,
			...
	)

amxd_dm_resolve_pathf_ext()

amxd_object_t amxd_status_t amxd_status_t amxd_dm_resolve_pathf_ext	(	amxd_dm_t *const	dm,
		bool *	key_path,
		amxc_llist_t *	paths,
		const char *	abs_path,
			...
	)

amxd_dm_store_mib()

amxd_status_t amxd_dm_store_mib	(	amxd_dm_t *const	dm,
		amxd_object_t *const	object
	)

Definition at line 378 of file amxd_dm.c.

                                                             {
    amxd_status_t retval = amxd_status_unknown_error;
    const char* mib_name = NULL;
    when_null(dm, exit);
    when_null(object, exit);
    when_true(amxd_object_get_type(object) != amxd_object_mib, exit);
    mib_name = amxd_object_get_name(object, AMXD_OBJECT_NAMED);
    when_true_status(amxd_dm_get_mib(dm, mib_name) != NULL,
                     exit,
                     retval = amxd_status_duplicate);
 
    amxc_llist_append(&dm->mibs, &object->it);
 
    retval = amxd_status_ok;
exit:
    return retval;
}