Oyranos Color Management System API - Version 0.9.6
Public Types | Public Member Functions | Data Fields
oyCMMobjectType_s Struct Reference

Custom object handler. More...

#include <oyCMMobjectType_s.h>

Inheritance diagram for oyCMMobjectType_s:
Inheritance graph
Collaboration diagram for oyCMMobjectType_s:
Collaboration graph

Public Types

typedef const char *(* oyCMMobjectGetText_f) (oyStruct_s *object, oyNAME_e type, int flags)
 build a text string from a given object More...
 
typedef oyStruct_s *(* oyCMMobjectLoadFromMem_f) (size_t buf_size, const oyPointer buf, uint32_t flags, oyObject_s object)
 load a filter object from a in memory data blob More...
 
typedef int(* oyCMMobjectScan_f) (oyPointer data, size_t size, char **registration, char **name, oyAlloc_f allocateFunc)
 load a filter object from a in memory data blob More...
 

Public Member Functions

OYAPI oyCMMobjectType_s *OYEXPORT oyCMMobjectType_New (oyObject_s object)
 allocate a new CMMobjectType object More...
 
 oyCMMobjectType_Copy
 Copy or Reference a CMMobjectType object. More...
 
OYAPI int OYEXPORT oyCMMobjectType_Release (oyCMMobjectType_s **cmmobjecttype)
 release and possibly deallocate a oyCMMobjectType_s object More...
 
void oyCMMobjectType_Release__Members (oyCMMobjectType_s_ *cmmobjecttype)
 Custom CMMobjectType destructor. More...
 
int oyCMMobjectType_Init__Members (oyCMMobjectType_s_ *cmmobjecttype)
 Custom CMMobjectType constructor. More...
 
int oyCMMobjectType_Copy__Members (oyCMMobjectType_s_ *dst, oyCMMobjectType_s_ *src)
 Custom CMMobjectType copy constructor. More...
 
- Public Member Functions inherited from oyStruct_s
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...
 
 oyStruct_RegisterStaticMessageFunc
 register a function for verbosity More...
 
 oyStruct_GetInfo
 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...
 
- Data Fields inherited from oyStruct_s
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

Custom object handler.

Member Function Documentation

oyCMMobjectType_Copy

Copy or Reference a CMMobjectType object.

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters
[in]cmmobjecttypeCMMobjectType struct object
objectNULL - means reference, the optional object triggers a real copy

Referenced by oyCMMobjectType_Copy__Members(), and oyCMMobjectType_New().

int oyCMMobjectType_Copy__Members ( oyCMMobjectType_s_ *  dst,
oyCMMobjectType_s_ *  src 
)
int oyCMMobjectType_Init__Members ( oyCMMobjectType_s_ *  cmmobjecttype)

Custom CMMobjectType constructor.

Function oyCMMobjectType_Init__Members

Referenced by oyCMMobjectType_Copy__Members().

OYAPI oyCMMobjectType_s *OYEXPORT oyCMMobjectType_New ( oyObject_s  object)

allocate a new CMMobjectType object

Function oyCMMobjectType_New

References oyCMMobjectType_Copy(), oyOBJECT_CMM_OBJECT_TYPE_S, and oyOBJECT_OBJECT_S.

Referenced by oyCMMobjectType_Copy__Members().

OYAPI int OYEXPORT oyCMMobjectType_Release ( oyCMMobjectType_s **  cmmobjecttype)

release and possibly deallocate a oyCMMobjectType_s object

Function oyCMMobjectType_Release

Parameters
[in,out]cmmobjecttypeCMMobjectType struct object

References oyOBJECT_CMM_OBJECT_TYPE_S.

Referenced by oyCMMobjectType_Copy__Members().

void oyCMMobjectType_Release__Members ( oyCMMobjectType_s_ *  cmmobjecttype)

Custom CMMobjectType destructor.

Function oyCMMobjectType_Release__Members

Referenced by oyCMMobjectType_Copy__Members().

Field Documentation

oyStruct_Copy_f oyCMMobjectType_s::copy

Copy function.

oyObject_s oyCMMobjectType_s::oy_

Oyranos internal object.

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

oyStruct_Release_f oyCMMobjectType_s::release

Release function.

const oyOBJECT_e oyCMMobjectType_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.