API documentation
AtomicSequence Class Reference
Atomic sequence prototype. More...
#include <AtomicSequence.h>
Inheritance diagram for AtomicSequence:
Collaboration diagram for AtomicSequence:Public Member Functions | |
| AtomicSequence () | |
| Default constructor. | |
| AtomicSequence (const AtomicSequence &) | |
| Copy constructor. | |
| virtual | ~AtomicSequence () |
| Default destructor. | |
| AtomicSequence * | Clone () const |
| See Module::clone. | |
| virtual bool | Prepare (PrepareMode mode) |
| Prepare the sequence. | |
| Pulse * | GetPulse (int number) |
| Get the pulse given by number. | |
| int | GetNumberOfPulses () |
| Get the number of nested pulses. | |
| virtual void | GetValue (double *dAllVal, double const time) |
| See Module::GetValue. | |
| void | Rotation (double *Grot) |
| See Module::GetValue. | |
| bool | HasNonLinGrad () |
| Check for nonlinear gradients in this atom. | |
| void | SetNonLinGrad (bool val) |
| Marh this atom, if nonlinear gradients are present. | |
| double | GetDuration () |
| See Module::GetDuration. | |
| void | CollectTPOIs () |
| Collect the TPOIs of child pulses. | |
Protected Member Functions | |
| virtual string | GetInfo () |
Detailed Description
Atomic sequence prototype.
Definition at line 35 of file AtomicSequence.h.
Member Function Documentation
| void AtomicSequence::CollectTPOIs | ( | ) |
Collect the TPOIs of child pulses.
The method calls Pulse::SetTPOIs of all pulses in the atom, and adds, sorts, and purges all these TPOIs. The method is automatically triggered by Module::notify if a pulse inside the atom changes a private member through observation.
Definition at line 141 of file AtomicSequence.cpp.
References Module::GetChildren(), Pulse::GetInitialDelay(), Module::GetNumOfTPOIs(), TPOI::GetPhase(), TPOI::GetTime(), Module::GetTPOIs(), Module::m_tpoi, TPOI::Purge(), TPOI::Reset(), Pulse::SetTPOIs(), and TPOI::Sort().
Referenced by Prepare(), and Model::RunSequenceTree().
Here is the call graph for this function:
Here is the caller graph for this function:| string AtomicSequence::GetInfo | ( | ) | [protected, virtual] |
Get informations on this AtomicSequence
- Returns:
- Information for display
Reimplemented from Module.
Reimplemented in DelayAtomicSequence.
Definition at line 167 of file AtomicSequence.cpp.
| int AtomicSequence::GetNumberOfPulses | ( | ) | [inline] |
Get the number of nested pulses.
- Returns:
- The number of nested pulses of this atomic sequence
Definition at line 79 of file AtomicSequence.h.
| Pulse* AtomicSequence::GetPulse | ( | int | number | ) | [inline] |
Get the pulse given by number.
- Parameters:
-
number Position in pulse vetor
- Returns:
- Requested pulse
Definition at line 72 of file AtomicSequence.h.
| bool AtomicSequence::HasNonLinGrad | ( | ) | [inline] |
Check for nonlinear gradients in this atom.
- Returns:
- True, if nonlinear gradients are present
Definition at line 103 of file AtomicSequence.h.
Referenced by GetValue().
Here is the caller graph for this function:| bool AtomicSequence::Prepare | ( | PrepareMode | mode | ) | [virtual] |
Prepare the sequence.
- Parameters:
-
mode Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
Reimplemented from Sequence.
Reimplemented in DelayAtomicSequence.
Definition at line 39 of file AtomicSequence.cpp.
References CollectTPOIs(), and Prototype::m_type.
Referenced by SequenceTree::Populate().
Here is the call graph for this function:
Here is the caller graph for this function:| void AtomicSequence::Rotation | ( | double * | Grot | ) |
See Module::GetValue.
Perform a Rotation of the gradients.
- Parameters:
-
Grot Rotation matrix.
Definition at line 119 of file AtomicSequence.cpp.
Referenced by GetValue().
Here is the caller graph for this function:| void AtomicSequence::SetNonLinGrad | ( | bool | val | ) | [inline] |
Marh this atom, if nonlinear gradients are present.
- Parameters:
-
val True, if nonlinear gradients are present
Definition at line 110 of file AtomicSequence.h.
The documentation for this class was generated from the following files:








