Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structures | Macros | Functions
afw_object_meta.h File Reference

afw_object Interface meta helpers. More...

#include "afw_interface.h"

Go to the source code of this file.

Data Structures

struct  afw_object_meta_object_s
 

Macros

#define afw_object_meta_object(instance)    (const afw_object_t *)((instance)->meta.meta_object)
 Return meta object for an object or NULL if there is not one. More...
 
#define afw_object_meta_add_error_z(instance, message_z, xctx)
 Add a null terminated error message to instance's meta. More...
 
#define afw_object_meta_add_error_fz(instance, xctx, format_z, ...)
 Add a formatted error message to instance's meta. More...
 
#define afw_object_meta_add_property_error_z(instance, property_name, message_z, xctx)
 Add a null terminate error message for a property to instance's meta. More...
 
#define afw_object_meta_add_property_error_fz(instance, property_name, xctx, format_z, ...)
 Add a formatted error message for a property to instance's meta. More...
 
#define afw_object_meta_get_property(instance, property_name, xctx)
 Get a meta property. More...
 
#define afw_object_meta_get_property_as_string(instance, property_name, xctx)
 Get a meta property as single string. More...
 
#define afw_object_meta_get_embedding_object(instance, xctx)   ((instance)->embedding_object)
 Get entity object's embedding object. More...
 
#define afw_object_meta_get_object_type_id(instance, xctx)
 Get object's object_type_id. More...
 
#define afw_object_meta_set_property(instance, property_name, value, xctx)
 Set a property in the meta of an object. More...
 
#define afw_object_meta_set_property_from_utf8_z(instance, property_name, string_z, xctx)
 Set a string property in the meta of an object from utf8_z. More...
 
#define afw_object_meta_set_property_as(instance, property_name, data_type, value, xctx)
 Set a property in the meta of an object as a value and data type. More...
 
#define afw_object_meta_set_property_type_property(instance, property_name, property_type_property_name, value, xctx)
 Set a property type property for a property in the meta of an object. More...
 
#define afw_object_meta_set_property_type_property_from_utf8_z(instance, property_name, property_type_property_name, string_z, xctx)
 Set a property type string property for a property in the meta of an object from utf8_z. More...
 
#define afw_object_meta_set_property_type_property_as(instance, property_name, property_type_property_name, data_type, value, xctx)
 Set a property type property for a property in the meta of an object as a value and data type. More...
 

Functions

void afw_object_meta_add_error (const afw_object_t *instance, const afw_utf8_t *message, afw_xctx_t *xctx)
 Add an error message to instance's meta. More...
 
void afw_object_meta_add_needed_object_type (const afw_object_t *instance, const afw_object_t *object_type, afw_xctx_t *xctx)
 Add a needed object type object. More...
 
void afw_object_meta_add_thrown_error (const afw_object_t *instance, const afw_error_t *error, afw_xctx_t *xctx)
 Add a thrown error to instance's meta. More...
 
void afw_object_meta_add_property_error (const afw_object_t *instance, const afw_utf8_t *property_name, const afw_utf8_t *message, afw_xctx_t *xctx)
 Add an error message for a property to instance's meta. More...
 
void afw_object_meta_add_thrown_property_error (const afw_object_t *instance, const afw_utf8_t *property_name, afw_integer_t index, const afw_error_t *error, afw_xctx_t *xctx)
 Add a thrown error for a property to instance's meta. More...
 
afw_boolean_t afw_object_meta_has_errors (const afw_object_t *instance, afw_xctx_t *xctx)
 Check if object flagged for errors. More...
 
void afw_object_meta_log_errors (const afw_object_t *instance, const afw_utf8_t *source_location, afw_xctx_t *xctx)
 Log meta errors. More...
 
const afw_object_tafw_object_meta_create_accessor_with_options (const afw_object_t *instance, const afw_object_options_t *options, const afw_pool_t *p, afw_xctx_t *xctx)
 Create an object instance to access an object's meta with options. More...
 
const afw_object_meta_object_tafw_object_meta_get_nonempty_meta_object (const afw_object_t *instance, afw_xctx_t *xctx)
 Return meta object for an object creating an empty one if needed. More...
 
const afw_object_tafw_object_meta_get_nonempty_delta (const afw_object_t *instance, afw_xctx_t *xctx)
 Return meta delta object for an object creating an empty one if needed. More...
 
const afw_utf8_tafw_object_meta_get_object_id (const afw_object_t *instance, afw_xctx_t *xctx)
 Get entity object's object id. More...
 
const afw_utf8_tafw_object_meta_get_property_name (const afw_object_t *instance, afw_xctx_t *xctx)
 Get object's property name in embedding object. More...
 
const afw_value_string_tafw_object_meta_get_object_id_value (const afw_object_t *instance, afw_xctx_t *xctx)
 Get entity object's object id value. More...
 
void afw_object_meta_add_parent_path (const afw_object_t *instance, const afw_utf8_t *parent_path, afw_xctx_t *xctx)
 Add a parent path to instance's meta. More...
 
const afw_value_list_tafw_object_meta_get_parent_paths_value (const afw_object_t *instance, afw_xctx_t *xctx)
 Get meta parentPaths property value. More...
 
const afw_utf8_tafw_object_meta_get_path (const afw_object_t *instance, afw_xctx_t *xctx)
 Get an object's path. More...
 
const afw_object_tafw_object_meta_get_property_type (const afw_object_t *instance, const afw_utf8_t *property_name, afw_xctx_t *xctx)
 Get the property type object for an object's property from the meta of an object, creating it if needed. More...
 
 afw_object_meta_set_meta_object (const afw_object_t *instance, const afw_object_t *meta, afw_xctx_t *xctx)
 Set an object's meta from a meta object. More...
 
const afw_object_tafw_object_meta_set_empty (const afw_object_t *instance, afw_xctx_t *xctx)
 Create and set object's meta to an empty object and return delta. More...
 
void afw_object_meta_set_ids (const afw_object_t *instance, const afw_utf8_t *adaptor_id, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, afw_xctx_t *xctx)
 Set object's ids. More...
 
void afw_object_meta_set_ids_using_path (const afw_object_t *instance, const afw_utf8_t *path, afw_xctx_t *xctx)
 Set object's ids using path. More...
 
void afw_object_meta_set_read_only (const afw_object_t *instance, afw_xctx_t *xctx)
 Set object's meta to indicate object is read-only. More...
 
void afw_object_meta_set_object_type (const afw_object_t *instance, const afw_object_type_t *object_type, afw_xctx_t *xctx)
 Set object's object type id. More...
 
void afw_object_meta_set_object_type_id (const afw_object_t *instance, const afw_utf8_t *object_type_id, afw_xctx_t *xctx)
 Set object's object type id. More...
 
void afw_object_meta_set_parent_paths (const afw_object_t *instance, const afw_value_list_t *parent_paths, afw_xctx_t *xctx)
 Set meta parentPaths property. More...
 
void afw_object_meta_clone_and_set (const afw_object_t *instance, const afw_object_t *from, afw_xctx_t *xctx)
 Set object's meta using a clone of the meta of another object. More...
 

Detailed Description

afw_object Interface meta helpers.

Definition in file afw_object_meta.h.