amxd_path.h File Reference

Ambiorix path API header file. More...

Go to the source code of this file.

Functions
amxd_status_t	amxd_path_init (amxd_path_t *path, const char *object_path)
	Initializes an amxd_path_t structure. More...
void	amxd_path_clean (amxd_path_t *path)
	Cleans an amxd_path_t structure. More...
amxd_status_t	amxd_path_new (amxd_path_t **path, const char *object_path)
	Allocates and initializes an amxd_path_t structure. More...
void	amxd_path_delete (amxd_path_t **path)
	Frees an allocated amxd_path_t structure. More...
void	amxd_path_reset (amxd_path_t *path)
	Resets the amxd_path_t structure. More...
amxd_status_t	amxd_path_vsetf (amxd_path_t *path, bool add_dot, const char *obj_path, va_list args)
	Sets or replaces the path contained in the amxd_path_t structure. More...
amxd_status_t	amxd_path_setf (amxd_path_t *path, bool add_dot, const char *obj_path,...) __attribute__((format(printf
	Sets or replaces the path contained in the amxd_path_t structure. More...
amxd_status_t amxd_status_t	amxd_path_append (amxd_path_t *path, const char *extension, bool add_dot)
	Appends a parameter name or object name/index to the path. More...
amxd_status_t	amxd_path_prepend (amxd_path_t *path, const char *extension)
	Prepends an object name/index to the path. More...
const char *	amxd_path_get (amxd_path_t *path, int flags)
	Returns the path stored in the amxd_path_t structure. More...
const char *	amxd_path_get_param (amxd_path_t *path)
	Gets the parameter name. More...
char *	amxd_path_get_first (amxd_path_t *path, bool remove)
	Gets the first part of the path. More...
char *	amxd_path_get_last (amxd_path_t *path, bool remove)
	Gets the last part of the path. More...
char *	amxd_path_get_fixed_part (amxd_path_t *path, bool remove)
	Gets the fixed part of the path. More...
char *	amxd_path_get_supported_path (amxd_path_t *path)
	Translates the path into a path that can be used to fetch the object definition. More...
char *	amxd_path_get_reference_part (amxd_path_t *path, bool remove)
	Returns the reference path. More...
uint32_t	amxd_path_get_reference_index (amxd_path_t *path)
	Returns the reference path index. More...
char *	amxd_path_build_supported_path (amxd_path_t *path)
	Creates the supported path representation of the given path. More...
uint32_t	amxd_path_get_depth (const amxd_path_t *const path)
	Calculates the depth of the path. More...
static amxd_path_type_t	amxd_path_get_type (amxd_path_t *path)
	Returns the path type. More...
static bool	amxd_path_is_valid (amxd_path_t *path)
	Checks if the path is valid path. More...
static bool	amxd_path_is_search_path (amxd_path_t *path)
	Checks if the path is a search path. More...
static bool	amxd_path_is_supported_path (amxd_path_t *path)
	Checks if the path is in the supported data model. More...
static bool	amxd_path_is_object_path (amxd_path_t *path)
	Checks if the path is an object path. More...
bool	amxd_path_is_instance_path (const amxd_path_t *const path)
	Checks if the path is in the instantiated data model. More...
char *	amxd_path_get_param_path (amxd_path_t *path)
	Get the full parameter path from the provided amxd_path_t struct. More...

Detailed Description

Ambiorix path API header file.

Definition in file amxd_path.h.