oyCMMapi9_s Struct Reference

graph policies More...

#include <oyranos_cmm.h>

Inheritance diagram for oyCMMapi9_s:

Collaboration diagram for oyCMMapi9_s:

Public Types
typedef int(*	oyConversion_Correct_f )(oyConversion_s *conversion, uint32_t flags, oyOptions_s *options)
	check for correctly adhering to policies

Data Fields
oyOBJECT_e	type
oyStruct_Copy_f	copy
oyStruct_Release_f	release
oyCMMapi_s *	next
oyCMMInit_f	oyCMMInit
oyCMMMessageFuncSet_f	oyCMMMessageFuncSet
char *	registration
int32_t	version [3]
int32_t	module_api [3]
oyCMMFilter_ValidateOptions_f	oyCMMFilter_ValidateOptions
oyWidgetEvent_f	oyWidget_Event
const char *	options
oyCMMuiGet_f	oyCMMuiGet
oyCMMobjectType_s **	object_types
oyCMMGetText_f	getText
const char **	texts
oyConversion_Correct_f	oyConversion_Correct
const char *	pattern
Data Fields inherited from oyCMMapiFilter_s
Data Fields inherited from oyCMMapi_s
oyPointer	dummya
oyPointer	dummyb
oyPointer	dummyc

---

Detailed Description

graph policies

The user visible Oyranos settings are subject to be applied to graphs. This module type provides an interface to check and verified a graph according to arbitrary policies in a automated fashion. The usage of graph policy modules is optional and can be controled by the front end function oyConversion_Correct().

The policy check can cover options and data checks. Graph analysis and correction is possible as well.

Differences to native node modules are that, a policy module runs before the graph starts data processing, it can provide options for a group of node modules including a UI and provide additional object types.

Version:

Oyranos: 0.1.10

Since:

2009/07/23 (Oyranos: 0.1.10)

Date:

2009/09/14

---

Field Documentation

oyStruct_Copy_f oyCMMapi9_s::copy

copy function

Reimplemented from oyCMMapiFilter_s.

oyCMMGetText_f oyCMMapi9_s::getText

describe selectors in UI

int32_t oyCMMapi9_s::module_api[3]

0: last major Oyranos version during development time, e.g. 0 1: last minor Oyranos version during development time, e.g. 0 2: last Oyranos patch version during development time, e.g. 10

Reimplemented from oyCMMapiFilter_s.

oyCMMapi_s* oyCMMapi9_s::next

the next CMM api

Reimplemented from oyCMMapiFilter_s.

oyCMMobjectType_s** oyCMMapi9_s::object_types

zero terminated list of types

const char* oyCMMapi9_s::options

default options

oyCMMFilter_ValidateOptions_f oyCMMapi9_s::oyCMMFilter_ValidateOptions

check options for validy and correct

oyCMMInit_f oyCMMapi9_s::oyCMMInit

Reimplemented from oyCMMapiFilter_s.

oyCMMMessageFuncSet_f oyCMMapi9_s::oyCMMMessageFuncSet

Reimplemented from oyCMMapiFilter_s.

oyCMMuiGet_f oyCMMapi9_s::oyCMMuiGet

xml ui elements for filter options XML namespace to describe the used data_types e.g. 'oy="http://www.oyranos.org/2009/oyranos"'

Referenced by oyFilterNode_s::oyFilterNode_UiGet().

oyConversion_Correct_f oyCMMapi9_s::oyConversion_Correct

check a graph

Referenced by oyConversion_s::oyConversion_Correct().

oyWidgetEvent_f oyCMMapi9_s::oyWidget_Event

handle widget events

const char* oyCMMapi9_s::pattern

registration pattern which are supported by oyConversion_Correct

e.g. for imaging this could be "//imaging"

Referenced by oyConversion_s::oyConversion_Correct(), and oyFilterNode_s::oyFilterNode_UiGet().

char* oyCMMapi9_s::registration

The oyFILTER_REG_APPLICATION of "config" is obligatory. e.g. "shared/freedesktop.org/imaging/config.scanner.sane" or "shared/freedesktop.org/imaging/config.monitor.xorg" ...
see as well Registration

Reimplemented from oyCMMapiFilter_s.

Referenced by oyConversion_s::oyConversion_Correct(), and oyFilterNode_s::oyFilterNode_UiGet().

oyStruct_Release_f oyCMMapi9_s::release

release function

Reimplemented from oyCMMapiFilter_s.

Referenced by oyConversion_s::oyConversion_Correct(), and oyFilterNode_s::oyFilterNode_UiGet().

const char** oyCMMapi9_s::texts

zero terminated categories for getText, e.g. {"///GPU","///CPU","//colour",0}

oyOBJECT_e oyCMMapi9_s::type

struct type oyOBJECT_CMM_API9_S

Reimplemented from oyCMMapiFilter_s.

int32_t oyCMMapi9_s::version[3]

0: major - should be stable for the live time of a module,
1: minor - mark new features,
2: patch version - correct errors

Reimplemented from oyCMMapiFilter_s.