Xyce  6.1
N_ANP_StepEvent.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // Copyright Notice
3 //
4 // Copyright 2002 Sandia Corporation. Under the terms
5 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
6 // Government retains certain rights in this software.
7 //
8 // Xyce(TM) Parallel Electrical Simulator
9 // Copyright (C) 2002-2015 Sandia Corporation
10 //
11 // This program is free software: you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation, either version 3 of the License, or
14 // (at your option) any later version.
15 //
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 //-----------------------------------------------------------------------------
24 
25 //-----------------------------------------------------------------------------
26 // Filename : $RCSfile: N_ANP_StepEvent.h,v $
27 //
28 // Purpose : Step analysis class
29 //
30 // Special Notes : Specify any "hidden" or subtle details of the class here.
31 // Portability details, error handling information, etc.
32 //
33 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
34 //
35 // Creation Date : 01/24/08
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.2.2.1 $
41 //
42 // Revision Date : $Date: 2015/04/02 18:20:06 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-----------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_ANP_StepEvent_h
48 #define Xyce_N_ANP_StepEvent_h
49 
50 namespace Xyce {
51 namespace Analysis {
52 
53 struct StepEvent
54 {
55 public:
57 
58  StepEvent(State state, int count = 0)
59  : state_(state),
60  count_(count),
61  finalSimTime_(0.0)
62  {}
63 
64  const State state_;
65  const int count_;
66  // used to report the final simtulation time if the
67  // child analysis of a step was transient.
68  double finalSimTime_;
69 };
70 
71 } // namespace Analysis
72 } // namespace Xyce
73 
74 #endif // Xyce_N_ANP_StepEvent_h
Pure virtual class to augment a linear system.
StepEvent(State state, int count=0)