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

Header file for Adaptive Framework object processing options. More...

#include "afw_interface.h"

Go to the source code of this file.

Data Structures

struct  afw_object_options_s
 Struct for object processing options. More...
 

Macros

#define AFW_OBJECT_OPTION_checkRequired   (1 << 0)
 Indicates that object should checked for missing required properties. More...
 
#define AFW_OBJECT_OPTION_composite   (1 << 1)
 Include all inherited properties. More...
 
#define AFW_OBJECT_OPTION_includeDefaultValues   (1 << 3)
 Indicates that object should include default property values. More...
 
#define AFW_OBJECT_OPTION_includeDescendentObjectTypes   (1 << 4)
 Include objects with descendent object types on retrieve. More...
 
#define AFW_OBJECT_OPTION_inheritedFrom   (1 << 5)
 Include inheritedFrom property for all inherited properties. More...
 
#define AFW_OBJECT_OPTION_integersAsString   (1 << 6)
 Cause all data type integer values to be converted to string. More...
 
#define AFW_OBJECT_OPTION_largeIntegersAsString   (1 << 7)
 Cause all large data type integer values to be converted to string. More...
 
#define AFW_OBJECT_OPTION_metaFull   (1 << 8)
 Include full meta. More...
 
#define AFW_OBJECT_OPTION_metaLimited   (1 << 9)
 Include only requested meta. More...
 
#define AFW_OBJECT_OPTION_normalize   (1 << 10)
 Indicates that object should be normalized based on object type. More...
 
#define AFW_OBJECT_OPTION_objectId   (1 << 11)
 Include meta objectId for entity objects. More...
 
#define AFW_OBJECT_OPTION_objectType   (1 << 12)
 Include meta objectType (object id of adaptive object type). More...
 
#define AFW_OBJECT_OPTION_objectTypes   (1 << 13)
 Include meta objectTypes. More...
 
#define AFW_OBJECT_OPTION_path   (1 << 14)
 Include meta path for entity objects. More...
 
#define AFW_OBJECT_OPTION_pathEmbedded   (1 << 15)
 Include meta path for embedded objects. More...
 
#define AFW_OBJECT_OPTION_reconcilable   (1 << 16)
 Include meta reconcilable to entity's meta. More...
 
#define AFW_OBJECT_OPTION_resolvedParentPaths   (1 << 17)
 Include meta resolvedParentPaths for all objects. More...
 
#define AFW_OBJECT_OPTION_typedValues   (1 << 18)
 Indicates that each value should include type information. More...
 
#define AFW_OBJECT_OPTION_whitespace   (1 << 19)
 Indicates content type should include whitespace characters. More...
 
#define AFW_OBJECT_OPTION_IS(_options, _option)   ((_options) && (((((_options)->mask) & (AFW_OBJECT_OPTION_ ## _option))) != 0))
 Test mask.
 
#define AFW_OBJECT_OPTION_SET_ON(_options, _option)    (_options)->mask |= AFW_OBJECT_OPTION_ ## _option
 Set option on.
 
#define AFW_OBJECT_OPTION_SET_OFF(_options, _option)    (_options)->mask &= ~(AFW_OBJECT_OPTION_ ## _option)
 Set option off.
 
#define AFW_OBJECT_OPTION_SET(_options, _option, _bool_value)
 Set option. More...
 

Functions

const afw_object_options_tafw_object_options_set_from_object (const afw_object_options_t *initial_options, const afw_object_t *options_object, const afw_pool_t *p, afw_xctx_t *xctx)
 Set object processing options from options object. More...
 
const afw_object_options_tafw_object_options_create (const afw_object_options_t *initial_options, const afw_object_options_t *options, const afw_pool_t *p, afw_xctx_t *xctx)
 Create a options. More...
 

Variables

 afw_object_options_none
 Object processing options - no options set.
 
 afw_object_options_objectType
 Object processing options - objectType.
 
 afw_object_options_composite
 Object processing options - composite only.
 
 afw_object_options_composite_normalize_defaults_required
 
 afw_object_options_composite_and_defaults
 Object processing options - composite only and defaults.
 
 afw_object_options_essential
 Object processing options - metaLimited.
 
 afw_object_options_essential_with_whitespace
 Object processing options - metaLimited + whitespace.
 
 afw_object_options_reconcilable_meta_property
 Object processing options to produce reconcilable meta property.
 
 afw_object_options_composite_inheritedFrom_resolvedParentPaths
 Object processing options - composite + inheritance related.
 
 afw_object_options_whitespace
 Whitespace only.
 

Detailed Description

Header file for Adaptive Framework object processing options.

Definition in file afw_object_options.h.