oyStruct_s Struct Reference

Oyranos base structure. More...

#include <oyStruct_s.h>

Inheritance diagram for oyStruct_s:

Collaboration diagram for oyStruct_s:

Public Member Functions
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...
int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...
const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...
const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
const oyOBJECT_e	type_
	Type of object. More...
oyStruct_Copy_f	copy
	Copy function. More...
oyStruct_Release_f	release
	Release function. More...
oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

Oyranos base structure.

All inherited Oyranos structures should be castable to this basic one.

Note

New templates will not be created automaticly [notemplates]

Version

Oyranos: x.x.x

Since

Oyranos: version 0.1.8

Date

1 january 2008 (API 0.1.8)

Examples:

image_display.cpp, and oyranos_cmm_oJPG.c.

Member Function Documentation

oyStruct_GetInfo()

const char * oyStruct_GetInfo	(	oyPointer	context_object,
		oyNAME_e	type,
		int	flags
	)

get a additional string from a object

Function oyStruct_GetInfo

The content can be provided by object authors by using oyStruct_RegisterStaticMessageFunc() typical at the first time of object creation.

Note: this function is a very low level version of oyStruct_GetText().

Parameters

[in]	context_object	the object to get informations about
[in]	type	request a suitable format
[in]	flags	0x01 - skip trivial struct type name

Returns

a string or NULL; The pointer might become invalid after further using the object pointed to by context.

Version

Oyranos: 0.9.6

Date

2016/04/18

Since

2011/01/15 (Oyranos: 0.2.1)

oyStruct_GetText()

const char * oyStruct_GetText	(	oyStruct_s *	obj,
		oyNAME_e	name_type,
		uint32_t	flags
	)

Get a text dump.

Function oyStruct_GetText

Ask the object type module for text informations.

Parameters

obj	the object
name_type	the text type
flags	0: get object infos 1: get object type infos 2: skip object type infos

Returns

the text

Version

Oyranos: 0.9.6

Date

2016/04/18

Since

2009/09/14 (Oyranos: 0.1.10)

oyStruct_GetTextFromModule()

const char * oyStruct_GetTextFromModule	(	oyStruct_s *	obj,
		oyNAME_e	name_type,
		uint32_t	flags
	)

get object infos from a module

Parameters

[in,out]	obj	the objects structure
[in]	name_type	the type
[in]	flags

See also

oyStruct_GetText

Returns

the text

Version

Oyranos: 0.3.3

Since

2009/09/15 (Oyranos: 0.3.3)

Date

2011/10/31

oyStruct_RegisterStaticMessageFunc()

int oyStruct_RegisterStaticMessageFunc	(	int	type,
		oyStruct_RegisterStaticMessageFunc_f	msg,
		oyStruct_RegisterStaticFreeFunc_f	free_func
	)

register a function for verbosity

Function oyStruct_RegisterStaticMessageFunc

Hint: for custom object types, you should use a type of above oyOBJECT_MAX

Parameters

[in]	type	the object oyOBJECT_e type id; keep lower than oyOBJECT_MAX_CUSTOM, as this number; oyStruct_s derived objects shall be lower than oyOBJECT_MAX_STRUCT will allocate a array of that length
[in]	f	the object string function; A custom type should consider to add oyNAME_NICK : one word object name, e.g. "myIdCustom_s" oyNAME_JSON+2 : ' ' space separated list of child object id's from oyObject_s::id_ Internal defined types below oyOBJECT_MAX handle type enums by internal functions.
[in]	object_type_init_var	the object type initialisation variable address

Returns

0 - success; >= 1 - error

Version

Oyranos: 0.9.7

Date

2019/10/14

Since

2011/01/14

oyStructTypeToText()

const char * oyStructTypeToText

(

oyOBJECT_e

type

)

Objects type to small string.

Function oyStructTypeToText

Give a basic description of inbuild object types.

Version

Oyranos: 0.5.0

Since

2008/06/24 (Oyranos: 0.1.8)

Date

2012/09/05

Referenced by oyObject_GetId(), and oyObject_UnRef().

Field Documentation

copy

oyStruct_Copy_f oyStruct_s::copy

Copy function.

oy_

oyObject_s oyStruct_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

Referenced by oyPointer_s::oyPointer_LookUpFromObject(), oyObserver_s::oyStruct_ObserverRemove(), and oyStructList_s::oyStructList_GetRefType().

release

oyStruct_Release_f oyStruct_s::release

Release function.

Referenced by oyStructList_s::oyStructList_GetRefType(), and oyValue_u::oyValueClear().

type_

const oyOBJECT_e oyStruct_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Examples:

image_display.cpp.

Referenced by oyDeviceCMMInit(), oyDeviceCMMReset(), oyObject_GetId(), oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), and oyStructList_s::oyStructList_GetRefType().