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...

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)

Member Function Documentation

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

Returns

the text

Version

Oyranos: 0.1.10

Since

2009/09/14 (Oyranos: 0.1.10)

Date

2009/09/15

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

Field Documentation

copy

oyStruct_Copy_f oyStruct_s::copy

Copy function.

Referenced by oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_SetData(), oyFilterSocket_s::oyFilterSocket_SetData(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType(), oyPixelAccess_s::oyPixelAccess_SetUserData(), and oyStructList_s::oyStructList_CopyFrom().

oy_

oyObject_s oyStruct_s::oy_

Oyranos internal object.

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

Referenced by oyStruct_Allocate(), oyObserver_s::oyStruct_DisableSignalSend(), oyObserver_s::oyStruct_EnableSignalSend(), oyObserver_s::oyStruct_IsObserved(), and oyStructList_s::oyStructList_GetRefType().

release

oyStruct_Release_f oyStruct_s::release

Release function.

Referenced by oyObserver_s::oyObserver_Release(), and oyStructList_s::oyStructList_GetRefType().

type_

const oyOBJECT_e oyStruct_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Referenced by oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStructList_s::oyStructList_GetRefType(), and oyStructList_s::oyStructList_GetType().