NuSMV Developers Manual: NuSMV/code/nusmv/core/enc/utils/OrdGroups.h Source File

00001 /* ---------------------------------------------------------------------------
00002 
00003 
00004   This file is part of the ``enc.utils'' package of NuSMV version 2. 
00005   Copyright (C) 2005 by FBK-irst. 
00006 
00007   NuSMV version 2 is free software; you can redistribute it and/or 
00008   modify it under the terms of the GNU Lesser General Public 
00009   License as published by the Free Software Foundation; either 
00010   version 2 of the License, or (at your option) any later version.
00011 
00012   NuSMV version 2 is distributed in the hope that it will be useful, 
00013   but WITHOUT ANY WARRANTY; without even the implied warranty of 
00014   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
00015   Lesser General Public License for more details.
00016 
00017   You should have received a copy of the GNU Lesser General Public 
00018   License along with this library; if not, write to the Free Software 
00019   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.
00020 
00021   For more information on NuSMV see <http://nusmv.fbk.eu>
00022   or email to <nusmv-users@fbk.eu>.
00023   Please report bugs to <nusmv-users@fbk.eu>.
00024 
00025   To contact the NuSMV development board, email to <nusmv@fbk.eu>. 
00026 
00027 -----------------------------------------------------------------------------*/
00028 
00039 #ifndef __NUSMV_CORE_ENC_UTILS_ORD_GROUPS_H__
00040 #define __NUSMV_CORE_ENC_UTILS_ORD_GROUPS_H__
00041 
00042 #include "nusmv/core/utils/utils.h"
00043 #include "nusmv/core/utils/NodeList.h"
00044 #include "nusmv/core/node/node.h"
00045 
00054 typedef struct OrdGroups_TAG*  OrdGroups_ptr;
00055 
00061 #define ORD_GROUPS(x)  \
00062         ((OrdGroups_ptr) (x))
00063 
00069 #define ORD_GROUPS_CHECK_INSTANCE(x)  \
00070         (nusmv_assert(ORD_GROUPS(x) != ORD_GROUPS(NULL)))
00071 
00078 OrdGroups_ptr OrdGroups_create(void);
00079 
00086 OrdGroups_ptr OrdGroups_copy(const OrdGroups_ptr self);
00087 
00094 void OrdGroups_destroy(OrdGroups_ptr self);
00095 
00103 int OrdGroups_create_group(OrdGroups_ptr self);
00104 
00114 void 
00115 OrdGroups_add_variable(OrdGroups_ptr self, node_ptr name, 
00116                        int group);
00117 
00127 void
00128 OrdGroups_add_variables(OrdGroups_ptr self, NodeList_ptr vars, 
00129                         int group);
00130 
00137 NodeList_ptr 
00138 OrdGroups_get_vars_in_group(const OrdGroups_ptr self, int group);
00139 
00148 int
00149 OrdGroups_get_var_group(const OrdGroups_ptr self, node_ptr name);
00150 
00157 int OrdGroups_get_size(const OrdGroups_ptr self);
00158 
00159 #endif /* __NUSMV_CORE_ENC_UTILS_ORD_GROUPS_H__ */