oyList_s Struct Reference

a pointer list More...

#include <oyList_s.h>

Inheritance diagram for oyList_s:

Collaboration diagram for oyList_s:

Public Member Functions
OYAPI oyList_s *OYEXPORT	oyList_New (oyObject_s object)
	allocate a new List object More...
OYAPI oyList_s *OYEXPORT	oyList_Copy (oyList_s *list, oyObject_s object)
	Copy or Reference a List object. More...
OYAPI int OYEXPORT	oyList_Release (oyList_s **list)
	release and possibly deallocate a oyList_s object More...
OYAPI int OYEXPORT	oyList_MoveIn (oyList_s *list, oyLis_s **obj, int pos)
	add an element to a List list More...
OYAPI int OYEXPORT	oyList_ReleaseAt (oyList_s *list, int pos)
	release a element from a List list More...
OYAPI oyLis_s *OYEXPORT	oyList_Get (oyList_s *list, int pos)
	get a element of a List list More...
OYAPI int OYEXPORT	oyList_Count (oyList_s *list)
	count the elements in a List list More...
OYAPI int OYEXPORT	oyList_Clear (oyList_s *list)
	clear the elements in a List list More...
OYAPI int OYEXPORT	oyList_Sort (oyList_s *list, int32_t *rank_list)
	sort a list according to a rank_list More...
void	oyList_Release__Members (oyList_s_ *list OY_UNUSED)
	Custom List destructor. More...
int	oyList_Init__Members (oyList_s_ *list OY_UNUSED)
	Custom List constructor. More...
int	oyList_Copy__Members (oyList_s_ *dst OY_UNUSED, oyList_s_ *src OY_UNUSED)
	Custom List 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...
int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...
const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	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

a pointer list

Member Function Documentation

oyList_Clear()

OYAPI int OYEXPORT oyList_Clear

(

oyList_s *

list

)

clear the elements in a List list

Function oyList_Clear

Parameters

[in,out]

list

the list

Returns

0 - success; otherwise - error

Version

Oyranos: 0.3.0

Since

2011/02/01 (Oyranos: 0.3.0)

Date

2011/02/01

oyList_Copy()

OYAPI oyList_s *OYEXPORT oyList_Copy	(	oyList_s *	list,
		oyObject_s	object
	)

Copy or Reference a List object.

Function oyList_Copy

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

Parameters

[in]	list	List struct object
	object	NULL - means reference, the optional object triggers a real copy

oyList_Copy__Members()

int oyList_Copy__Members	(	oyList_s_ *dst	OY_UNUSED,
		oyList_s_ *src	OY_UNUSED
	)

Custom List copy constructor.

Function oyList_Copy__Members

oyList_Count()

OYAPI int OYEXPORT oyList_Count

(

oyList_s *

list

)

count the elements in a List list

Function oyList_Count

Parameters

[in,out]

list

the list

Returns

element count

Version

Oyranos: 0.1.10

Since

2010/07/05 (Oyranos: 0.1.10)

Date

2010/07/05

oyList_Get()

OYAPI oyLis_s *OYEXPORT oyList_Get	(	oyList_s *	list,
		int	pos
	)

get a element of a List list

Function oyList_Get

Parameters

[in,out]	list	the list
	pos	position

Version

Oyranos: 0.1.10

Since

2010/07/05 (Oyranos: 0.1.10)

Date

2010/07/05

oyList_Init__Members()

int oyList_Init__Members

(

oyList_s_ *list

OY_UNUSED

)

Custom List constructor.

Function oyList_Init__Members

oyList_MoveIn()

OYAPI int OYEXPORT oyList_MoveIn	(	oyList_s *	list,
		oyLis_s **	obj,
		int	pos
	)

add an element to a List list

Function oyList_MoveIn

Parameters

[in]	list	list
[in,out]	obj	list element
	pos	position

Version

Oyranos: 0.1.10

Since

2010/07/05 (Oyranos: 0.1.10)

Date

2010/07/05

oyList_New()

OYAPI oyList_s *OYEXPORT oyList_New

(

oyObject_s

object

)

allocate a new List object

Function oyList_New

oyList_Release()

OYAPI int OYEXPORT oyList_Release

(

oyList_s **

list

)

release and possibly deallocate a oyList_s object

Function oyList_Release

Parameters

[in,out]

list

List struct object

oyList_Release__Members()

void oyList_Release__Members

(

oyList_s_ *list

OY_UNUSED

)

Custom List destructor.

Function oyList_Release__Members

oyList_ReleaseAt()

OYAPI int OYEXPORT oyList_ReleaseAt	(	oyList_s *	list,
		int	pos
	)

release a element from a List list

Function oyList_ReleaseAt

Parameters

[in,out]	list	the list
	pos	position

Version

Oyranos: 0.1.10

Since

2010/07/05 (Oyranos: 0.1.10)

Date

2010/07/05

oyList_Sort()

OYAPI int OYEXPORT oyList_Sort	(	oyList_s *	list,
		int32_t *	rank_list
	)

sort a list according to a rank_list

Function oyList_Sort

Version

Oyranos: 0.3.0

Since

2011/02/01 (Oyranos: 0.3.0)

Date

2011/02/01

Field Documentation

copy

oyStruct_Copy_f oyList_s::copy

Copy function.

oy_

oyObject_s oyList_s::oy_

Oyranos internal object.

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

release

oyStruct_Release_f oyList_s::release

Release function.

type_

const oyOBJECT_e oyList_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.