API documentation
TriangleGradPulse Class Reference
Gradient with constant amplitude. More...
#include <TriangleGradPulse.h>
Inheritance diagram for TriangleGradPulse:
Collaboration diagram for TriangleGradPulse:Public Member Functions | |
| TriangleGradPulse () | |
| Default constructor. | |
| TriangleGradPulse (const TriangleGradPulse &) | |
| Default copy constructor. | |
| ~TriangleGradPulse () | |
| Default destructor. | |
| TriangleGradPulse * | Clone () const |
| virtual bool | Prepare (PrepareMode mode) |
| virtual double | GetGradient (double const time) |
Protected Member Functions | |
| virtual string | GetInfo () |
| Get informations on this triangle gradient. | |
Protected Attributes | |
| double | m_amplitude |
| TriangleType | m_triangle_type |
Detailed Description
Gradient with constant amplitude.
Definition at line 37 of file TriangleGradPulse.h.
Member Function Documentation
| TriangleGradPulse* TriangleGradPulse::Clone | ( | ) | const [inline, virtual] |
See Module::clone
Implements Module.
Definition at line 60 of file TriangleGradPulse.h.
References TriangleGradPulse().
Here is the call graph for this function:| double TriangleGradPulse::GetGradient | ( | double const | time | ) | [inline, virtual] |
Reimplemented from GradPulse.
Definition at line 84 of file TriangleGradPulse.cpp.
References Pulse::GetDuration(), m_amplitude, and m_triangle_type.
Here is the call graph for this function:| string TriangleGradPulse::GetInfo | ( | ) | [protected, virtual] |
Get informations on this triangle gradient.
- Returns:
- GradPulse::GetInfo plus info of the Shape
Reimplemented from GradPulse.
Definition at line 99 of file TriangleGradPulse.cpp.
References m_amplitude, and m_triangle_type.
| bool TriangleGradPulse::Prepare | ( | PrepareMode | mode | ) | [virtual] |
See Module::Prepare
Reimplemented from GradPulse.
Definition at line 38 of file TriangleGradPulse.cpp.
References Module::AddDOMattribute(), Prototype::GetDOMattribute(), Pulse::GetDuration(), Prototype::GetName(), Prototype::HasDOMattribute(), Prototype::HideAttribute(), m_amplitude, Module::m_duration, GradPulse::m_slew_rate, m_triangle_type, and GradPulse::SetArea().
Here is the call graph for this function:Member Data Documentation
double TriangleGradPulse::m_amplitude [protected] |
My amplitude
Definition at line 81 of file TriangleGradPulse.h.
Referenced by GetGradient(), GetInfo(), Prepare(), and TriangleGradPulse().
TriangleType TriangleGradPulse::m_triangle_type [protected] |
My type (TRIANGLE_UP or TRIANGLE_DN)
Definition at line 82 of file TriangleGradPulse.h.
Referenced by GetGradient(), GetInfo(), Prepare(), and TriangleGradPulse().
The documentation for this class was generated from the following files:





