#include <seqgradchan.h>
Public Member Functions | |
| SeqGradChan (const STD_string &object_label, direction gradchannel, float gradstrength, double gradduration) | |
| SeqGradChan (const STD_string &object_label="unnamedSeqGradChan") | |
| SeqGradChan (const SeqGradChan &sgc) | |
| virtual | ~SeqGradChan () |
| SeqGradChan & | operator= (const SeqGradChan &sgc) |
| virtual direction | get_channel () const |
| virtual int | get_wavesize () const |
| virtual void | resize (unsigned int newsize) |
| STD_string | get_properties () const |
| unsigned int | event (eventContext &context) const |
Protected Member Functions | |
| float | get_grdfactor (direction chan) const |
| fvector | get_grdfactors_norot () const |
Friends | |
| class | SeqGradChanList |
| class | SeqGradChanParallel |
Detailed Description
This is the base class for all objects that represent a single gradient object
Definition at line 84 of file seqgradchan.h.
Constructor & Destructor Documentation
| SeqGradChan::SeqGradChan | ( | const STD_string & | object_label, | |
| direction | gradchannel, | |||
| float | gradstrength, | |||
| double | gradduration | |||
| ) |
Constructs a gradient channel object labeled 'object_label' with the following properties:
- gradchannel: The channel this object should be played out
- gradstrength: The gradient strength for this object
- gradduration: The duration of this gradient object
| SeqGradChan::SeqGradChan | ( | const STD_string & | object_label = "unnamedSeqGradChan" |
) |
Construct an empty gradient channel object with the given label
| SeqGradChan::SeqGradChan | ( | const SeqGradChan & | sgc | ) |
Constructs a copy of 'sgc'
| virtual SeqGradChan::~SeqGradChan | ( | ) | [inline, virtual] |
Destructor
Definition at line 109 of file seqgradchan.h.
Member Function Documentation
| unsigned int SeqGradChan::event | ( | eventContext & | context | ) | const [virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented from SeqTreeObj.
| virtual direction SeqGradChan::get_channel | ( | ) | const [virtual] |
Returns the occupied channel
| float SeqGradChan::get_grdfactor | ( | direction | chan | ) | const [protected] |
returns element [channel][chan] val. from the current rot. Matrix
| fvector SeqGradChan::get_grdfactors_norot | ( | ) | const [protected] |
returns element [channel][chan] val. from the current rot. Matrix without considering the rotation matrix of the current event block (for IDEA)
| STD_string SeqGradChan::get_properties | ( | ) | const [virtual] |
Returns a string describing the object
Reimplemented from SeqTreeObj.
| virtual int SeqGradChan::get_wavesize | ( | ) | const [inline, virtual] |
Overload this function to return the size of the used waveform, if any
Definition at line 125 of file seqgradchan.h.
| SeqGradChan& SeqGradChan::operator= | ( | const SeqGradChan & | sgc | ) |
Assignment operator that makes this gradient channel object become a copy of 'sgc'
| virtual void SeqGradChan::resize | ( | unsigned int | newsize | ) | [inline, virtual] |
Overload this function to resize the current waveform, if any
Definition at line 130 of file seqgradchan.h.
The documentation for this class was generated from the following file:
