oyCMMapi8_s Struct Reference

Configuration handler. More...

#include <oyCMMapi8_s.h>

Inheritance diagram for oyCMMapi8_s:

Collaboration diagram for oyCMMapi8_s:

Public Types
typedef int(*	oyConfigs_FromPattern_f )(const char *registration, oyOptions_s *options, oyConfigs_s **configs)
	return available configurations
typedef int(*	oyConfigs_Modify_f )(oyConfigs_s *configs, oyOptions_s *options)
	enrich/manipulate existing configurations
typedef int(*	oyConfig_Rank_f )(oyConfig_s *config)
	check for correctness

Public Member Functions
OYAPI oyCMMapi8_s *OYEXPORT	oyCMMapi8_New (oyObject_s object)
	allocate a new CMMapi8 object
OYAPI oyCMMapi8_s *OYEXPORT	oyCMMapi8_Copy (oyCMMapi8_s *cmmapi8, oyObject_s object)
	copy or reference a CMMapi8 object
OYAPI int OYEXPORT	oyCMMapi8_Release (oyCMMapi8_s **cmmapi8)
	release and possibly deallocate a oyCMMapi8_s object
void	oyCMMapi8_Release__Members (oyCMMapi8_s_ *cmmapi8)
	Custom CMMapi8 destructor.
int	oyCMMapi8_Init__Members (oyCMMapi8_s_ *cmmapi8)
	Custom CMMapi8 constructor.
int	oyCMMapi8_Copy__Members (oyCMMapi8_s_ *dst, oyCMMapi8_s_ *src)
	Custom CMMapi8 copy constructor.
Public Member Functions inherited from oyCMMapiFilter_s
OYAPI oyCMMapiFilter_s *OYEXPORT	oyCMMapiFilter_New (oyObject_s object)
	allocate a new CMMapiFilter object
OYAPI oyCMMapiFilter_s *OYEXPORT	oyCMMapiFilter_Copy (oyCMMapiFilter_s *cmmapifilter, oyObject_s object)
	copy or reference a CMMapiFilter object
OYAPI int OYEXPORT	oyCMMapiFilter_Release (oyCMMapiFilter_s **cmmapifilter)
	release and possibly deallocate a oyCMMapiFilter_s object
void	oyCMMapiFilter_Release__Members (oyCMMapiFilter_s_ *cmmapifilter)
	Custom CMMapiFilter destructor.
int	oyCMMapiFilter_Init__Members (oyCMMapiFilter_s_ *cmmapifilter)
	Custom CMMapiFilter constructor.
int	oyCMMapiFilter_Copy__Members (oyCMMapiFilter_s_ *dst, oyCMMapiFilter_s_ *src)
	Custom CMMapiFilter copy constructor.
Public Member Functions inherited from oyCMMapi_s
OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_New (oyObject_s object)
	allocate a new CMMapi object
OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_Copy (oyCMMapi_s *cmmapi, oyObject_s object)
	copy or reference a CMMapi object
OYAPI int OYEXPORT	oyCMMapi_Release (oyCMMapi_s **cmmapi)
	release and possibly deallocate a oyCMMapi_s object
void	oyCMMapi_Release__Members (oyCMMapi_s_ *cmmapi)
	Custom CMMapi destructor.
int	oyCMMapi_Init__Members (oyCMMapi_s_ *cmmapi)
	Custom CMMapi constructor.
int	oyCMMapi_Copy__Members (oyCMMapi_s_ *dst, oyCMMapi_s_ *src)
	Custom CMMapi copy constructor.
Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get a text dump

Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyCMMapiFilter_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyCMMapi_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyStruct_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release

Detailed Description

Configuration handler.

Member Function Documentation

OYAPI oyCMMapi8_s *OYEXPORT oyCMMapi8_Copy	(	oyCMMapi8_s *	cmmapi8,
		oyObject_s	object
	)

copy or reference a CMMapi8 object

Function oyCMMapi8_Copy

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

Parameters

[in]	cmmapi8	CMMapi8 struct object
	object	NULL - means reference, the optional object triffers a real copy

References oyOBJECT_CMM_API8_S.

int oyCMMapi8_Copy__Members	(	oyCMMapi8_s_ *	dst,
		oyCMMapi8_s_ *	src
	)

Custom CMMapi8 copy constructor.

Function oyCMMapi8_Copy__Members

int oyCMMapi8_Init__Members

(

oyCMMapi8_s_ *

cmmapi8

)

Custom CMMapi8 constructor.

Function oyCMMapi8_Init__Members

OYAPI oyCMMapi8_s *OYEXPORT oyCMMapi8_New

(

oyObject_s

object

)

allocate a new CMMapi8 object

Function oyCMMapi8_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMapi8_Release

(

oyCMMapi8_s **

cmmapi8

)

release and possibly deallocate a oyCMMapi8_s object

Function oyCMMapi8_Release

Parameters

[in,out]

cmmapi8

CMMapi8 struct object

References oyOBJECT_CMM_API8_S.

void oyCMMapi8_Release__Members

(

oyCMMapi8_s_ *

cmmapi8

)

Custom CMMapi8 destructor.

Function oyCMMapi8_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMapi8_s::copy

copy function

oyStruct_Release_f oyCMMapi8_s::release

release function