SeqHalt Class Reference
[Classes for sequence design (odinseq library)]
Input trigger.
More...
#include <seqtrigg.h>
Inheritance diagram for SeqHalt:
Public Member Functions | |
| SeqHalt (const STD_string &object_label="unnamedSeqHalt") | |
| SeqHalt (const SeqHalt &sh) | |
| SeqHalt & | operator= (const SeqHalt &sh) |
| STD_string | get_program (programContext &context) const |
| double | get_duration () const |
| unsigned int | event (eventContext &context) const |
Detailed Description
Input trigger.Halt sequence until an input trigger is received (e.g. cardiac gating).
Definition at line 119 of file seqtrigg.h.
Constructor & Destructor Documentation
| SeqHalt::SeqHalt | ( | const STD_string & | object_label = "unnamedSeqHalt" |
) |
Constructs a trigger labeled 'object_label'
| SeqHalt::SeqHalt | ( | const SeqHalt & | sh | ) |
Constructs a trigger which is a copy of 'sh'
Member Function Documentation
This assignment operator will make this object become an exact copy of 'sh'.
| STD_string SeqHalt::get_program | ( | programContext & | context | ) | const [virtual] |
Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.
Reimplemented from SeqTreeObj.
| double SeqHalt::get_duration | ( | ) | const [virtual] |
Returns the duration of the sequence object.
Implements SeqTreeObj.
| unsigned int SeqHalt::event | ( | eventContext & | context | ) | const [virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented from SeqTreeObj.
The documentation for this class was generated from the following file:
