applications/jpip/libopenjpip/cachemodel_manager.h

   1 /*
   2  * $Id$
   3  *
   4  * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2011, Professor Benoit Macq
   6  * Copyright (c) 2010-2011, Kaori Hagihara
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef         CACHEMODEL_MANAGER_H_
  32 # define        CACHEMODEL_MANAGER_H_
  33
  34 #include "bool.h"
  35 #include "target_manager.h"
  36
  37 //! Cache model parameters
  38 typedef struct cachemodel_param{
  39   target_param_t *target;        //!< reference pointer to the target
  40   bool mhead_model;              //!< main header model, if sent, 1, else 0
  41   bool *tp_model;                //!< dynamic array pointer of tile part model, if sent, 1, else 0
  42   struct cachemodel_param *next; //!< pointer to the next cache model
  43 } cachemodel_param_t;
  44
  45 //! Cache model list parameters
  46 typedef struct cachemodellist_param{
  47   cachemodel_param_t *first; //!< first cache model pointer of the list
  48   cachemodel_param_t *last;  //!< last  cache model pointer of the list
  49 } cachemodellist_param_t;
  50
  51
  52 /**
  53  * generate a cache model list
  54  *
  55  * @return pointer to the generated cache model list
  56  */
  57 cachemodellist_param_t * gene_cachemodellist();
  58
  59 /**
  60  * generate a session under the sesion list
  61  *
  62  * @param[in] cachemodellist cachemodel list to insert the generated cache model
  63  * @param[in] target         pointer the reference target
  64  * @return                   pointer to the generated cache model
  65  */
  66 cachemodel_param_t * gene_cachemodel( cachemodellist_param_t *cachemodellist, target_param_t *target);
  67
  68
  69 /**
  70  * print cache model
  71  *
  72  * @param[in] cachemodel cache model
  73  */
  74 void print_cachemodel( cachemodel_param_t cachemodel);
  75
  76
  77 /**
  78  * search a cache model of a target
  79  *
  80  * @param[in] target         refering target
  81  * @param[in] cachemodellist cache model list
  82  * @return                   found cache model pointer
  83  */
  84 cachemodel_param_t * search_cachemodel( target_param_t *target, cachemodellist_param_t *cachemodellist);
  85
  86
  87 /**
  88  * delete a cache model
  89  *
  90  * @param[in] cachemodel     address of the cachemodel pointer
  91  */
  92 void delete_cachemodel( cachemodel_param_t **cachemodel);
  93
  94 /**
  95  * delete cachemodel list
  96  *
  97  * @param[in,out] cachemodellist address of the cachemodel list pointer
  98  */
  99 void delete_cachemodellist( cachemodellist_param_t **cachemodellist);
 100
 101
 102 #endif      /* !CACHEMODEL_MANAGER_H_ */