API documentation
AnalyticGradPulse Class Reference
Gradient with analytic shape. More...
#include <AnalyticGradPulse.h>
Inheritance diagram for AnalyticGradPulse:
Collaboration diagram for AnalyticGradPulse:
Public Member Functions | |
| AnalyticGradPulse () | |
| Default constructor. | |
| AnalyticGradPulse (const AnalyticGradPulse &) | |
| Default copy constructor. | |
| ~AnalyticGradPulse () | |
| Default destructor. | |
| AnalyticGradPulse * | Clone () const |
| virtual bool | Prepare (PrepareMode mode) |
| virtual double | GetGradient (double const time) |
| virtual void | SetTPOIs () |
Protected Member Functions | |
| virtual string | GetInfo () |
| Get informations on this analytic gradient. | |
Protected Attributes | |
| AnalyticPulseShape | m_pulse_shape |
Detailed Description
Gradient with analytic shape.
Definition at line 33 of file AnalyticGradPulse.h.
Member Function Documentation
| AnalyticGradPulse* AnalyticGradPulse::Clone | ( | ) | const [inline, virtual] |
See Module::clone
Implements Module.
Definition at line 56 of file AnalyticGradPulse.h.
References AnalyticGradPulse().
Here is the call graph for this function:
| virtual double AnalyticGradPulse::GetGradient | ( | double const | time | ) | [inline, virtual] |
Reimplemented from GradPulse.
Definition at line 66 of file AnalyticGradPulse.h.
References m_pulse_shape.
| string AnalyticGradPulse::GetInfo | ( | ) | [protected, virtual] |
Get informations on this analytic gradient.
- Returns:
- GradPulse::GetInfo plus info of the Shape
Reimplemented from GradPulse.
Definition at line 61 of file AnalyticGradPulse.cpp.
References Prototype::GetDOMattribute(), and Prototype::HasDOMattribute().
Here is the call graph for this function:
| bool AnalyticGradPulse::Prepare | ( | PrepareMode | mode | ) | [virtual] |
See Module::Prepare
Reimplemented from GradPulse.
Definition at line 34 of file AnalyticGradPulse.cpp.
References GradPulse::GetAreaNumeric(), Prototype::GetDOMattribute(), Prototype::GetName(), Prototype::HasDOMattribute(), Prototype::HideAttribute(), GradPulse::m_area, and m_pulse_shape.
Here is the call graph for this function:
| virtual void AnalyticGradPulse::SetTPOIs | ( | ) | [inline, virtual] |
- See also:
- Pulse::SetTPOIs
Reimplemented from Pulse.
Definition at line 71 of file AnalyticGradPulse.h.
References m_pulse_shape.
Member Data Documentation
AnalyticPulseShape AnalyticGradPulse::m_pulse_shape [protected] |
computes the pulse shape
Definition at line 83 of file AnalyticGradPulse.h.
Referenced by AnalyticGradPulse(), GetGradient(), Prepare(), and SetTPOIs().
The documentation for this class was generated from the following files:
