Fixture Pool

Collaboration diagram for Fixture Pool:

Modules
	Fixture

Data Structures
struct	DMX512_fixture_pool_s
	DMX512 fixture pool structure object. More...

Functions
DMX512_fixture_pool_s *	DMX512_fixture_pool_new (void)
	Creates a new fixture pool instance. More...
DMX512_engine_err_e	DMX512_fixture_pool_add (DMX512_fixture_pool_s *this, DMX512_fixture_s fixture)
	Adds a fixture instance into the pool. More...
DMX512_engine_err_e	DMX512_fixture_pool_del (DMX512_fixture_pool_s *this, uint16_t id)
	Deletes a fixture instance from the pool. More...
DMX512_engine_err_e	DMX512_fixture_pool_get (DMX512_fixture_pool_s *this, uint16_t id, DMX512_fixture_s **fixture)
	Gets a fixture instance from the pool. More...
void	DMX512_fixture_pool_free (DMX512_fixture_pool_s *fixture_pool)
	Frees instance pool. More...

Detailed Description

Fixture pools are used to store a universe's patch information. A patch is a pool of addressed fixtures which channel channel values must me comprised in within a 0-512 address value interval. A patched fixture's channels may not overlap over the channel addresses of another fixture member of the patch.

Function Documentation

DMX512_fixture_pool_add()

DMX512_engine_err_e DMX512_fixture_pool_add	(	DMX512_fixture_pool_s *	fixture_pool,
		DMX512_fixture_s	fixture
	)

Adds a fixture instance into the pool.

Parameters

*fixture_pool	pointer to the fixture pool
fixture	fixture instance to be added into the pool

Returns

DMX512_engine_err_e error code following the function call

Definition at line 89 of file DMX512_fixture_pool.c.

DMX512_fixture_pool_del()

DMX512_engine_err_e DMX512_fixture_pool_del	(	DMX512_fixture_pool_s *	fixture_pool,
		uint16_t	id
	)

Deletes a fixture instance from the pool.

Parameters

*fixture_pool	pointer to the fixture pool
id	fixture idendifier of the fixture to be removed from the pool

Returns

DMX512_engine_err_e error code following the function call

Definition at line 110 of file DMX512_fixture_pool.c.

DMX512_fixture_pool_free()

void DMX512_fixture_pool_free

(

DMX512_fixture_pool_s *

fixture_pool

)

Frees instance pool.

Returns

DMX512_fixture_pool_s the created pool instance

Definition at line 156 of file DMX512_fixture_pool.c.

DMX512_fixture_pool_get()

DMX512_engine_err_e DMX512_fixture_pool_get	(	DMX512_fixture_pool_s *	fixture_pool,
		uint16_t	id,
		DMX512_fixture_s **	fixture
	)

Gets a fixture instance from the pool.

Parameters

*fixture_pool	pointer to the fixture pool
id	id of the fixture to be searched
**fixture	pointer to the fixture instance to be returned

Returns

DMX512_engine_err_e ERR_OK if fixture was found, DMX512_ENGINE_INSTANCE_UNDEFINED otherwise

Definition at line 136 of file DMX512_fixture_pool.c.

DMX512_fixture_pool_new()

DMX512_fixture_pool_s * DMX512_fixture_pool_new

(

void

)

Creates a new fixture pool instance.

Returns

DMX512_fixture_pool_s the created pool instance

Definition at line 75 of file DMX512_fixture_pool.c.