NuSMV Developers Manual: NuSMV/code/nusmv/core/simulate/SimulateState.h Source File

00001 /* ---------------------------------------------------------------------------
00002 
00003 
00004   This file is part of the ``simulate'' package of NuSMV version 2.
00005   Copyright (C) 2012 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_SIMULATE_SIMULATE_STATE_H__
00040 #define __NUSMV_CORE_SIMULATE_SIMULATE_STATE_H__
00041 
00042 
00043 #include "nusmv/core/utils/object.h"
00044 #include "nusmv/core/dd/DDMgr.h"
00045 #include "nusmv/core/dd/dd.h"
00046 #include "nusmv/core/trace/TraceLabel.h"
00047 
00054 typedef struct SimulateState_TAG*  SimulateState_ptr;
00055 
00062 #define SIMULATE_STATE(self) \
00063          ((SimulateState_ptr) self)
00064 
00070 #define SIMULATE_STATE_CHECK_INSTANCE(self) \
00071          (nusmv_assert(SIMULATE_STATE(self) != SIMULATE_STATE(NULL)))
00072 
00073 
00074 
00077 /*---------------------------------------------------------------------------*/
00078 /* Function prototypes                                                       */
00079 /*---------------------------------------------------------------------------*/
00080 
00081 /* Constructors ***************************************************************/
00082 
00091 SimulateState_ptr
00092 SimulateState_create(DDMgr_ptr const dd_mgr,
00093                      bdd_ptr const bdd,
00094                      TraceLabel const trace_label);
00095 
00096 /* Destructors ****************************************************************/
00097 
00106 void SimulateState_destroy(SimulateState_ptr self);
00107 
00108 /* Getters ********************************************************************/
00109 
00115 bdd_ptr SimulateState_get_bdd(SimulateState_ptr const self);
00116 
00122 TraceLabel
00123 SimulateState_get_trace_label(SimulateState_ptr const self);
00124 
00125 /* Setters ********************************************************************/
00126 
00132 void SimulateState_set_all(SimulateState_ptr const self,
00133                                   bdd_ptr const state,
00134                                   TraceLabel const label);
00135 
00136 /* Others *********************************************************************/
00137 
00145 SimulateState_ptr
00146 SimulateState_set_in_env(NuSMVEnv_ptr const env,
00147                          bdd_ptr const bdd,
00148                          TraceLabel const trace_label);
00149 
00154 #endif /* __NUSMV_CORE_SIMULATE_SIMULATE_STATE_H__ */