Model

Files
file	afw_model.h
	Header file for Adaptive Framework model support.
file	afw_model_location.h
	Header file for Adaptive Framework model location.

Data Structures
struct	afw_model_location_s
	Struct used by adaptor referenced by modelLocationAdaptorId. More...

Typedefs
typedef enum afw_model_adapt_e	afw_model_adapt_t
	Typedef for model adapt type enum.

Enumerations
enum	afw_model_adapt_e { afw_model_adapt_to_adaptor , afw_model_adapt_from_adaptor , afw_model_adapt_to_requestor , afw_model_adapt_from_requestor }
	Typedef for model adapt type enum.

Functions
const afw_adaptor_t *	afw_model_adaptor_create_cede_p (const afw_object_t *properties, const afw_pool_t *p, afw_xctx_t *xctx)
	Create a model adaptor. More...
afw_model_t *	afw_model_compile (const afw_utf8_t *adaptor_id, const afw_object_t *model_object, const afw_pool_t *p, afw_xctx_t *xctx)
	Compile a model and add object types to associative array. More...
const afw_model_object_type_t *	afw_model_get_object_type (const afw_model_t *model, const afw_utf8_t *object_type_id, afw_xctx_t *xctx)
	Get the model object type for an object type id from model. More...
const afw_model_location_t *	afw_model_location_create (const afw_adaptor_t *adaptor, const afw_pool_t *p, afw_xctx_t *xctx)
const afw_model_t *	afw_model_location_get_model (const afw_adaptor_t *model_location_adaptor, const afw_utf8_t *model_id, afw_xctx_t *xctx)

Variables
	afw_adaptor_factory_model

Detailed Description

Model API.

Function Documentation

afw_model_adaptor_create_cede_p()

const afw_adaptor_t* afw_model_adaptor_create_cede_p	(	const afw_object_t *	properties,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Create a model adaptor.

Parameters

properties	configuration.
p	to use for adaptor resources.
xctx	The execution context (xctx) adaptor will use.

Returns

New instance of model adaptor.

Todo:

FIXME: Load modelId

Definition at line 764 of file afw_model_adaptor.c.

afw_model_compile()

afw_model_t* afw_model_compile	(	const afw_utf8_t *	adaptor_id,
		const afw_object_t *	model_object,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Compile a model and add object types to associative array.

Parameters

adaptor_id	to use for object type paths.
model_object.
p	to use.
xctx	of caller.

Returns

model.

Definition at line 781 of file afw_model_compile.c.

afw_model_get_object_type()

const afw_model_object_type_t* afw_model_get_object_type	(	const afw_model_t *	model,
		const afw_utf8_t *	object_type_id,
		afw_xctx_t *	xctx
	)

Get the model object type for an object type id from model.

Parameters

model
object_type_id
xctx	of caller.

Returns

afw_model_object_type_t or NULL if not found.

Definition at line 21 of file afw_model.c.

Variable Documentation

afw_adaptor_factory_model

afw_adaptor_factory_model

Model adaptor factory instance.

Definition at line 33 of file afw_model.h.