A FilterNode list. More...

#include <oyFilterNodes_s.h>

Inheritance diagram for oyFilterNodes_s:

Collaboration diagram for oyFilterNodes_s:

Public Member Functions
OYAPI oyFilterNodes_s *OYEXPORT	oyFilterNodes_New (oyObject_s object)
	allocate a new FilterNodes object More...

OYAPI oyFilterNodes_s *OYEXPORT	oyFilterNodes_Copy (oyFilterNodes_s *filternodes, oyObject_s object)
	Copy or Reference a FilterNodes object. More...

OYAPI int OYEXPORT	oyFilterNodes_Release (oyFilterNodes_s **filternodes)
	release and possibly deallocate a oyFilterNodes_s object More...

OYAPI int OYEXPORT	oyFilterNodes_MoveIn (oyFilterNodes_s list, oyFilterNode_s *obj, int pos)
	add an element to a FilterNodes list More...

OYAPI int OYEXPORT	oyFilterNodes_ReleaseAt (oyFilterNodes_s *list, int pos)
	release a element from a FilterNodes list More...

OYAPI oyFilterNode_s *OYEXPORT	oyFilterNodes_Get (oyFilterNodes_s *list, int pos)
	get a element of a FilterNodes list More...

OYAPI int OYEXPORT	oyFilterNodes_Count (oyFilterNodes_s *list)
	count the elements in a FilterNodes list More...

OYAPI int OYEXPORT	oyFilterNodes_Clear (oyFilterNodes_s *list)
	clear the elements in a FilterNodes list More...

OYAPI int OYEXPORT	oyFilterNodes_Sort (oyFilterNodes_s list, int32_t rank_list)
	sort a list according to a rank_list More...

void	oyFilterNodes_Release__Members (oyFilterNodes_s_ *filternodes)
	Custom FilterNodes destructor. More...

int	oyFilterNodes_Init__Members (oyFilterNodes_s_ *filternodes OY_UNUSED)
	Custom FilterNodes constructor. More...

int	oyFilterNodes_Copy__Members (oyFilterNodes_s_ dst, oyFilterNodes_s_ src)
	Custom FilterNodes 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 FilterNode list.

Member Function Documentation

◆ oyFilterNodes_Clear()

OYAPI int OYEXPORT oyFilterNodes_Clear ( oyFilterNodes_s * list )

clear the elements in a FilterNodes list

Function oyFilterNodes_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

◆ oyFilterNodes_Copy()

OYAPI oyFilterNodes_s *OYEXPORT oyFilterNodes_Copy	(	oyFilterNodes_s *	filternodes,
		oyObject_s	object
	)

Copy or Reference a FilterNodes object.

Function oyFilterNodes_Copy

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

Parameters

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

◆ oyFilterNodes_Copy__Members()

int oyFilterNodes_Copy__Members	(	oyFilterNodes_s_ *	dst,
		oyFilterNodes_s_ *	src
	)

Custom FilterNodes copy constructor.

Function oyFilterNodes_Copy__Members

◆ oyFilterNodes_Count()

OYAPI int OYEXPORT oyFilterNodes_Count ( oyFilterNodes_s * list )

count the elements in a FilterNodes list

Function oyFilterNodes_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

◆ oyFilterNodes_Get()

OYAPI oyFilterNode_s *OYEXPORT oyFilterNodes_Get	(	oyFilterNodes_s *	list,
		int	pos
	)

get a element of a FilterNodes list

Function oyFilterNodes_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

◆ oyFilterNodes_Init__Members()

int oyFilterNodes_Init__Members ( oyFilterNodes_s_ *filternodes OY_UNUSED )

Custom FilterNodes constructor.

Function oyFilterNodes_Init__Members

◆ oyFilterNodes_MoveIn()

OYAPI int OYEXPORT oyFilterNodes_MoveIn	(	oyFilterNodes_s *	list,
		oyFilterNode_s **	obj,
		int	pos
	)

add an element to a FilterNodes list

Function oyFilterNodes_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

◆ oyFilterNodes_New()

OYAPI oyFilterNodes_s *OYEXPORT oyFilterNodes_New ( oyObject_s object )

allocate a new FilterNodes object

Function oyFilterNodes_New

◆ oyFilterNodes_Release()

OYAPI int OYEXPORT oyFilterNodes_Release ( oyFilterNodes_s ** filternodes )

release and possibly deallocate a oyFilterNodes_s object

Function oyFilterNodes_Release

Parameters

[in,out] filternodes FilterNodes struct object

◆ oyFilterNodes_Release__Members()

void oyFilterNodes_Release__Members ( oyFilterNodes_s_ * filternodes )

Custom FilterNodes destructor.

Function oyFilterNodes_Release__Members

◆ oyFilterNodes_ReleaseAt()

OYAPI int OYEXPORT oyFilterNodes_ReleaseAt	(	oyFilterNodes_s *	list,
		int	pos
	)

release a element from a FilterNodes list

Function oyFilterNodes_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

◆ oyFilterNodes_Sort()

OYAPI int OYEXPORT oyFilterNodes_Sort	(	oyFilterNodes_s *	list,
		int32_t *	rank_list
	)

sort a list according to a rank_list

Function oyFilterNodes_Sort

Version: Oyranos: 0.3.0

Since: 2011/02/01 (Oyranos: 0.3.0)

Date: 2011/02/01

Field Documentation

◆ copy

oyStruct_Copy_f oyFilterNodes_s::copy

Copy function.

◆ oy_

oyObject_s oyFilterNodes_s::oy_

Oyranos internal object.

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

◆ release

oyStruct_Release_f oyFilterNodes_s::release

Release function.

◆ type_

const oyOBJECT_e oyFilterNodes_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ oyFilterNodes_Clear()

◆ oyFilterNodes_Copy()

◆ oyFilterNodes_Copy__Members()

◆ oyFilterNodes_Count()

◆ oyFilterNodes_Get()

◆ oyFilterNodes_Init__Members()

◆ oyFilterNodes_MoveIn()

◆ oyFilterNodes_New()

◆ oyFilterNodes_Release()

◆ oyFilterNodes_Release__Members()

◆ oyFilterNodes_ReleaseAt()

◆ oyFilterNodes_Sort()

Field Documentation

◆ copy

◆ oy_

◆ release

◆ type_