Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ProtocolS1.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File ProtocolS1.cpp
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: S1 impulse protocol.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #include <tinyxml.h>
38 
39 namespace Nektar
40 {
41  std::string ProtocolS1::className
43  "ProtocolS1",
45  "S1 stimulus protocol.");
46 
47  /**
48  * @class ProtocolS1
49  *
50  * The Stimuli class and derived classes implement a range of stimuli.
51  * The stimulus contains input stimuli that can be applied throughout the
52  * domain, on specified regions determined by the derived classes of
53  * Stimulus, at specified frequencies determined by the derived classes of
54  * Protocol.
55  */
56 
57  /**
58  * Protocol base class constructor.
59  */
62  const TiXmlElement* pXml)
63  : Protocol(pSession, pXml)
64  {
65  m_session = pSession;
66 
67  if (!pXml)
68  {
69  return;
70  }
71 
72  // Declare temporary XML element pointer
73  const TiXmlElement *pXmlparameter;
74 
75  // Read each variable, extract text and convert to floating-point
76  pXmlparameter = pXml->FirstChildElement("START");
77  m_start = atof(pXmlparameter->GetText());
78 
79  pXmlparameter = pXml->FirstChildElement("DURATION");
80  m_dur = atof(pXmlparameter->GetText());
81 
82  pXmlparameter = pXml->FirstChildElement("S1CYCLELENGTH");
83  m_s1cyclelength = atof(pXmlparameter->GetText());
84 
85  pXmlparameter = pXml->FirstChildElement("NUM_S1");
86  m_num_s1 = atof(pXmlparameter->GetText());
87  }
88 
89 
90  /**
91  * Initialise the protocol. Allocate workspace and variable storage.
92  */
94  {
95 
96  }
97 
98 
99  /**
100  *
101  */
103  {
104  time1 = time - floor((time-m_start)/m_s1cyclelength)*m_s1cyclelength
105  - m_start;
106 
107  if( (time1 > 0) &&
108  (m_s1cyclelength * (m_num_s1) + m_start) &&
109  (time1 < m_dur) )
110  {
111  return 1.0;
112  }
113 
114  return 0.0;
115  }
116 
117 
118  /**
119  *
120  */
122  {
123 
124  }
125 
126 
127  /**
128  *
129  */
131  {
132 
133  }
134 
135 }