oyCMMapiFilter_s Struct Reference

the module API 4,6,7 interface base More...

#include <oyCMMapiFilter_s.h>

Inheritance diagram for oyCMMapiFilter_s:

Collaboration diagram for oyCMMapiFilter_s:

Public Member Functions
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 oyCMMapi_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyStruct_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release

Additional Inherited Members
Public Types inherited from oyCMMapi_s
typedef int(*	oyCMMInit_f )(oyStruct_s *filter)
	optional CMM init function
typedef int(*	oyCMMMessageFuncSet_f )(oyMessage_f message_func)
	optionaly sets a CMM message function
typedef int(*	oyCMMCanHandle_f )(oyCMMQUERY_e type, uint32_t value)
	CMM feature declaration function.
typedef int(*	oyCMMOptions_Check_f )(oyOptions_s *validate)
	a function to check options

Detailed Description

the module API 4,6,7 interface base

Member Function Documentation

OYAPI oyCMMapiFilter_s *OYEXPORT oyCMMapiFilter_Copy	(	oyCMMapiFilter_s *	cmmapifilter,
		oyObject_s	object
	)

copy or reference a CMMapiFilter object

Function oyCMMapiFilter_Copy

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

Parameters

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

References oyOBJECT_CMM_API_FILTER_S.

int oyCMMapiFilter_Copy__Members	(	oyCMMapiFilter_s_ *	dst,
		oyCMMapiFilter_s_ *	src
	)

Custom CMMapiFilter copy constructor.

Function oyCMMapiFilter_Copy__Members

int oyCMMapiFilter_Init__Members

(

oyCMMapiFilter_s_ *

cmmapifilter

)

Custom CMMapiFilter constructor.

Function oyCMMapiFilter_Init__Members

OYAPI oyCMMapiFilter_s *OYEXPORT oyCMMapiFilter_New

(

oyObject_s

object

)

allocate a new CMMapiFilter object

Function oyCMMapiFilter_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMapiFilter_Release

(

oyCMMapiFilter_s **

cmmapifilter

)

release and possibly deallocate a oyCMMapiFilter_s object

Function oyCMMapiFilter_Release

Parameters

[in,out]

cmmapifilter

CMMapiFilter struct object

References oyOBJECT_CMM_API_FILTER_S.

void oyCMMapiFilter_Release__Members

(

oyCMMapiFilter_s_ *

cmmapifilter

)

Custom CMMapiFilter destructor.

Function oyCMMapiFilter_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMapiFilter_s::copy

copy function

oyStruct_Release_f oyCMMapiFilter_s::release

release function

Referenced by oyConfig_s::oyConfig_DomainRank().