mh5group.h File Reference

Implementation of the Group class Description Defines the structure and behaviour of objects used as composition of Ingredients. Base class Root Subclasses Scene, Application Status Abstract class. More...

#include "mh5action.h"
#include "mh5ingredient.h"

Go to the source code of this file.

Classes
struct	sMHEG5Group

Macros
#define	GRP_HASH_TABLE_SIZE   251

Typedefs
typedef struct sMHEG5Group	MHEG5Group

Functions
void	MHEG5groupAddItem (MHEG5Group *group, MHEG5Ingredient *item)
	Add an Item to the List. More...
void	MHEG5groupDelItem (MHEG5Group *group, MHEG5Ingredient *item)
	Delete Item from the List. More...
void	MHEG5groupInit (MHEG5Group *group)
	Initialise an Group object with default Values. More...
void	MHEG5groupFree (MHEG5Group *group)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed. More...
void	MHEG5groupPrepare (MHEG5Group *group)
	Implementation of the Preparation behaviour Preparation. More...
void	MHEG5groupDestruct (MHEG5Group *group)
	Implementation of the Destruction behaviour Destruction. More...
void	MHEG5groupActivate (MHEG5Group *group)
	Implementation of the Activation behaviour Activation. More...
void	MHEG5groupDeactivate (MHEG5Group *group)
	Implementation of the Deactivation behaviour Deactivation If group is not active, ignore behaviour. If group is active, do the following three steps: More...
MHEG5ErrorCode	MHEG5setCachePriority (MHEG5Root *target, MHEG5GList *params)
	Implementation of the SetCachePriority action SetCachePriority (NewCachePriority) Set the GroupCachePriority attribute to NewCachePriority. Provisions of use: The Target object shall be available. NewCachePriority shall be set within the range [0, 255]. SetCachePriority –> Target, NewCachePriority Target –> GenericObjectReference NewCachePriority –> GenericInteger. More...
MHEG5ErrorCode	MHEG5setTimer (MHEG5Root *target, MHEG5GList *params)
	This actions sets a new Timer which results in a TimerFired event when the given time is reached. Implementation of the SetTimer (TimerId, TimerValue, AbsoluteTime) action of the group class SetTimer (TimerId, TimerValue, AbsoluteTime) Update the list of timers of the group. Execute the following sequence of actions: More...
void	MH5_GroupInit (void)
	This function initialises Group Timers. More...

Detailed Description

Implementation of the Group class Description Defines the structure and behaviour of objects used as composition of Ingredients. Base class Root Subclasses Scene, Application Status Abstract class.

Date

17/12/2001

Author

iwillis

Definition in file mh5group.h.

Macro Definition Documentation

#define GRP_HASH_TABLE_SIZE   251

Definition at line 40 of file mh5group.h.

Typedef Documentation

typedef struct sMHEG5Group MHEG5Group

Function Documentation

void MH5_GroupInit

(

void

)

This function initialises Group Timers.

Returns

None

Definition at line 93 of file mh5group.c.

void MHEG5groupActivate

(

MHEG5Group *

group

)

Implementation of the Activation behaviour Activation.

1. Apply the Activation behaviour as inherited from the base class.
2. Run the action contained in the OnStartUp attribute.
3. Apply the Activation behaviour to all Ingredients of the Group that have the InitiallyActive attribute set to True, in the order they are listed in the Items attribute.
4. Set the RunningStatus attribute of the Group object to True.
5. Generate an IsRunning event.

   Parameters

   group

   Group to activate

   Returns

   void

MHEG5PROFILE_UK1_06

Definition at line 672 of file mh5group.c.

void MHEG5groupAddItem	(	MHEG5Group *	group,
		MHEG5Ingredient *	item
	)

Add an Item to the List.

Parameters

group	Group to add item to
item	Item to add

Returns

void

Definition at line 205 of file mh5group.c.

void MHEG5groupDeactivate

(

MHEG5Group *

group

)

Implementation of the Deactivation behaviour Deactivation If group is not active, ignore behaviour. If group is active, do the following three steps:

1. Run the action contained in the OnCloseDown attribute.
2. Apply the Deactivation behaviour to all active Ingredients of the Group, in the reverse order they are listed in the Items attribute.
3. Apply the Deactivation behaviour as inherited from the base class.

   Parameters

   group

   Group to deactivate

   Returns

   void

MHEG5PROFILE_UK1_06

Definition at line 802 of file mh5group.c.

void MHEG5groupDelItem	(	MHEG5Group *	group,
		MHEG5Ingredient *	item
	)

Delete Item from the List.

Parameters

group	Group to delete item from
item	Item to delete

Returns

void

Definition at line 235 of file mh5group.c.

void MHEG5groupDestruct

(

MHEG5Group *

group

)

Implementation of the Destruction behaviour Destruction.

1. Apply the Destruction behaviour to all Ingredients of the Group in the reverse order that they are listed in the Items attribute.
2. Apply the Destruction behaviour as inherited from the base class.

   Parameters

   group

   Group to destruct

   Returns

   void

MHEG5PROFILE_UK1_06

Definition at line 497 of file mh5group.c.

void MHEG5groupFree

(

MHEG5Group *

group

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters

group

Pointer to object to free.

Returns

Void

Definition at line 315 of file mh5group.c.

void MHEG5groupInit

(

MHEG5Group *

group

)

Initialise an Group object with default Values.

Parameters

group

Pointer to a group object to initialise

Returns

void

Definition at line 285 of file mh5group.c.

void MHEG5groupPrepare

(

MHEG5Group *

group

)

Implementation of the Preparation behaviour Preparation.

1. Apply the Preparation behaviour to all Ingredients of the Group that have the InitiallyActive attribute set to True and to all Programs of the Group that have the InitiallyAvailable attribute set to True in the order that they are listed in the Items attribute.
2. Apply the Preparation behaviour as inherited from the base class.

   Parameters

   group

   Group to apply behaviour to

   Returns

   void

MHEG5PROFILE_UK1_06

Definition at line 349 of file mh5group.c.

MHEG5ErrorCode MHEG5setCachePriority	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the SetCachePriority action SetCachePriority (NewCachePriority) Set the GroupCachePriority attribute to NewCachePriority. Provisions of use: The Target object shall be available. NewCachePriority shall be set within the range [0, 255]. SetCachePriority –> Target, NewCachePriority Target –> GenericObjectReference NewCachePriority –> GenericInteger.

Parameters

target	target object for this action
params	Action parameters

Returns

MHEG5ErrorCode - See mh5base.h

Definition at line 937 of file mh5group.c.

MHEG5ErrorCode MHEG5setTimer	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

This actions sets a new Timer which results in a TimerFired event when the given time is reached. Implementation of the SetTimer (TimerId, TimerValue, AbsoluteTime) action of the group class SetTimer (TimerId, TimerValue, AbsoluteTime) Update the list of timers of the group. Execute the following sequence of actions:

1. Update the Timers internal attribute of the group, according to the following rules: a) If TimerId is the identifier of an existing Timer in the Group, the new TimerValue, replaces the previous one. The parameter AbsoluteTime is ignored, in other words an absolute Timer cannot be replaced by a Timer relative to the Group. b) If there is no Timer with identifier TimerId in the Group, insert a new Timer with identifier TimerId and values TimerValue and AbsoluteTime in the Group. If AbsoluteTime is not encoded, it is set to False by default. c) If TimerValue is not encoded and there is a Timer with identifier TimerId in the Group, remove this Timer from the Timers list. d) If TimerValue is not encoded and there is no Timer with identifier TimerId in the Timers list, discard this action.
2. The active Group shall receive TimerFired events according to the new value of the Timers list. If AbsoluteTime is set to True, the TimerValue parameter of this action shall be interpreted as a time offset from the time when the Group is active. Otherwise, the TimerValue parameter of this action shall be interpreted as a time offset from the time when the action is invoked. In both cases, it is measured in milliseconds. If the TimerValue parameter is zero and AbsoluteTime is False, the Timer shall be fired immediately. Removing or changing a Timer does not suppress pending events from the former Timer. COR.1: If the time indicated in TimerValue has already passed and the AbsoluteTime is set to True, the TimerFired event shall not be raised. SetTimer –> Target, TimerId, TimerValue?, AbsoluteTime? Target –> GenericObjectReference TimerId –> GenericInteger TimerValue –> GenericInteger AbsoluteTime –> GenericBoolean

   Parameters

   target	target object for this action
   params	Function parameter

   Returns

   MHEG5ErrorCode

1. Update the Timers internal attribute of the group, according to the following rules: a) If TimerId is the identifier of an existing Timer in the Group, the new TimerValue, replaces the previous one. The parameter AbsoluteTime is ignored, in other words an absolute Timer cannot be replaced by a Timer relative to the Group. b) If there is no Timer with identifier TimerId in the Group, insert a new Timer with identifier TimerId and values TimerValue and AbsoluteTime in the Group. If AbsoluteTime is not encoded, it is set to False by default. c) If TimerValue is not encoded and there is a Timer with identifier TimerId in the Group, remove this Timer from the Timers list. d) If TimerValue is not encoded and there is no Timer with identifier TimerId in the Timers list, discard this action.
2. The active Group shall receive TimerFired events according to the new value of the Timers list. If AbsoluteTime is set to True, the TimerValue parameter of this action shall be interpreted as a time offset from the time when the Group is active. Otherwise, the TimerValue parameter of this action shall be interpreted as a time offset from the time when the action is invoked. In both cases, it is measured in milliseconds. If the TimerValue parameter is zero and AbsoluteTime is False, the Timer shall be fired immediately. Removing or changing a Timer does not suppress pending events from the former Timer. COR.1: If the time indicated in TimerValue has already passed and the AbsoluteTime is set to True, the TimerFired event shall not be raised.

   Parameters

   target	target object for this action
   params	Function parameter

   Returns

   MHEG5ErrorCode

Definition at line 1070 of file mh5group.c.