![]() |
Oyranos Color Management System API |
A CMMapis list. More...
#include <oyCMMapis_s.h>
Public Member Functions | |
OYAPI oyCMMapis_s *OYEXPORT | oyCMMapis_New (oyObject_s object) |
allocate a new CMMapis object More... | |
OYAPI oyCMMapis_s *OYEXPORT | oyCMMapis_Copy (oyCMMapis_s *cmmapis, oyObject_s object) |
copy or reference a CMMapis object More... | |
OYAPI int OYEXPORT | oyCMMapis_Release (oyCMMapis_s **cmmapis) |
release and possibly deallocate a oyCMMapis_s object More... | |
OYAPI int OYEXPORT | oyCMMapis_MoveIn (oyCMMapis_s *list, oyCMMapi_s **obj, int pos) |
add an element to a CMMapis list More... | |
OYAPI int OYEXPORT | oyCMMapis_ReleaseAt (oyCMMapis_s *list, int pos) |
release a element from a CMMapis list More... | |
OYAPI oyCMMapi_s *OYEXPORT | oyCMMapis_Get (oyCMMapis_s *list, int pos) |
get a element of a CMMapis list More... | |
OYAPI int OYEXPORT | oyCMMapis_Count (oyCMMapis_s *list) |
count the elements in a CMMapis list More... | |
OYAPI int OYEXPORT | oyCMMapis_Clear (oyCMMapis_s *list) |
clear the elements in a CMMapis list More... | |
OYAPI int OYEXPORT | oyCMMapis_Sort (oyCMMapis_s *list, int32_t *rank_list) |
sort a list according to a rank_list More... | |
void | oyCMMapis_Release__Members (oyCMMapis_s_ *cmmapis) |
Custom CMMapis destructor. More... | |
int | oyCMMapis_Init__Members (oyCMMapis_s_ *cmmapis) |
Custom CMMapis constructor. More... | |
int | oyCMMapis_Copy__Members (oyCMMapis_s_ *dst, oyCMMapis_s_ *src) |
Custom CMMapis copy constructor. More... | |
![]() | |
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... | |
![]() | |
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... | |
A CMMapis list.
OYAPI int OYEXPORT oyCMMapis_Clear | ( | oyCMMapis_s * | list | ) |
clear the elements in a CMMapis list
Function oyCMMapis_Clear
[in,out] | list | the list |
References oyOBJECT_CMM_APIS_S, and oyStructList_s::oyStructList_Clear().
OYAPI oyCMMapis_s *OYEXPORT oyCMMapis_Copy | ( | oyCMMapis_s * | cmmapis, |
oyObject_s | object | ||
) |
copy or reference a CMMapis object
Function oyCMMapis_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | cmmapis | CMMapis struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_CMM_APIS_S.
Referenced by oyCMMapis_Copy__Members().
int oyCMMapis_Copy__Members | ( | oyCMMapis_s_ * | dst, |
oyCMMapis_s_ * | src | ||
) |
Custom CMMapis copy constructor.
Function oyCMMapis_Copy__Members
References oyCMMapis_Copy(), oyCMMapis_Init__Members(), oyCMMapis_New(), oyCMMapis_Release(), oyCMMapis_Release__Members(), oyOBJECT_CMM_APIS_S, oyObject_s::oyObject_Copy(), oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_Release(), oyObject_s::oyObject_SetParent(), oyObject_s::oyObject_UnRef(), oyStructList_s::oyStructList_Copy(), oyStructList_s::oyStructList_Create(), oyStructList_s::oyStructList_Release(), and release.
OYAPI int OYEXPORT oyCMMapis_Count | ( | oyCMMapis_s * | list | ) |
count the elements in a CMMapis list
Function oyCMMapis_Count
[in,out] | list | the list |
References oyOBJECT_CMM_APIS_S, and oyStructList_s::oyStructList_Count().
OYAPI oyCMMapi_s *OYEXPORT oyCMMapis_Get | ( | oyCMMapis_s * | list, |
int | pos | ||
) |
get a element of a CMMapis list
Function oyCMMapis_Get
[in,out] | list | the list |
pos | position |
References oyOBJECT_CMM_APIS_S, and oyStructList_s::oyStructList_GetRef().
int oyCMMapis_Init__Members | ( | oyCMMapis_s_ * | cmmapis | ) |
Custom CMMapis constructor.
Function oyCMMapis_Init__Members
Referenced by oyCMMapis_Copy__Members().
OYAPI int OYEXPORT oyCMMapis_MoveIn | ( | oyCMMapis_s * | list, |
oyCMMapi_s ** | obj, | ||
int | pos | ||
) |
add an element to a CMMapis list
Function oyCMMapis_MoveIn
[in] | list | list |
[in,out] | obj | list element |
pos | position |
References oyOBJECT_CMM_API1_S, oyOBJECT_CMM_API_MAX, oyOBJECT_CMM_APIS_S, oyStructList_s::oyStructList_Create(), oyStructList_s::oyStructList_MoveIn(), and oyCMMapi_s::type_.
OYAPI oyCMMapis_s *OYEXPORT oyCMMapis_New | ( | oyObject_s | object | ) |
allocate a new CMMapis object
Function oyCMMapis_New
References oyOBJECT_OBJECT_S.
Referenced by oyCMMapis_Copy__Members().
OYAPI int OYEXPORT oyCMMapis_Release | ( | oyCMMapis_s ** | cmmapis | ) |
release and possibly deallocate a oyCMMapis_s object
Function oyCMMapis_Release
[in,out] | cmmapis | CMMapis struct object |
References oyOBJECT_CMM_APIS_S.
Referenced by oyCMMapis_Copy__Members().
void oyCMMapis_Release__Members | ( | oyCMMapis_s_ * | cmmapis | ) |
Custom CMMapis destructor.
Function oyCMMapis_Release__Members
Referenced by oyCMMapis_Copy__Members().
OYAPI int OYEXPORT oyCMMapis_ReleaseAt | ( | oyCMMapis_s * | list, |
int | pos | ||
) |
release a element from a CMMapis list
Function oyCMMapis_ReleaseAt
[in,out] | list | the list |
pos | position |
References oyOBJECT_CMM_APIS_S, oyStructList_s::oyStructList_GetParentObjType(), and oyStructList_s::oyStructList_ReleaseAt().
OYAPI int OYEXPORT oyCMMapis_Sort | ( | oyCMMapis_s * | list, |
int32_t * | rank_list | ||
) |
sort a list according to a rank_list
Function oyCMMapis_Sort
References oyOBJECT_CMM_APIS_S, and oyStructList_s::oyStructList_Sort().
oyStruct_Copy_f oyCMMapis_s::copy |
Copy function.
oyObject_s oyCMMapis_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMapis_s::release |
Release function.
Referenced by oyCMMapis_Copy__Members().
const oyOBJECT_e oyCMMapis_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.