source/classes/inc/mh5tokengroup.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5TOKENGROUP_H_
#define _MH5TOKENGROUP_H_

/*---includes for this file--------------------------------------------------*/
#include "mh5tokenmanager.h"
#include "mh5presentable.h"
#include "mh5action.h"

/*---Constant and macro definitions for public use---------------------------*/

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/

typedef struct sMHEG5TokenSlot
{
   MHEG5Int id;                /* to referenced visible */
   MH5GroupRef groupid;        /* to referenced visible */
   MHEG5Int actions_num;
   MHEG5ActionList *actions_ptr;
} MHEG5TokenSlot;


typedef struct
{
   /* Base classes */
   MHEG5Ingredient ingredient;
   MHEG5TokenManager tokenManager;

   /* Exchanged attributes */
   MHEG5Int tokens_num;
   MHEG5TokenSlot *tokens_ptr;      /* zeroth token is the noTokenActionSlot */

   /* No internal attributes for this class */
} MHEG5TokenGroup;

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

void MHEG5tokenGroupFree(MHEG5TokenGroup *tokenGroup);

void MHEG5tokenGroupPrepare(MHEG5TokenGroup *tokenGroup);
void MHEG5tokenGroupActivate(MHEG5TokenGroup *tokenGroup);
void MHEG5tokenGroupDeactivate(MHEG5TokenGroup *tokenGroup);
void MHEG5tokenGroupDestruct(MHEG5TokenGroup *tokenGroup);

MHEG5ErrorCode MHEG5callActionSlot(MHEG5Root *target, MHEG5GList *params);

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5tokenGroupPrint(MHEG5TokenGroup *tokenGroup, char *out);
#endif

#endif /*_MH5TOKENGROUP_H_*/